-
-
Notifications
You must be signed in to change notification settings - Fork 477
/
ipywidget.py
231 lines (189 loc) · 7.2 KB
/
ipywidget.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
import logging
import os
from functools import partial
import ipykernel
import jupyter_client.session as session
import param
from bokeh.document.events import MessageSentEvent
from bokeh.document.json import Literal, MessageSent, TypedDict
from bokeh.util.serialization import make_id
from ipykernel.comm import Comm, CommManager
from ipykernel.kernelbase import Kernel
from ipywidgets import Widget
from ipywidgets._version import __protocol_version__
from ipywidgets.widgets.widget import _remove_buffers
# Stop ipywidgets_bokeh from patching the kernel
ipykernel.kernelbase.Kernel._instance = ''
from ipywidgets_bokeh.kernel import (
BokehKernel, SessionWebsocket, WebsocketStream,
)
from ipywidgets_bokeh.widget import IPyWidget
from tornado.ioloop import IOLoop
from traitlets import Any
from ..config import __version__
from ..util import classproperty
from .state import set_curdoc, state
try:
# Support for ipywidgets>=8.0.5
import comm
from comm.base_comm import BaseComm
class TempComm(BaseComm):
def publish_msg(self, *args, **kwargs): pass
comm.create_comm = lambda *args, **kwargs: TempComm(target_name='panel-temp-comm', primary=False)
except Exception:
comm = None
def _get_kernel(cls=None, doc=None):
doc = doc or state.curdoc
if doc is None:
return _ORIG_KERNEL
elif doc in state._ipykernels:
return state._ipykernels[doc]
state._ipykernels[doc] = kernel = PanelKernel(document=doc, key=str(id(doc)).encode('utf-8'))
return kernel
def _get_ipywidgets():
# Support ipywidgets >=8.0 and <8.0
try:
from ipywidgets.widgets.widget import _instances as widgets
except Exception:
widgets = Widget.widgets
return widgets
def _on_widget_constructed(widget, doc=None):
doc = doc or state.curdoc
if not doc or getattr(widget, '_document', None) not in (doc, None):
return
widget._document = doc
kernel = _get_kernel(doc=doc)
if (widget.comm and widget.comm.target_name != 'panel-temp-comm' and
(not (comm and isinstance(widget.comm, comm.DummyComm)) and
isinstance(widget.comm.kernel, PanelKernel))):
return
wstate, buffer_paths, buffers = _remove_buffers(widget.get_state())
args = {
'target_name': 'jupyter.widget',
'data': {
'state': wstate,
'buffer_paths': buffer_paths
},
'buffers': buffers,
'metadata': {
'version': __protocol_version__
},
'kernel': kernel
}
if widget._model_id is not None:
args['comm_id'] = widget._model_id
try:
widget.comm = Comm(**args)
except Exception as e:
if 'PANEL_IPYWIDGET' not in os.environ:
raise e
kernel.register_widget(widget)
# Patch font-awesome CSS onto ipywidgets_bokeh IPyWidget
IPyWidget.__css__ = [
"https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.5.0/css/font-awesome.css"
]
class MessageSentBuffers(TypedDict):
kind: Literal["MessageSent"]
msg_type: str
class MessageSentEventPatched(MessageSentEvent):
"""
Patches MessageSentEvent with fix that ensures MessageSent event
does not define msg_data (which is an assumption in BokehJS
Document.apply_json_patch.)
"""
def generate(self, references, buffers):
if not isinstance(self.msg_data, bytes):
msg = MessageSent(
kind=self.kind,
msg_type=self.msg_type,
msg_data=self.msg_data
)
else:
msg = MessageSentBuffers(
kind=self.kind,
msg_type=self.msg_type
)
assert buffers is not None
buffer_id = make_id()
buf = (dict(id=buffer_id), self.msg_data)
buffers.append(buf)
return msg
class PanelSessionWebsocket(SessionWebsocket):
def __init__(self, *args, **kwargs):
session.Session.__init__(self, *args, **kwargs)
self._document = kwargs.pop('document', None)
self._queue = []
self._document.on_message("ipywidgets_bokeh", self.receive)
def send(self, stream, msg_type, content=None, parent=None, ident=None, buffers=None, track=False, header=None, metadata=None):
msg = self.msg(msg_type, content=content, parent=parent, header=header, metadata=metadata)
try:
msg['channel'] = stream.channel
except Exception:
return
packed = self.pack(msg)
if buffers is not None and len(buffers) != 0:
buffers = [packed] + buffers
nbufs = len(buffers)
start = 4*(1 + nbufs)
offsets = [start]
for buffer in buffers[:-1]:
start += memoryview(buffer).nbytes
offsets.append(start)
u32 = lambda n: n.to_bytes(4, "big")
items = [u32(nbufs)] + [ u32(offset) for offset in offsets ] + buffers
data = b"".join(items)
else:
data = packed.decode("utf-8")
event = MessageSentEventPatched(self._document, "ipywidgets_bokeh", data)
self._queue.append(event)
self._document.add_next_tick_callback(self._dispatch)
def _dispatch(self):
try:
for event in self._queue:
self._document.callbacks.trigger_on_change(event)
except Exception as e:
param.main.param.warning(f'ipywidgets event dispatch failed with: {e}')
finally:
self._queue = []
class ShellStream:
def flush(self, *args):
pass
class PanelKernel(Kernel):
implementation = 'panel'
implementation_version = __version__
banner = 'banner'
shell_stream = Any(ShellStream(), allow_none=True)
def __init__(self, key=None, document=None):
super().__init__()
self.session = PanelSessionWebsocket(document=document, parent=self, key=key)
self.stream = self.iopub_socket = WebsocketStream(self.session)
self.io_loop = IOLoop.current()
self.iopub_socket.channel = 'iopub'
self.session.stream = self.iopub_socket
self.comm_manager = CommManager(parent=self, kernel=self)
self.shell = None
self.session.auth = None
self.log = logging.getLogger('fake')
comm_msg_types = ['comm_open', 'comm_msg', 'comm_close']
for msg_type in comm_msg_types:
handler = getattr(self.comm_manager, msg_type)
self.shell_handlers[msg_type] = self._wrap_handler(msg_type, handler)
async def _flush_control_queue(self):
pass
def register_widget(self, widget):
comm = widget.comm
comm.kernel = self
self.comm_manager.register_comm(comm)
def _wrap_handler(self, msg_type, handler):
doc = self.session._document
def wrapper(*args, **kwargs):
if msg_type == 'comm_open':
return
with set_curdoc(doc):
state.execute(partial(handler, *args, **kwargs), schedule=True)
return wrapper
# Patch kernel and widget objects
_ORIG_KERNEL = ipykernel.kernelbase.Kernel._instance
if isinstance(ipykernel.kernelbase.Kernel._instance, (BokehKernel, str)):
ipykernel.kernelbase.Kernel._instance = classproperty(_get_kernel)
Widget.on_widget_constructed(_on_widget_constructed)