comm.py
153 lines
| 5.0 KiB
| text/x-python
|
PythonLexer
|
r13195 | """Base class for a Comm""" | ||
|
r16623 | # Copyright (c) IPython Development Team. | ||
# Distributed under the terms of the Modified BSD License. | ||||
|
r13195 | |||
import uuid | ||||
from IPython.config import LoggingConfigurable | ||||
|
r17987 | from IPython.kernel.zmq.kernelbase import Kernel | ||
|
r13195 | |||
|
r16623 | from IPython.utils.jsonutil import json_clean | ||
|
r13195 | from IPython.utils.traitlets import Instance, Unicode, Bytes, Bool, Dict, Any | ||
class Comm(LoggingConfigurable): | ||||
|
r17964 | # If this is instantiated by a non-IPython kernel, shell will be None | ||
shell = Instance('IPython.core.interactiveshell.InteractiveShellABC', | ||||
allow_none=True) | ||||
kernel = Instance('IPython.kernel.zmq.kernelbase.Kernel') | ||||
|
r17987 | def _kernel_default(self): | ||
if Kernel.initialized(): | ||||
return Kernel.instance() | ||||
|
r13199 | |||
|
r13195 | iopub_socket = Any() | ||
def _iopub_socket_default(self): | ||||
|
r17964 | return self.kernel.iopub_socket | ||
|
r13195 | session = Instance('IPython.kernel.zmq.session.Session') | ||
def _session_default(self): | ||||
|
r18081 | if self.kernel is not None: | ||
return self.kernel.session | ||||
|
r13195 | |||
|
r13204 | target_name = Unicode('comm') | ||
|
r13195 | |||
topic = Bytes() | ||||
def _topic_default(self): | ||||
return ('comm-%s' % self.comm_id).encode('ascii') | ||||
|
r13205 | _open_data = Dict(help="data dict, if any, to be included in comm_open") | ||
|
r13195 | _close_data = Dict(help="data dict, if any, to be included in comm_close") | ||
_msg_callback = Any() | ||||
_close_callback = Any() | ||||
_closed = Bool(False) | ||||
comm_id = Unicode() | ||||
def _comm_id_default(self): | ||||
return uuid.uuid4().hex | ||||
primary = Bool(True, help="Am I the primary or secondary Comm?") | ||||
|
r13228 | def __init__(self, target_name='', data=None, **kwargs): | ||
if target_name: | ||||
kwargs['target_name'] = target_name | ||||
|
r13195 | super(Comm, self).__init__(**kwargs) | ||
if self.primary: | ||||
|
r13205 | # I am primary, open my peer. | ||
|
r13197 | self.open(data) | ||
|
r13195 | |||
|
r18329 | def _publish_msg(self, msg_type, data=None, metadata=None, buffers=None, **keys): | ||
|
r13195 | """Helper for sending a comm message on IOPub""" | ||
|
r17987 | data = {} if data is None else data | ||
metadata = {} if metadata is None else metadata | ||||
content = json_clean(dict(data=data, comm_id=self.comm_id, **keys)) | ||||
self.session.send(self.iopub_socket, msg_type, | ||||
content, | ||||
metadata=json_clean(metadata), | ||||
parent=self.kernel._parent_header, | ||||
ident=self.topic, | ||||
|
r18329 | buffers=buffers, | ||
|
r17987 | ) | ||
|
r13195 | |||
def __del__(self): | ||||
"""trigger close on gc""" | ||||
self.close() | ||||
# publishing messages | ||||
|
r18329 | def open(self, data=None, metadata=None, buffers=None): | ||
|
r13195 | """Open the frontend-side version of this comm""" | ||
if data is None: | ||||
data = self._open_data | ||||
|
r17987 | comm_manager = getattr(self.kernel, 'comm_manager', None) | ||
if comm_manager is None: | ||||
raise RuntimeError("Comms cannot be opened without a kernel " | ||||
"and a comm_manager attached to that kernel.") | ||||
comm_manager.register_comm(self) | ||||
|
r17450 | self._closed = False | ||
|
r18329 | self._publish_msg('comm_open', | ||
data=data, metadata=metadata, buffers=buffers, | ||||
target_name=self.target_name, | ||||
) | ||||
|
r13195 | |||
|
r18329 | def close(self, data=None, metadata=None, buffers=None): | ||
|
r13195 | """Close the frontend-side version of this comm""" | ||
if self._closed: | ||||
# only close once | ||||
return | ||||
if data is None: | ||||
data = self._close_data | ||||
|
r18329 | self._publish_msg('comm_close', | ||
data=data, metadata=metadata, buffers=buffers, | ||||
) | ||||
|
r17987 | self.kernel.comm_manager.unregister_comm(self) | ||
|
r13195 | self._closed = True | ||
|
r18329 | def send(self, data=None, metadata=None, buffers=None): | ||
|
r13197 | """Send a message to the frontend-side version of this comm""" | ||
|
r18329 | self._publish_msg('comm_msg', | ||
data=data, metadata=metadata, buffers=buffers, | ||||
) | ||||
|
r13195 | |||
# registering callbacks | ||||
def on_close(self, callback): | ||||
"""Register a callback for comm_close | ||||
Will be called with the `data` of the close message. | ||||
Call `on_close(None)` to disable an existing callback. | ||||
""" | ||||
self._close_callback = callback | ||||
def on_msg(self, callback): | ||||
"""Register a callback for comm_msg | ||||
Will be called with the `data` of any comm_msg messages. | ||||
Call `on_msg(None)` to disable an existing callback. | ||||
""" | ||||
self._msg_callback = callback | ||||
# handling of incoming messages | ||||
|
r13197 | def handle_close(self, msg): | ||
|
r13195 | """Handle a comm_close message""" | ||
|
r13197 | self.log.debug("handle_close[%s](%s)", self.comm_id, msg) | ||
|
r13195 | if self._close_callback: | ||
|
r13197 | self._close_callback(msg) | ||
|
r13195 | |||
|
r13197 | def handle_msg(self, msg): | ||
|
r13195 | """Handle a comm_msg message""" | ||
|
r13197 | self.log.debug("handle_msg[%s](%s)", self.comm_id, msg) | ||
|
r13195 | if self._msg_callback: | ||
|
r17964 | if self.shell: | ||
self.shell.events.trigger('pre_execute') | ||||
|
r13197 | self._msg_callback(msg) | ||
|
r17964 | if self.shell: | ||
self.shell.events.trigger('post_execute') | ||||
|
r13195 | |||
__all__ = ['Comm'] | ||||