-
-
Notifications
You must be signed in to change notification settings - Fork 477
/
base.py
257 lines (210 loc) · 8.37 KB
/
base.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
"""
Defines the Widget base class which provides bi-directional
communication between the rendered dashboard and the Widget
parameters.
"""
from __future__ import annotations
import math
from typing import (
TYPE_CHECKING, Any, Callable, ClassVar, Dict, List, Mapping, Optional,
Tuple, Type, TypeVar,
)
import param # type: ignore
from bokeh.models import ImportedStyleSheet, Tooltip
from bokeh.models.dom import HTML
from param.parameterized import register_reference_transform
from .._param import Margin
from ..layout.base import Row
from ..reactive import Reactive
from ..viewable import Layoutable, Viewable
if TYPE_CHECKING:
from bokeh.document import Document
from bokeh.model import Model
from pyviz_comms import Comm
from ..layout.base import ListPanel
T = TypeVar('T')
class Widget(Reactive):
"""
Widgets allow syncing changes in bokeh widget models with the
parameters on the Widget instance.
"""
disabled = param.Boolean(default=False, doc="""
Whether the widget is disabled.""")
name = param.String(default='')
height = param.Integer(default=None, bounds=(0, None))
width = param.Integer(default=None, bounds=(0, None))
margin = Margin(default=(5, 10), doc="""
Allows to create additional space around the component. May
be specified as a two-tuple of the form (vertical, horizontal)
or a four-tuple (top, right, bottom, left).""")
_rename: ClassVar[Mapping[str, str | None]] = {'name': 'title'}
# Whether the widget supports embedding
_supports_embed: ClassVar[bool] = False
# Declares the Bokeh model type of the widget
_widget_type: ClassVar[Type[Model] | None] = None
__abstract = True
def __init__(self, **params):
if 'name' not in params:
params['name'] = ''
if '_supports_embed' in params:
self._supports_embed = params.pop('_supports_embed')
if '_param_pane' in params:
self._param_pane = params.pop('_param_pane')
else:
self._param_pane = None
super().__init__(**params)
@classmethod
def from_param(cls: Type[T], parameter: param.Parameter, **params) -> T:
"""
Construct a widget from a Parameter and link the two
bi-directionally.
Parameters
----------
parameter: param.Parameter
A parameter to create the widget from.
params: dict
Keyword arguments to be passed to the widget constructor
Returns
-------
Widget instance linked to the supplied parameter
"""
from ..param import Param
layout = Param(
parameter, widgets={parameter.name: dict(type=cls, **params)},
display_threshold=-math.inf
)
return layout[0]
@property
def _linked_properties(self) -> Tuple[str]:
props = list(super()._linked_properties)
if 'description' in props:
props.remove('description')
return tuple(props)
@property
def rx(self):
return self.param.value.rx
def _process_param_change(self, params: Dict[str, Any]) -> Dict[str, Any]:
params = super()._process_param_change(params)
if self._widget_type is not None and 'stylesheets' in params:
css = getattr(self._widget_type, '__css__', [])
params['stylesheets'] = [
ImportedStyleSheet(url=ss) for ss in css
] + params['stylesheets']
if "description" in params:
description = params["description"]
renderer_options = params.pop("renderer_options", {})
if isinstance(description, str):
from ..pane.markup import Markdown
parser = Markdown._get_parser('markdown-it', (), **renderer_options)
html = parser.render(description)
params['description'] = Tooltip(
content=HTML(html), position='right',
stylesheets=[':host { white-space: initial; max-width: 300px; }'],
syncable=False
)
elif isinstance(description, Tooltip):
description.syncable = False
return params
def _get_model(
self, doc: Document, root: Optional[Model] = None,
parent: Optional[Model] = None, comm: Optional[Comm] = None
) -> Model:
model = self._widget_type(**self._get_properties(doc))
root = root or model
self._models[root.ref['id']] = (model, parent)
self._link_props(model, self._linked_properties, doc, root, comm)
return model
def _get_embed_state(
self, root: 'Model', values: Optional[List[Any]] = None, max_opts: int = 3
) -> Tuple['Widget', 'Model', List[Any], Callable[['Model'], Any], str, str]:
"""
Returns the bokeh model and a discrete set of value states
for the widget.
Arguments
---------
root: bokeh.model.Model
The root model of the widget
values: list (optional)
An explicit list of value states to embed
max_opts: int
The maximum number of states the widget should return
Returns
-------
widget: panel.widget.Widget
The Panel widget instance to modify to effect state changes
model: bokeh.model.Model
The bokeh model to record the current value state on
values: list
A list of value states to explore.
getter: callable
A function that returns the state value given the model
on_change: string
The name of the widget property to attach a callback on
js_getter: string
JS snippet that returns the state value given the model
"""
class CompositeWidget(Widget):
"""
A baseclass for widgets which are made up of two or more other
widgets
"""
_composite_type: ClassVar[Type[ListPanel]] = Row
_linked_properties: ClassVar[Tuple[str]] = ()
__abstract = True
def __init__(self, **params):
super().__init__(**params)
layout_params = [p for p in Layoutable.param if p != 'name']
layout = {p: getattr(self, p) for p in layout_params
if getattr(self, p) is not None}
if layout.get('width', self.width) is None and 'sizing_mode' not in layout:
layout['sizing_mode'] = 'stretch_width'
if layout.get('sizing_mode') not in (None, 'fixed') and layout.get('width'):
min_width = layout.pop('width')
if not layout.get('min_width'):
layout['min_width'] = min_width
self._composite = self._composite_type(**layout)
self._models = self._composite._models
self._internal_callbacks.append(
self.param.watch(self._update_layout_params, layout_params)
)
def _update_layout_params(self, *events: param.parameterized.Event) -> None:
updates = {event.name: event.new for event in events}
self._composite.param.update(**updates)
def select(
self, selector: Optional[type | Callable[['Viewable'], bool]] = None
) -> List[Viewable]:
"""
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)
"""
objects = super().select(selector)
for obj in self._composite.objects:
objects += obj.select(selector)
return objects
def _cleanup(self, root: Model | None = None) -> None:
self._composite._cleanup(root)
super()._cleanup(root)
def _get_model(
self, doc: Document, root: Optional[Model] = None,
parent: Optional[Model] = None, comm: Optional[Comm] = None
) -> Model:
model = self._composite._get_model(doc, root, parent, comm)
root = root or model
self._models[root.ref['id']] = (model, parent)
return model
def __contains__(self, object: Any) -> bool:
return object in self._composite.objects
@property
def _synced_params(self) -> List[str]:
return []
def _widget_transform(obj):
return obj.param.value if isinstance(obj, Widget) else obj
register_reference_transform(_widget_transform)