/
input.py
679 lines (489 loc) · 21.5 KB
/
input.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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
"""
The input widgets generally allow entering arbitrary information into
a text field or similar.
"""
import ast
import json
from base64 import b64decode
from datetime import datetime, date
import param
from bokeh.models.formatters import TickFormatter
from bokeh.models.widgets import (
CheckboxGroup as _BkCheckboxGroup, ColorPicker as _BkColorPicker,
DatePicker as _BkDatePicker, Div as _BkDiv, TextInput as _BkTextInput,
PasswordInput as _BkPasswordInput, Spinner as _BkSpinner,
FileInput as _BkFileInput, TextAreaInput as _BkTextAreaInput,
NumericInput as _BkNumericInput)
from ..config import config
from ..layout import Column
from ..util import param_reprs
from .base import Widget, CompositeWidget
from ..models import DatetimePicker as _bkDatetimePicker
class TextInput(Widget):
max_length = param.Integer(default=5000, doc="""
Max count of characters in the input field.""")
placeholder = param.String(default='', doc="""
Placeholder for empty input field.""")
value = param.String(default='', allow_None=True, doc="""
Initial or entered text value updated when <enter> key is pressed.""")
value_input = param.String(default='', allow_None=True, doc="""
Initial or entered text value updated on every key press.""")
_widget_type = _BkTextInput
class PasswordInput(TextInput):
_widget_type = _BkPasswordInput
class TextAreaInput(TextInput):
_widget_type = _BkTextAreaInput
class FileInput(Widget):
accept = param.String(default=None)
filename = param.ClassSelector(default=None, class_=(str, list),
is_instance=True)
mime_type = param.ClassSelector(default=None, class_=(str, list),
is_instance=True)
multiple = param.Boolean(default=False)
value = param.Parameter(default=None)
_widget_type = _BkFileInput
_source_transforms = {'value': "'data:' + source.mime_type + ';base64,' + value"}
_rename = {'name': None, 'filename': None}
def _process_param_change(self, msg):
msg = super()._process_param_change(msg)
if 'value' in msg:
msg.pop('value')
if 'mime_type' in msg:
msg.pop('mime_type')
return msg
def _filter_properties(self, properties):
properties = super()._filter_properties(properties)
return properties + ['value', 'mime_type', 'filename']
def _process_property_change(self, msg):
msg = super()._process_property_change(msg)
if 'value' in msg:
if isinstance(msg['value'], str):
msg['value'] = b64decode(msg['value'])
else:
msg['value'] = [b64decode(content) for content in msg['value']]
return msg
def save(self, filename):
"""
Saves the uploaded FileInput data to a file or BytesIO object.
Arguments
---------
filename (str): File path or file-like object
"""
if isinstance(filename, str):
with open(filename, 'wb') as f:
f.write(self.value)
else:
filename.write(self.value)
class StaticText(Widget):
style = param.Dict(default=None, doc="""
Dictionary of CSS property:value pairs to apply to this Div.""")
value = param.Parameter(default=None)
_format = '<b>{title}</b>: {value}'
_rename = {'name': None, 'value': 'text'}
_target_transforms = {'value': 'target.text.split(": ")[0]+": "+value'}
_source_transforms = {'value': 'value.split(": ")[1]'}
_widget_type = _BkDiv
def _process_param_change(self, msg):
msg = super()._process_property_change(msg)
if 'value' in msg:
text = str(msg.pop('value'))
partial = self._format.replace('{value}', '').format(title=self.name)
if self.name:
text = self._format.format(title=self.name, value=text.replace(partial, ''))
msg['text'] = text
return msg
class DatePicker(Widget):
value = param.CalendarDate(default=None)
start = param.CalendarDate(default=None)
end = param.CalendarDate(default=None)
disabled_dates = param.List(default=None, class_=(date, str))
enabled_dates = param.List(default=None, class_=(date, str))
_source_transforms = {}
_rename = {'start': 'min_date', 'end': 'max_date', 'name': 'title'}
_widget_type = _BkDatePicker
def _process_property_change(self, msg):
msg = super()._process_property_change(msg)
if 'value' in msg:
if isinstance(msg['value'], str):
msg['value'] = datetime.date(datetime.strptime(msg['value'], '%Y-%m-%d'))
return msg
class _DatetimePickerBase(Widget):
start = param.CalendarDate(default=None)
end = param.CalendarDate(default=None)
disabled_dates = param.List(default=None, class_=(date, str))
enabled_dates = param.List(default=None, class_=(date, str))
enable_time = param.Boolean(default=True)
enable_seconds = param.Boolean(default=True)
military_time = param.Boolean(default=True)
_source_transforms = {'value': None, 'start': None, 'end': None, 'mode': None}
_rename = {'start': 'min_date', 'end': 'max_date', 'name': 'title'}
_widget_type = _bkDatetimePicker
__abstract = True
def __init__(self, **params):
super().__init__(**params)
self._update_value_bounds()
@staticmethod
def _date_to_datetime(x):
if isinstance(x, date):
return datetime(x.year, x.month, x.day)
@param.depends('start', 'end', watch=True)
def _update_value_bounds(self):
self.param.value.bounds = (
self._date_to_datetime(self.start),
self._date_to_datetime(self.end),
)
self.param.value._validate(self.value)
def _process_property_change(self, msg):
msg = super()._process_property_change(msg)
if 'value' in msg:
msg['value'] = self._serialize_value(msg['value'])
return msg
def _process_param_change(self, msg):
msg = super()._process_param_change(msg)
if 'value' in msg:
msg['value'] = self._deserialize_value(msg['value'])
return msg
class DatetimePicker(_DatetimePickerBase):
value = param.Date(default=None)
mode = param.String('single', constant=True)
def _serialize_value(self, value):
if isinstance(value, str) and value:
value = datetime.strptime(value, r'%Y-%m-%d %H:%M:%S')
# Hour, minute and seconds can be increased after end is reached.
# This forces the hours, minute and second to be 0.
end = self._date_to_datetime(self.end)
if end is not None and value > end:
value = end
return value
def _deserialize_value(self, value):
if isinstance(value, (datetime, date)):
value = value.strftime(r'%Y-%m-%d %H:%M:%S')
return value
class DatetimeRangePicker(_DatetimePickerBase):
value = param.DateRange(default=None)
mode = param.String('range', constant=True)
def _serialize_value(self, value):
if isinstance(value, str) and value:
value = [
datetime.strptime(value, r'%Y-%m-%d %H:%M:%S')
for value in value.split(' to ')
]
# Hour, minute and seconds can be increased after end is reached.
# This forces the hours, minute and second to be 0.
end = self._date_to_datetime(self.end)
if end is not None and value[0] > end:
value[0] = end
if end is not None and value[1] > end:
value[1] = end
value = tuple(value)
return value
def _deserialize_value(self, value):
if isinstance(value, tuple):
value = " to ".join(v.strftime(r'%Y-%m-%d %H:%M:%S') for v in value)
if value is None:
value = ""
return value
class ColorPicker(Widget):
value = param.Color(default=None, doc="""
The selected color""")
_widget_type = _BkColorPicker
_rename = {'value': 'color', 'name': 'title'}
class _NumericInputBase(Widget):
value = param.Number(default=0, allow_None=True, doc="""
The initial value of the spinner.""")
placeholder = param.String(default='0', doc="""
Placeholder for empty input field.""")
format = param.ClassSelector(default=None, class_=(str, TickFormatter,), doc="""
Allows defining a custom format string or bokeh TickFormatter.""")
start = param.Parameter(default=None, allow_None=True, doc="""
Optional minimum allowable value.""")
end = param.Parameter(default=None, allow_None=True, doc="""
Optional maximum allowable value.""")
_rename = {'name': 'title', 'start': 'low', 'end': 'high'}
_widget_type = _BkNumericInput
__abstract = True
class _IntInputBase(_NumericInputBase):
value = param.Integer(default=0, allow_None=True, doc="""
The initial value of the spinner.""")
start = param.Integer(default=None, allow_None=True, doc="""
Optional minimum allowable value.""")
end = param.Integer(default=None, allow_None=True, doc="""
Optional maximum allowable value.""")
mode = param.String(default='int', constant=True, doc="""
Define the type of number which can be enter in the input""")
__abstract = True
class _FloatInputBase(_NumericInputBase):
value = param.Number(default=0, allow_None=True, doc="""
The initial value of the spinner.""")
start = param.Number(default=None, allow_None=True, doc="""
Optional minimum allowable value.""")
end = param.Number(default=None, allow_None=True, doc="""
Optional maximum allowable value.""")
mode = param.String(default='float', constant=True, doc="""
Define the type of number which can be enter in the input""")
__abstract = True
class _SpinnerBase(_NumericInputBase):
page_step_multiplier = param.Integer(default=10, bounds=(0, None), doc="""
Defines the multiplication factor applied to step when the page up
and page down keys are pressed.""")
wheel_wait = param.Integer(default=100, doc="""
Defines the debounce time in ms before updating `value_throttled` when
the mouse wheel is used to change the input.""")
_widget_type = _BkSpinner
__abstract = True
def __init__(self, **params):
if params.get('value') is None:
value = params.get('start', self.value)
if value is not None:
params['value'] = value
if 'value' in params and 'value_throttled' in self.param:
params['value_throttled'] = params['value']
super().__init__(**params)
def __repr__(self, depth=0):
return '{cls}({params})'.format(cls=type(self).__name__,
params=', '.join(param_reprs(self, ['value_throttled'])))
def _update_model(self, events, msg, root, model, doc, comm):
if 'value_throttled' in msg:
del msg['value_throttled']
return super()._update_model(events, msg, root, model, doc, comm)
def _process_property_change(self, msg):
if config.throttled:
if "value" in msg:
del msg["value"]
if "value_throttled" in msg:
msg["value"] = msg["value_throttled"]
return super()._process_property_change(msg)
class IntInput(_SpinnerBase, _IntInputBase):
step = param.Integer(default=1)
value_throttled = param.Integer(default=None, constant=True)
class FloatInput(_SpinnerBase, _FloatInputBase):
step = param.Number(default=0.1)
value_throttled = param.Number(default=None, constant=True)
class NumberInput(_SpinnerBase):
def __new__(self, **params):
param_list = ["value", "start", "stop", "step"]
if all(isinstance(params.get(p, 0), int) for p in param_list):
return IntInput(**params)
else:
return FloatInput(**params)
# Backward compatibility
Spinner = NumberInput
class LiteralInput(Widget):
"""
LiteralInput allows declaring Python literals using a text
input widget. Optionally a type may be declared.
"""
serializer = param.ObjectSelector(default='ast', objects=['ast', 'json'], doc="""
The serialization (and deserialization) method to use. 'ast'
uses ast.literal_eval and 'json' uses json.loads and json.dumps.
""")
type = param.ClassSelector(default=None, class_=(type, tuple),
is_instance=True)
value = param.Parameter(default=None)
_rename = {'name': 'title', 'type': None, 'serializer': None}
_source_transforms = {'value': """JSON.parse(value.replace(/'/g, '"'))"""}
_target_transforms = {'value': """JSON.stringify(value).replace(/,/g, ",").replace(/:/g, ": ")"""}
_widget_type = _BkTextInput
def __init__(self, **params):
super().__init__(**params)
self._state = ''
self._validate(None)
self._callbacks.append(self.param.watch(self._validate, 'value'))
def _validate(self, event):
if self.type is None: return
new = self.value
if not isinstance(new, self.type) and new is not None:
if event:
self.value = event.old
types = repr(self.type) if isinstance(self.type, tuple) else self.type.__name__
raise ValueError('LiteralInput expected %s type but value %s '
'is of type %s.' %
(types, new, type(new).__name__))
def _process_property_change(self, msg):
msg = super()._process_property_change(msg)
new_state = ''
if 'value' in msg:
value = msg.pop('value')
try:
if self.serializer == 'json':
value = json.loads(value)
else:
value = ast.literal_eval(value)
except Exception:
new_state = ' (invalid)'
value = self.value
else:
if self.type and not isinstance(value, self.type):
vtypes = self.type if isinstance(self.type, tuple) else (self.type,)
typed_value = None
for vtype in vtypes:
try:
typed_value = vtype(value)
except Exception:
pass
else:
break
if typed_value is None and value is not None:
new_state = ' (wrong type)'
value = self.value
else:
value = typed_value
msg['value'] = value
msg['name'] = msg.get('title', self.name).replace(self._state, '') + new_state
self._state = new_state
self.param.trigger('name')
return msg
def _process_param_change(self, msg):
msg = super()._process_param_change(msg)
if 'value' in msg:
value = msg['value']
if isinstance(value, str):
value = repr(value)
elif self.serializer == 'json':
value = json.dumps(value)
else:
value = '' if value is None else str(value)
msg['value'] = value
msg['title'] = self.name
return msg
class DatetimeInput(LiteralInput):
"""
DatetimeInput allows declaring Python literals using a text
input widget. Optionally a type may be declared.
"""
format = param.String(default='%Y-%m-%d %H:%M:%S', doc="""
Datetime format used for parsing and formatting the datetime.""")
value = param.Date(default=None)
start = param.Date(default=None)
end = param.Date(default=None)
type = datetime
_source_transforms = {'value': None, 'start': None, 'end': None}
_rename = {'format': None, 'type': None, 'name': 'title',
'start': None, 'end': None, 'serializer': None}
def __init__(self, **params):
super().__init__(**params)
self.param.watch(self._validate, 'value')
self._validate(None)
def _validate(self, event):
new = self.value
if new is not None and ((self.start is not None and self.start > new) or
(self.end is not None and self.end < new)):
value = datetime.strftime(new, self.format)
start = datetime.strftime(self.start, self.format)
end = datetime.strftime(self.end, self.format)
if event:
self.value = event.old
raise ValueError('DatetimeInput value must be between {start} and {end}, '
'supplied value is {value}'.format(start=start, end=end,
value=value))
def _process_property_change(self, msg):
msg = Widget._process_property_change(self, msg)
new_state = ''
if 'value' in msg:
value = msg.pop('value')
try:
value = datetime.strptime(value, self.format)
except Exception:
new_state = ' (invalid)'
value = self.value
else:
if value is not None and ((self.start is not None and self.start > value) or
(self.end is not None and self.end < value)):
new_state = ' (out of bounds)'
value = self.value
msg['value'] = value
msg['name'] = msg.get('title', self.name).replace(self._state, '') + new_state
self._state = new_state
return msg
def _process_param_change(self, msg):
msg = Widget._process_param_change(self, msg)
if 'value' in msg:
value = msg['value']
if value is None:
value = ''
else:
value = datetime.strftime(msg['value'], self.format)
msg['value'] = value
msg['title'] = self.name
return msg
class DatetimeRangeInput(CompositeWidget):
value = param.Tuple(default=(None, None), length=2)
start = param.Date(default=None)
end = param.Date(default=None)
format = param.String(default='%Y-%m-%d %H:%M:%S', doc="""
Datetime format used for parsing and formatting the datetime.""")
_composite_type = Column
def __init__(self, **params):
self._text = StaticText(margin=(5, 0, 0, 0), style={'white-space': 'nowrap'})
self._start = DatetimeInput(sizing_mode='stretch_width', margin=(5, 0, 0, 0))
self._end = DatetimeInput(sizing_mode='stretch_width', margin=(5, 0, 0, 0))
if 'value' not in params:
params['value'] = (params['start'], params['end'])
super().__init__(**params)
self._msg = ''
self._composite.extend([self._text, self._start, self._end])
self._updating = False
self.param.watch(self._update_widgets, [p for p in self.param if p != 'name'])
self._update_widgets()
self._update_label()
@param.depends('name', '_start.name', '_end.name', watch=True)
def _update_label(self):
self._text.value = f'{self.name}{self._start.name}{self._end.name}{self._msg}'
@param.depends('_start.value', '_end.value', watch=True)
def _update(self):
if self._updating:
return
if (self._start.value is not None and
self._end.value is not None and
self._start.value > self._end.value):
self._msg = ' (start of range must be <= end)'
self._update_label()
return
elif self._msg:
self._msg = ''
self._update_label()
try:
self._updating = True
self.value = (self._start.value, self._end.value)
finally:
self._updating = False
def _update_widgets(self, *events):
filters = [event.name for event in events] if events else list(self.param)
if 'name' in filters:
filters.remove('name')
if self._updating:
return
try:
self._updating = True
params = {k: v for k, v in self.param.values().items() if k in filters}
start_params = dict(params, value=self.value[0])
end_params = dict(params, value=self.value[1])
self._start.param.update(**start_params)
self._end.param.update(**end_params)
finally:
self._updating = False
class Checkbox(Widget):
value = param.Boolean(default=False)
_supports_embed = True
_rename = {'value': 'active', 'name': 'labels'}
_source_transforms = {'value': "value.indexOf(0) >= 0", 'name': "value[0]"}
_target_transforms = {'value': "value ? [0] : []", 'name': "[value]"}
_widget_type = _BkCheckboxGroup
def _process_property_change(self, msg):
msg = super()._process_property_change(msg)
if 'value' in msg:
msg['value'] = 0 in msg.pop('value')
if 'name' in msg:
msg['name'] = [msg['name']]
return msg
def _process_param_change(self, msg):
msg = super()._process_param_change(msg)
if 'active' in msg:
msg['active'] = [0] if msg.pop('active', None) else []
if 'labels' in msg:
msg['labels'] = [msg.pop('labels')]
return msg
def _get_embed_state(self, root, values=None, max_opts=3):
return (self, self._models[root.ref['id']][0], [False, True],
lambda x: str(0 in x.active).lower(), 'active',
"String(cb_obj.active.indexOf(0) >= 0)")