/
file_selector.py
275 lines (232 loc) · 10.4 KB
/
file_selector.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
"""
Defines a FileSelector widget which allows selecting files and
directories on the server.
"""
from __future__ import annotations
import os
from fnmatch import fnmatch
from typing import (
AnyStr, ClassVar, List, Optional, Tuple, Type,
)
import param
from ..io import PeriodicCallback
from ..layout import (
Column, Divider, ListPanel, Row,
)
from ..util import fullpath
from ..viewable import Layoutable
from .base import CompositeWidget
from .button import Button
from .input import TextInput
from .select import CrossSelector
def _scan_path(path: str, file_pattern='*') -> Tuple[List[str], List[str]]:
"""
Scans the supplied path for files and directories and optionally
filters the files with the file keyword, returning a list of sorted
paths of all directories and files.
Arguments
---------
path: str
The path to search
file_pattern: str
A glob-like pattern to filter the files
Returns
-------
A sorted list of directory paths, A sorted list of files
"""
paths = [os.path.join(path, p) for p in os.listdir(path)]
dirs = [p for p in paths if os.path.isdir(p)]
files = [p for p in paths if os.path.isfile(p) and
fnmatch(os.path.basename(p), file_pattern)]
for p in paths:
if not os.path.islink(p):
continue
path = os.path.realpath(p)
if os.path.isdir(path):
dirs.append(p)
elif os.path.isfile(path):
dirs.append(p)
else:
continue
return dirs, files
class FileSelector(CompositeWidget):
"""
The `FileSelector` widget allows browsing the filesystem on the
server and selecting one or more files in a directory.
Reference: https://panel.holoviz.org/reference/widgets/FileSelector.html
:Example:
>>> FileSelector(directory='~', file_pattern='*.png')
"""
directory = param.String(default=os.getcwd(), doc="""
The directory to explore.""")
file_pattern = param.String(default='*', doc="""
A glob-like pattern to filter the files.""")
only_files = param.Boolean(default=False, doc="""
Whether to only allow selecting files.""")
show_hidden = param.Boolean(default=False, doc="""
Whether to show hidden files and directories (starting with
a period).""")
size = param.Integer(default=10, doc="""
The number of options shown at once (note this is the only
way to control the height of this widget)""")
refresh_period = param.Integer(default=None, doc="""
If set to non-None value indicates how frequently to refresh
the directory contents in milliseconds.""")
root_directory = param.String(default=None, doc="""
If set, overrides directory parameter as the root directory
beyond which users cannot navigate.""")
value = param.List(default=[], doc="""
List of selected files.""")
_composite_type: ClassVar[Type[ListPanel]] = Column
def __init__(self, directory: AnyStr | os.PathLike | None = None, **params):
from ..pane import Markdown
if directory is not None:
params['directory'] = fullpath(directory)
if 'root_directory' in params:
root = params['root_directory']
params['root_directory'] = fullpath(root)
if params.get('width') and params.get('height') and 'sizing_mode' not in params:
params['sizing_mode'] = None
super().__init__(**params)
# Set up layout
layout = {p: getattr(self, p) for p in Layoutable.param
if p not in ('name', 'height', 'margin') and getattr(self, p) is not None}
sel_layout = dict(layout, sizing_mode='stretch_width', height=300, margin=0)
self._selector = CrossSelector(
filter_fn=lambda p, f: fnmatch(f, p), size=self.size, **sel_layout
)
self._back = Button(name='◀', width=40, height=40, margin=(5, 10, 0, 0), disabled=True, align='center')
self._forward = Button(name='▶', width=40, height=40, margin=(5, 10, 0, 0), disabled=True, align='center')
self._up = Button(name='⬆', width=40, height=40, margin=(5, 10, 0, 0), disabled=True, align='center')
self._directory = TextInput(value=self.directory, margin=(5, 10, 0, 0), width_policy='max')
self._go = Button(name='⬇', disabled=True, width=40, height=40, margin=(5, 5, 0, 0), align='center')
self._reload = Button(name='↻', width=40, height=40, margin=(5, 0, 0, 10), align='center')
self._nav_bar = Row(
self._back, self._forward, self._up, self._directory, self._go, self._reload,
**dict(layout, width=None, margin=0, width_policy='max')
)
self._composite[:] = [self._nav_bar, Divider(margin=0), self._selector]
style = 'h4 { margin-block-start: 0; margin-block-end: 0;}'
self._selector._selected.insert(0, Markdown('#### Selected files', margin=0, stylesheets=[style]))
self._selector._unselected.insert(0, Markdown('#### File Browser', margin=0, stylesheets=[style]))
self.link(self._selector, size='size')
# Set up state
self._stack = []
self._cwd = None
self._position = -1
self._update_files(True)
# Set up callback
self.link(self._directory, directory='value')
self._selector.param.watch(self._update_value, 'value')
self._go.on_click(self._update_files)
self._reload.on_click(self._update_files)
self._up.on_click(self._go_up)
self._back.on_click(self._go_back)
self._forward.on_click(self._go_forward)
self._directory.param.watch(self._dir_change, 'value')
self._selector._lists[False].param.watch(self._select, 'value')
self._selector._lists[False].param.watch(self._filter_denylist, 'options')
self._periodic = PeriodicCallback(callback=self._refresh, period=self.refresh_period or 0)
self.param.watch(self._update_periodic, 'refresh_period')
if self.refresh_period:
self._periodic.start()
def _update_periodic(self, event: param.parameterized.Event):
if event.new:
self._periodic.period = event.new
if not self._periodic.running:
self._periodic.start()
elif self._periodic.running:
self._periodic.stop()
@property
def _root_directory(self):
return self.root_directory or self.directory
def _update_value(self, event: param.parameterized.Event):
value = [v for v in event.new if not self.only_files or os.path.isfile(v)]
self._selector.value = value
self.value = value
def _dir_change(self, event: param.parameterized.Event):
path = fullpath(self._directory.value)
if not path.startswith(self._root_directory):
self._directory.value = self._root_directory
return
elif path != self._directory.value:
self._directory.value = path
self._go.disabled = path == self._cwd
def _refresh(self):
self._update_files(refresh=True)
def _update_files(
self, event: Optional[param.parameterized.Event] = None, refresh: bool = False
):
path = fullpath(self._directory.value)
refresh = refresh or (event and getattr(event, 'obj', None) is self._reload)
if refresh:
path = self._cwd
elif not os.path.isdir(path):
self._selector.options = ['Entered path is not valid']
self._selector.disabled = True
return
elif event is not None and (not self._stack or path != self._stack[-1]):
self._stack.append(path)
self._position += 1
self._cwd = path
if not refresh:
self._go.disabled = True
self._up.disabled = path == self._root_directory
if self._position == len(self._stack)-1:
self._forward.disabled = True
if 0 <= self._position and len(self._stack) > 1:
self._back.disabled = False
selected = self.value
dirs, files = _scan_path(path, self.file_pattern)
for s in selected:
check = os.path.realpath(s) if os.path.islink(s) else s
if os.path.isdir(check):
dirs.append(s)
elif os.path.isfile(check):
files.append(s)
paths = [p for p in sorted(dirs)+sorted(files)
if self.show_hidden or not os.path.basename(p).startswith('.')]
abbreviated = [('📁' if f in dirs else '')+os.path.relpath(f, self._cwd) for f in paths]
options = dict(zip(abbreviated, paths))
self._selector.options = options
self._selector.value = selected
def _filter_denylist(self, event: param.parameterized.Event):
"""
Ensure that if unselecting a currently selected path and it
is not in the current working directory then it is removed
from the denylist.
"""
dirs, files = _scan_path(self._cwd, self.file_pattern)
paths = [('📁' if p in dirs else '')+os.path.relpath(p, self._cwd) for p in dirs+files]
denylist = self._selector._lists[False]
options = dict(self._selector._items)
self._selector.options.clear()
self._selector.options.update([
(k, v) for k, v in options.items() if k in paths or v in self.value
])
denylist.options = [o for o in denylist.options if o in paths]
def _select(self, event: param.parameterized.Event):
if len(event.new) != 1:
self._directory.value = self._cwd
return
relpath = event.new[0].replace('📁', '')
sel = fullpath(os.path.join(self._cwd, relpath))
if os.path.isdir(sel):
self._directory.value = sel
else:
self._directory.value = self._cwd
def _go_back(self, event: param.parameterized.Event):
self._position -= 1
self._directory.value = self._stack[self._position]
self._update_files()
self._forward.disabled = False
if self._position == 0:
self._back.disabled = True
def _go_forward(self, event: param.parameterized.Event):
self._position += 1
self._directory.value = self._stack[self._position]
self._update_files()
def _go_up(self, event: Optional[param.parameterized.Event] = None):
path = self._cwd.split(os.path.sep)
self._directory.value = os.path.sep.join(path[:-1]) or os.path.sep
self._update_files(True)