/
param.py
1089 lines (953 loc) · 44 KB
/
param.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
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""
Defines the Param pane which converts Parameterized classes into a
set of widgets.
"""
from __future__ import annotations
import asyncio
import inspect
import itertools
import json
import os
import sys
import textwrap
import types
from collections import OrderedDict, defaultdict, namedtuple
from collections.abc import Callable
from contextlib import contextmanager
from functools import partial
from typing import (
TYPE_CHECKING, Any, ClassVar, Generator, List, Mapping, Optional, Tuple,
Type,
)
import param
from param.parameterized import classlist, discard_events, iscoroutinefunction
from .config import config
from .io import state
from .layout import (
Column, Panel, Row, Spacer, Tabs,
)
from .pane.base import PaneBase, ReplacementPane
from .reactive import Reactive
from .util import (
abbreviated_repr, eval_function, full_groupby, fullpath, get_method_owner,
is_parameterized, param_name, recursive_parameterized,
)
from .viewable import Layoutable, Viewable
from .widgets import (
ArrayInput, Button, Checkbox, ColorPicker, DataFrame, DatePicker,
DateRangeSlider, DatetimeInput, DatetimeRangeSlider, DiscreteSlider,
FileSelector, FloatInput, FloatSlider, IntInput, IntSlider, LiteralInput,
MultiSelect, RangeSlider, Select, StaticText, Tabulator, TextInput, Toggle,
Widget,
)
from .widgets.button import _ButtonBase
if TYPE_CHECKING:
from bokeh.document import Document
from bokeh.model import Model
from pyviz_comms import Comm
def SingleFileSelector(pobj: param.Parameter) -> Type[Widget]:
"""
Determines whether to use a TextInput or Select widget for FileSelector
"""
if pobj.path:
return Select
else:
return TextInput
def LiteralInputTyped(pobj: param.Parameter) -> Type[Widget]:
if isinstance(pobj, param.Tuple):
return type(str('TupleInput'), (LiteralInput,), {'type': tuple})
elif isinstance(pobj, param.Number):
return type(str('NumberInput'), (LiteralInput,), {'type': (int, float)})
elif isinstance(pobj, param.Dict):
return type(str('DictInput'), (LiteralInput,), {'type': dict})
elif isinstance(pobj, param.List):
return type(str('ListInput'), (LiteralInput,), {'type': list})
return LiteralInput
def DataFrameWidget(pobj: param.DataFrame) -> Type[Widget]:
if 'panel.models.tabulator' in sys.modules:
return Tabulator
else:
return DataFrame
@contextmanager
def set_values(*parameterizeds, **param_values):
"""
Temporarily sets parameter values to the specified values on all
supplied Parameterized objects.
Arguments
---------
parameterizeds: tuple(param.Parameterized)
Any number of parameterized objects.
param_values: dict
A dictionary of parameter names and temporary values.
"""
old = []
for parameterized in parameterizeds:
old_values = {p: getattr(parameterized, p) for p in param_values}
old.append((parameterized, old_values))
parameterized.param.update(**param_values)
try:
yield
finally:
for parameterized, old_values in old:
parameterized.param.update(**old_values)
class Param(PaneBase):
"""
Param panes render a Parameterized class to a set of widgets which
are linked to the parameter values on the class.
"""
display_threshold = param.Number(default=0, precedence=-10, doc="""
Parameters with precedence below this value are not displayed.""")
default_layout = param.ClassSelector(default=Column, class_=Panel,
is_instance=False)
default_precedence = param.Number(default=1e-8, precedence=-10, doc="""
Precedence value to use for parameters with no declared
precedence. By default, zero predecence is available for
forcing some parameters to the top of the list, and other
values above the default_precedence values can be used to sort
or group parameters arbitrarily.""")
expand = param.Boolean(default=False, doc="""
Whether parameterized subobjects are expanded or collapsed on
instantiation.""")
expand_button = param.Boolean(default=None, doc="""
Whether to add buttons to expand and collapse sub-objects.""")
expand_layout = param.Parameter(default=Column, doc="""
Layout to expand sub-objects into.""")
height = param.Integer(default=None, bounds=(0, None), doc="""
Height of widgetbox the parameter widgets are displayed in.""")
hide_constant = param.Boolean(default=False, doc="""
Whether to hide widgets of constant parameters.""")
initializer = param.Callable(default=None, doc="""
User-supplied function that will be called on initialization,
usually to update the default Parameter values of the
underlying parameterized object.""")
name = param.String(default='', doc="""
Title of the pane.""")
parameters = param.List(default=[], allow_None=True, doc="""
If set this serves as a whitelist of parameters to display on
the supplied Parameterized object.""")
show_labels = param.Boolean(default=True, doc="""
Whether to show labels for each widget""")
show_name = param.Boolean(default=True, doc="""
Whether to show the parameterized object's name""")
sort = param.ClassSelector(default=False, class_=(bool, Callable), doc="""
If True the widgets will be sorted alphabetically by label.
If a callable is provided it will be used to sort the Parameters,
for example lambda x: x[1].label[::-1] will sort by the reversed
label.""")
width = param.Integer(default=None, allow_None=True, bounds=(0, None), doc="""
Width of widgetbox the parameter widgets are displayed in.""")
widgets = param.Dict(doc="""
Dictionary of widget overrides, mapping from parameter name
to widget class.""")
mapping: ClassVar[Mapping[param.Parameter, Widget | Callable[[param.Parameter], Widget]]] = {
param.Action: Button,
param.Array: ArrayInput,
param.Boolean: Checkbox,
param.CalendarDate: DatePicker,
param.Color: ColorPicker,
param.Date: DatetimeInput,
param.DateRange: DatetimeRangeSlider,
param.CalendarDateRange: DateRangeSlider,
param.DataFrame: DataFrameWidget,
param.Dict: LiteralInputTyped,
param.FileSelector: SingleFileSelector,
param.Filename: TextInput,
param.Foldername: TextInput,
param.Integer: IntSlider,
param.List: LiteralInputTyped,
param.MultiFileSelector: FileSelector,
param.ListSelector: MultiSelect,
param.Number: FloatSlider,
param.ObjectSelector: Select,
param.Parameter: LiteralInputTyped,
param.Range: RangeSlider,
param.Selector: Select,
param.String: TextInput,
}
if hasattr(param, 'Event'):
mapping[param.Event] = Button
_ignored_refs: ClassVar[Tuple[str]] = ('object',)
_linkable_properties: ClassVar[Tuple[str]] = ()
_rerender_params: ClassVar[List[str]] = []
_unpack: ClassVar[bool] = True
def __init__(self, object=None, **params):
if isinstance(object, param.Parameter):
if 'show_name' not in params:
params['show_name'] = False
params['parameters'] = [object.name]
object = object.owner
if isinstance(object, param.parameterized.Parameters):
object = object.cls if object.self is None else object.self
if 'parameters' not in params and object is not None:
params['parameters'] = [p for p in object.param if p != 'name']
self._explicit_parameters = False
else:
self._explicit_parameters = object is not None
if object and 'name' not in params:
params['name'] = param_name(object.name)
super().__init__(object, **params)
self._updating = []
# Construct Layout
kwargs = {p: v for p, v in self.param.values().items()
if p in Layoutable.param and v is not None}
self._widget_box = self.default_layout(**kwargs)
layout = self.expand_layout
if isinstance(layout, Panel):
self._expand_layout = layout
self.layout = self._widget_box
elif isinstance(self._widget_box, layout):
self.layout = self._expand_layout = self._widget_box
elif isinstance(layout, type) and issubclass(layout, Panel):
self.layout = self._expand_layout = layout(self._widget_box, **kwargs)
else:
raise ValueError('expand_layout expected to be a panel.layout.Panel'
'type or instance, found %s type.' %
type(layout).__name__)
self.param.watch(self._update_widgets, [
'object', 'parameters', 'name', 'display_threshold', 'expand_button',
'expand', 'expand_layout', 'widgets', 'show_labels', 'show_name',
'hide_constant'])
self._update_widgets()
def __repr__(self, depth=0):
cls = type(self).__name__
obj_cls = type(self.object).__name__
params = [] if self.object is None else list(self.object.param)
parameters = [k for k in params if k != 'name']
params = []
for p, v in sorted(self.param.values().items()):
if v == self.param[p].default: continue
elif v is None: continue
elif isinstance(v, str) and v == '': continue
elif p == 'object' or (p == 'name' and (v.startswith(obj_cls) or v.startswith(cls))): continue
elif p == 'parameters' and v == parameters: continue
try:
params.append('%s=%s' % (p, abbreviated_repr(v)))
except RuntimeError:
params.append('%s=%s' % (p, '...'))
obj = 'None' if self.object is None else '%s' % type(self.object).__name__
template = '{cls}({obj}, {params})' if params else '{cls}({obj})'
return template.format(cls=cls, params=', '.join(params), obj=obj)
#----------------------------------------------------------------
# Callback API
#----------------------------------------------------------------
@property
def _synced_params(self):
ignored_params = ['default_layout', 'loading', 'background']
return [p for p in Layoutable.param if p not in ignored_params]
def _update_widgets(self, *events):
parameters = []
for event in sorted(events, key=lambda x: x.name):
if event.name == 'object':
if isinstance(event.new, param.parameterized.Parameters):
# Setting object will trigger this method a second time
self.object = event.new.cls if event.new.self is None else event.new.self
return
if self._explicit_parameters:
parameters = self.parameters
elif event.new is None:
parameters = []
else:
parameters = [p for p in event.new.param if p != 'name']
if event.new is not None:
self.name = param_name(event.new.name)
if event.name == 'parameters':
if event.new is None:
self._explicit_parameters = False
if self.object is not None:
parameters = [p for p in self.object.param if p != 'name']
else:
self._explicit_parameters = True
parameters = [] if event.new == [] else event.new
if parameters != [] and parameters != self.parameters:
# Setting parameters will trigger this method a second time
self.parameters = parameters
return
for cb in list(self._internal_callbacks):
if cb.inst in self._widget_box.objects:
cb.inst.param.unwatch(cb)
self._internal_callbacks.remove(cb)
# Construct widgets
if self.object is None:
self._widgets = {}
else:
self._widgets = self._get_widgets()
alias = {'_title': 'name'}
widgets = [widget for p, widget in self._widgets.items()
if (self.object.param[alias.get(p, p)].precedence is None)
or (self.object.param[alias.get(p, p)].precedence >= self.display_threshold)]
self._widget_box.objects = widgets
if not (self.expand_button == False and not self.expand):
self._link_subobjects()
def _link_subobjects(self):
for pname, widget in self._widgets.items():
widgets = [widget] if isinstance(widget, Widget) else widget
if not any(is_parameterized(getattr(w, 'value', None)) or
any(is_parameterized(o) for o in getattr(w, 'options', []))
for w in widgets):
continue
if (isinstance(widgets, Row) and isinstance(widgets[1], Toggle)):
selector, toggle = (widgets[0], widgets[1])
else:
selector, toggle = (widget, None)
def toggle_pane(change, parameter=pname):
"Adds or removes subpanel from layout"
parameterized = getattr(self.object, parameter)
existing = [p for p in self._expand_layout.objects
if isinstance(p, Param) and
p.object in recursive_parameterized(parameterized)]
if not change.new:
self._expand_layout[:] = [
e for e in self._expand_layout.objects
if e not in existing
]
elif change.new:
kwargs = {k: v for k, v in self.param.values().items()
if k not in ['name', 'object', 'parameters']}
pane = Param(parameterized, name=parameterized.name,
**kwargs)
if isinstance(self._expand_layout, Tabs):
title = self.object.param[pname].label
pane = (title, pane)
self._expand_layout.append(pane)
def update_pane(change, parameter=pname):
"Adds or removes subpanel from layout"
layout = self._expand_layout
existing = [p for p in layout.objects if isinstance(p, Param)
and p.object is change.old]
if toggle:
toggle.disabled = not is_parameterized(change.new)
if not existing:
return
elif is_parameterized(change.new):
parameterized = change.new
kwargs = {k: v for k, v in self.param.values().items()
if k not in ['name', 'object', 'parameters']}
pane = Param(parameterized, name=parameterized.name,
**kwargs)
layout[layout.objects.index(existing[0])] = pane
else:
layout.remove(existing[0])
watchers = [selector.param.watch(update_pane, 'value')]
if toggle:
watchers.append(toggle.param.watch(toggle_pane, 'value'))
self._internal_callbacks += watchers
if self.expand:
if self.expand_button:
toggle.value = True
else:
toggle_pane(namedtuple('Change', 'new')(True))
def widget(self, p_name):
"""Get widget for param_name"""
p_obj = self.object.param[p_name]
kw_widget = {}
widget_class_overridden = True
if self.widgets is None or p_name not in self.widgets:
widget_class_overridden = False
widget_class = self.widget_type(p_obj)
elif isinstance(self.widgets[p_name], dict):
kw_widget = dict(self.widgets[p_name])
if 'widget_type' in self.widgets[p_name]:
widget_class = kw_widget.pop('widget_type')
elif 'type' in self.widgets[p_name]:
widget_class = kw_widget.pop('type')
else:
widget_class_overridden = False
widget_class = self.widget_type(p_obj)
else:
widget_class = self.widgets[p_name]
if not self.show_labels and not issubclass(widget_class, _ButtonBase):
label = ''
else:
label = p_obj.label
kw = dict(disabled=p_obj.constant, name=label)
if self.hide_constant:
kw['visible'] = not p_obj.constant
value = getattr(self.object, p_name)
allow_None = p_obj.allow_None or False
if isinstance(widget_class, type) and issubclass(widget_class, Widget):
allow_None &= widget_class.param.value.allow_None
if value is not None or allow_None:
kw['value'] = value
if hasattr(p_obj, 'get_range'):
options = p_obj.get_range()
# This applies to widgets whose `options` Parameter is a List type,
# such as AutoCompleteInput.
if ('options' in widget_class.param
and isinstance(widget_class.param['options'], param.List)):
options = list(options.values())
if not options and value is not None:
options = [value]
kw['options'] = options
if hasattr(p_obj, 'get_soft_bounds'):
bounds = p_obj.get_soft_bounds()
if bounds[0] is not None:
kw['start'] = bounds[0]
if bounds[1] is not None:
kw['end'] = bounds[1]
if (('start' not in kw or 'end' not in kw) and
not isinstance(p_obj, (param.Date, param.CalendarDate))):
# Do not change widget class if mapping was overridden
if not widget_class_overridden:
if isinstance(p_obj, param.Number):
widget_class = FloatInput
if isinstance(p_obj, param.Integer):
widget_class = IntInput
elif not issubclass(widget_class, LiteralInput):
widget_class = LiteralInput
if hasattr(widget_class, 'step') and getattr(p_obj, 'step', None):
kw['step'] = p_obj.step
if hasattr(widget_class, 'fixed_start') and getattr(p_obj, 'bounds', None):
kw['fixed_start'] = p_obj.bounds[0]
if hasattr(widget_class, 'fixed_end') and getattr(p_obj, 'bounds', None):
kw['fixed_end'] = p_obj.bounds[1]
if p_obj.doc:
kw['description'] = textwrap.dedent(p_obj.doc).strip()
# Update kwargs
onkeyup = kw_widget.pop('onkeyup', False)
throttled = kw_widget.pop('throttled', False)
ignored_kws = [repr(k) for k in kw_widget if k not in widget_class.param]
if ignored_kws:
self.param.warning(
f'Param pane was given unknown keyword argument(s) for {p_name!r} '
f'parameter with a widget of type {widget_class!r}. The following '
f'keyword arguments could not be applied: {", ".join(ignored_kws)}.'
)
kw.update(kw_widget)
kwargs = {k: v for k, v in kw.items() if k in widget_class.param}
if isinstance(widget_class, type) and issubclass(widget_class, Button):
kwargs.pop('value', None)
if isinstance(widget_class, Widget):
widget = widget_class
else:
widget = widget_class(**kwargs)
widget._param_pane = self
widget._param_name = p_name
watchers = self._internal_callbacks
def link_widget(change):
if p_name in self._updating:
return
try:
self._updating.append(p_name)
self.object.param.update(**{p_name: change.new})
finally:
self._updating.remove(p_name)
if hasattr(param, 'Event') and isinstance(p_obj, param.Event):
def event(change):
self.object.param.trigger(p_name)
watcher = widget.param.watch(event, 'clicks')
elif isinstance(p_obj, param.Action):
def action(change):
value(self.object)
watcher = widget.param.watch(action, 'clicks')
elif onkeyup and hasattr(widget, 'value_input'):
watcher = widget.param.watch(link_widget, 'value_input')
elif throttled and hasattr(widget, 'value_throttled'):
watcher = widget.param.watch(link_widget, 'value_throttled')
else:
watcher = widget.param.watch(link_widget, 'value')
watchers.append(watcher)
def link(change, watchers=[watcher]):
updates = {}
if p_name not in self._widgets:
return
widget = self._widgets[p_name]
if change.what == 'constant':
updates['disabled'] = change.new
if self.hide_constant:
updates['visible'] = not change.new
elif change.what == 'precedence':
if change.new is change.old:
return
elif change.new is None:
self._rerender()
elif (change.new < self.display_threshold and
widget in self._widget_box.objects):
self._widget_box.remove(widget)
elif change.new >= self.display_threshold:
self._rerender()
return
elif change.what == 'objects':
options = p_obj.get_range()
if ('options' in widget.param and
isinstance(widget.param['options'], param.List)):
options = list(options)
updates['options'] = options
elif change.what == 'bounds':
start, end = p_obj.get_soft_bounds()
supports_bounds = hasattr(widget, 'start')
if start is None or end is None:
rerender = supports_bounds
else:
rerender = not supports_bounds
if supports_bounds:
updates['start'] = start
updates['end'] = end
if rerender:
self._rerender_widget(p_name)
return
elif change.what == 'step':
updates['step'] = p_obj.step
elif change.what == 'label':
updates['name'] = p_obj.label
elif p_name in self._updating:
return
elif hasattr(param, 'Event') and isinstance(p_obj, param.Event):
return
elif isinstance(p_obj, param.Action):
prev_watcher = watchers[0]
widget.param.unwatch(prev_watcher)
def action(event):
change.new(self.object)
watchers[0] = widget.param.watch(action, 'clicks')
idx = self._internal_callbacks.index(prev_watcher)
self._internal_callbacks[idx] = watchers[0]
return
elif throttled and hasattr(widget, 'value_throttled'):
updates['value_throttled'] = change.new
updates['value'] = change.new
elif isinstance(widget, Row) and len(widget) == 2:
updates['value'] = change.new
widget = widget[0]
else:
updates['value'] = change.new
try:
self._updating.append(p_name)
if change.type == 'triggered':
with discard_events(widget):
widget.param.update(**updates)
widget.param.trigger(*updates)
else:
widget.param.update(**updates)
finally:
self._updating.remove(p_name)
# Set up links to parameterized object
watchers.append(self.object.param.watch(link, p_name, 'constant'))
watchers.append(self.object.param.watch(link, p_name, 'precedence'))
watchers.append(self.object.param.watch(link, p_name, 'label'))
if hasattr(p_obj, 'get_range'):
watchers.append(self.object.param.watch(link, p_name, 'objects'))
if hasattr(p_obj, 'get_soft_bounds'):
watchers.append(self.object.param.watch(link, p_name, 'bounds'))
if 'step' in kw:
watchers.append(self.object.param.watch(link, p_name, 'step'))
watchers.append(self.object.param.watch(link, p_name))
options = kwargs.get('options', [])
if isinstance(options, dict):
options = options.values()
if ((is_parameterized(value) or any(is_parameterized(o) for o in options))
and (self.expand_button or (self.expand_button is None and not self.expand))):
toggle = Toggle(
name='\u22EE', button_type='primary',
disabled=not is_parameterized(value), max_height=30,
max_width=20, height_policy='fit', align='end',
margin=(0, 0, 5, 10)
)
width = widget.width
widget.param.update(
margin=(5, 0, 5, 10),
sizing_mode='stretch_width',
width=None
)
return Row(widget, toggle, width=width, margin=0)
else:
return widget
@property
def _ordered_params(self):
params = [(p, pobj) for p, pobj in self.object.param.objects('existing').items()
if p in self.parameters or p == 'name']
if self.sort:
if callable(self.sort):
key_fn = self.sort
else:
key_fn = lambda x: x[1].label
sorted_params = sorted(params, key=key_fn)
sorted_params = [el[0] for el in sorted_params if (el[0] != 'name' or el[0] in self.parameters)]
return sorted_params
key_fn = lambda x: x[1].precedence if x[1].precedence is not None else self.default_precedence
sorted_precedence = sorted(params, key=key_fn)
filtered = [(k, p) for k, p in sorted_precedence]
groups = itertools.groupby(filtered, key=key_fn)
# Params preserve definition order in Python 3.6+
ordered_groups = [list(grp) for (_, grp) in groups]
ordered_params = [el[0] for group in ordered_groups for el in group
if (el[0] != 'name' or el[0] in self.parameters)]
return ordered_params
#----------------------------------------------------------------
# Model API
#----------------------------------------------------------------
def _rerender(self):
precedence = lambda k: self.object.param['name' if k == '_title' else k].precedence
params = self._ordered_params
if self.show_name:
params.insert(0, '_title')
widgets = []
for k in params:
if precedence(k) is None or precedence(k) >= self.display_threshold:
widgets.append(self._widgets[k])
self._widget_box.objects = widgets
def _rerender_widget(self, p_name):
watchers = []
for w in self._internal_callbacks:
if w.inst is self._widgets[p_name]:
w.inst.param.unwatch(w)
else:
watchers.append(w)
self._widgets[p_name] = self.widget(p_name)
self._rerender()
def _get_widgets(self):
"""Return name,widget boxes for all parameters (i.e., a property sheet)"""
# Format name specially
if self.expand_layout is Tabs:
widgets = []
elif self.show_name:
widgets = [('_title', StaticText(value='<b>{0}</b>'.format(self.name)))]
else:
widgets = []
widgets += [(pname, self.widget(pname)) for pname in self._ordered_params]
return OrderedDict(widgets)
def _get_model(
self, doc: Document, root: Optional[Model] = None,
parent: Optional[Model] = None, comm: Optional[Comm] = None
) -> Model:
model = self.layout._get_model(doc, root, parent, comm)
self._models[root.ref['id']] = (model, parent)
return model
def _cleanup(self, root: Model | None = None) -> None:
self.layout._cleanup(root)
super()._cleanup(root)
#----------------------------------------------------------------
# Public API
#----------------------------------------------------------------
@classmethod
def applies(cls, obj: Any) -> float | bool | None:
if isinstance(obj, param.parameterized.Parameters):
return 0.8
elif (is_parameterized(obj) or (isinstance(obj, param.Parameter) and obj.owner is not None)):
return 0.1
return False
@classmethod
def widget_type(cls, pobj):
ptype = type(pobj)
for t in classlist(ptype)[::-1]:
if t not in cls.mapping:
continue
wtype = cls.mapping[t]
if isinstance(wtype, types.FunctionType):
return wtype(pobj)
return wtype
def get_root(
self, doc: Optional[Document] = None, comm: Comm | None = None,
preprocess: bool = True
) -> Model:
root = super().get_root(doc, comm, preprocess)
ref = root.ref['id']
self._models[ref] = (root, None)
return root
def select(self, selector=None):
"""
Iterates over the Viewable and any potential children in the
applying the Selector.
Arguments
---------
selector: type or callable or None
The selector allows selecting a subset of Viewables by
declaring a type or callable function to filter by.
Returns
-------
viewables: list(Viewable)
"""
return super().select(selector) + self.layout.select(selector)
class ParamMethod(ReplacementPane):
"""
ParamMethod panes wrap methods on parameterized classes and
rerenders the plot when any of the method's parameters change. By
default ParamMethod will watch all parameters on the class owning
the method or can be restricted to certain parameters by annotating
the method using the param.depends decorator. The method may
return any object which itself can be rendered as a Pane.
"""
defer_load = param.Boolean(default=None, doc="""
Whether to defer load until after the page is rendered.
Can be set as parameter or by setting panel.config.defer_load.""")
lazy = param.Boolean(default=False, doc="""
Whether to lazily evaluate the contents of the object
only when it is required for rendering.""")
loading_indicator = param.Boolean(default=config.loading_indicator, doc="""
Whether to show a loading indicator while the pane is updating.
Can be set as parameter or by setting panel.config.loading_indicator.""")
def __init__(self, object=None, **params):
if 'defer_load' not in params:
params['defer_load'] = config.defer_load
super().__init__(object, **params)
self._async_task = None
self._evaled = not (self.lazy or self.defer_load)
self._link_object_params()
if object is not None:
self._validate_object()
if not self.defer_load:
self._replace_pane()
@param.depends('object', watch=True)
def _validate_object(self):
dependencies = getattr(self.object, '_dinfo', None)
if not dependencies or not dependencies.get('watch'):
return
fn_type = 'method' if type(self) is ParamMethod else 'function'
self.param.warning(
f"The {fn_type} supplied for Panel to display was declared "
f"with `watch=True`, which will cause the {fn_type} to be "
"called twice for any change in a dependent Parameter. "
"`watch` should be False when Panel is responsible for "
f"displaying the result of the {fn_type} call, while "
f"`watch=True` should be reserved for {fn_type}s that work "
"via side-effects, e.g. by modifying internal state of a "
"class or global state in an application's namespace."
)
#----------------------------------------------------------------
# Callback API
#----------------------------------------------------------------
@classmethod
def eval(self, function):
return eval_function(function)
async def _eval_async(self, awaitable):
if self._async_task:
self._async_task.cancel()
self._async_task = task = asyncio.current_task()
curdoc = state.curdoc
has_context = bool(curdoc.session_context) if curdoc else False
if has_context:
curdoc.on_session_destroyed(lambda context: task.cancel())
try:
if isinstance(awaitable, types.AsyncGeneratorType):
async for new_obj in awaitable:
self._update_inner(new_obj)
else:
self._update_inner(await awaitable)
except Exception as e:
if not curdoc or (has_context and curdoc.session_context):
raise e
finally:
self._async_task = None
self._inner_layout.loading = False
def _replace_pane(self, *args, force=False):
deferred = self.defer_load and not state.loaded
if not self._inner_layout.loading:
self._inner_layout.loading = bool(self.loading_indicator or deferred)
self._evaled |= force or not (self.lazy or deferred)
if not self._evaled:
return
try:
if self.object is None:
new_object = Spacer()
else:
new_object = self.eval(self.object)
if inspect.isawaitable(new_object) or isinstance(new_object, types.AsyncGeneratorType):
param.parameterized.async_executor(partial(self._eval_async, new_object))
return
elif isinstance(new_object, Generator):
for new_obj in new_object:
self._update_inner(new_obj)
else:
self._update_inner(new_object)
finally:
self._inner_layout.loading = False
def _update_pane(self, *events):
callbacks = []
for watcher in self._internal_callbacks:
obj = watcher.inst if watcher.inst is None else watcher.cls
if obj is self:
callbacks.append(watcher)
continue
obj.param.unwatch(watcher)
self._internal_callbacks = callbacks
self._link_object_params()
self._replace_pane()
def _link_object_params(self):
parameterized = get_method_owner(self.object)
params = parameterized.param.method_dependencies(self.object.__name__)
deps = params
def update_pane(*events):
# Update nested dependencies if parameterized object events
if any(is_parameterized(event.new) for event in events):
new_deps = parameterized.param.method_dependencies(self.object.__name__)
for p in list(deps):
if p in new_deps: continue
watchers = self._internal_callbacks
for w in list(watchers):
if (w.inst is p.inst and w.cls is p.cls and
p.name in w.parameter_names):
obj = p.cls if p.inst is None else p.inst
obj.param.unwatch(w)
watchers.remove(w)
deps.remove(p)
new_deps = [dep for dep in new_deps if dep not in deps]
for _, params in full_groupby(new_deps, lambda x: (x.inst or x.cls, x.what)):
p = params[0]
pobj = p.cls if p.inst is None else p.inst
ps = [_p.name for _p in params]
watcher = pobj.param.watch(update_pane, ps, p.what)
self._internal_callbacks.append(watcher)
for p in params:
deps.append(p)
self._replace_pane()
for _, params in full_groupby(params, lambda x: (x.inst or x.cls, x.what)):
p = params[0]
pobj = (p.inst or p.cls)
ps = [_p.name for _p in params]
if isinstance(pobj, Reactive) and self.loading_indicator:
props = {p: 'loading' for p in ps if p in pobj._linkable_params}
if props:
pobj.jslink(self._inner_layout, **props)
watcher = pobj.param.watch(update_pane, ps, p.what)
self._internal_callbacks.append(watcher)
def _get_model(
self, doc: Document, root: Optional[Model] = None,
parent: Optional[Model] = None, comm: Optional[Comm] = None
) -> Model:
if not self._evaled:
deferred = self.defer_load and not state.loaded
if deferred:
state.onload(partial(self._replace_pane, force=True))
self._replace_pane(force=not deferred)
return super()._get_model(doc, root, parent, comm)
#----------------------------------------------------------------
# Public API
#----------------------------------------------------------------
@classmethod
def applies(cls, obj: Any) -> float | bool | None:
return inspect.ismethod(obj) and isinstance(get_method_owner(obj), param.Parameterized)
@param.depends(config.param.defer_load, watch=True)
def _update_defer_load_default(default_value):
ParamMethod.param.defer_load.default = default_value
@param.depends(config.param.loading_indicator, watch=True)
def _update_loading_indicator_default(default_value):
ParamMethod.param.loading_indicator.default = default_value
class ParamFunction(ParamMethod):
"""
ParamFunction panes wrap functions decorated with the param.depends
decorator and rerenders the output when any of the function's
dependencies change. This allows building reactive components into
a Panel which depend on other parameters, e.g. tying the value of
a widget to some other output.
"""
priority: ClassVar[float | bool | None] = 0.6
_applies_kw: ClassVar[bool] = True
def _link_object_params(self):
deps = getattr(self.object, '_dinfo', {})
dep_params = list(deps.get('dependencies', [])) + list(deps.get('kw', {}).values())
if not dep_params and not self.lazy and not self.defer_load and not iscoroutinefunction(self.object):
fn = getattr(self.object, '__bound_function__', self.object)
fn_name = getattr(fn, '__name__', repr(self.object))
self.param.warning(
f"The function {fn_name!r} does not have any dependencies "
"and will never update. Are you sure you did not intend "
"to depend on or bind a parameter or widget to this function? "
"If not simply call the function before passing it to Panel. "
"Otherwise, when passing a parameter as an argument, "
"ensure you pass at least one parameter and reference the "
"actual parameter object not the current value, i.e. use "
"object.param.parameter not object.parameter."
)
grouped = defaultdict(list)
for dep in dep_params:
grouped[id(dep.owner)].append(dep)
for group in grouped.values():
pobj = group[0].owner
watcher = pobj.param.watch(self._replace_pane, [dep.name for dep in group])
if isinstance(pobj, Reactive) and self.loading_indicator:
props = {dep.name: 'loading' for dep in group
if dep.name in pobj._linkable_params}
if props:
pobj.jslink(self._inner_layout, **props)
self._internal_callbacks.append(watcher)
#----------------------------------------------------------------
# Public API
#----------------------------------------------------------------
@classmethod
def applies(cls, obj: Any, **kwargs) -> float | bool | None:
if isinstance(obj, types.FunctionType):
if hasattr(obj, '_dinfo'):
return True
if (
kwargs.get('defer_load') or cls.param.defer_load.default or
(cls.param.defer_load.default is None and config.defer_load) or
iscoroutinefunction(obj)
):
return True
return None
return False
class JSONInit(param.Parameterized):
"""
Callable that can be passed to Widgets.initializer to set Parameter