Restructured Jupyter widget

Author: alexsocha

algorithmx/__init__.py

@@ -1,6 +1,5 @@
-from .jupyter import JupyterWidget
 from ._version import __version__, version_info
 
 from .nbextension import _jupyter_nbextension_paths
 
-from .main import http_server, jupyter_widget
+from .main import http_server, jupyter_client, jupyter_canvas

algorithmx/_version.py

@@ -1,2 +1,2 @@
-version_info = (1, 0, 0, 'beta', 6)
+version_info = (1, 0, 0, 'beta', 7)
 __version__ = '.'.join(map(str, version_info))

algorithmx/graphics/CanvasSelection.py

@@ -220,10 +220,11 @@ def svgattr(self: S, key: str, value: ElementArg[Union[str, int, float, None]]):
         return self
 
 
-def canvas_selection(canvas: str, handler: EventHandler) -> CanvasSelection:
+def canvas_selection(canvas: str, handler: EventHandler,
+                     canvas_class: CanvasSelection = CanvasSelection) -> CanvasSelection:
     context = SelectionContext(handler)
     context.name = 'canvas'
     context.ids = [canvas]
     context.data = [canvas]
     handler.subscribe(lambda event: receive_handler(event, context.listeners))
-    return CanvasSelection(context)
+    return canvas_class(context)

algorithmx/jupyter/JupyterCanvas.py

@@ -0,0 +1,7 @@
+from ..graphics import CanvasSelection, canvas_selection
+from IPython.display import display
+
+class JupyterCanvas(CanvasSelection):
+    def _ipython_display_(self):
+        display(self._context.client)
+

algorithmx/jupyter/JupyterWidget.py algorithmx/jupyter/JupyterClient.pyalgorithmx/jupyter/JupyterWidget.py renamed to algorithmx/jupyter/JupyterClient.py

@@ -4,28 +4,28 @@
 from ._frontend import module_name, module_version
 import json
 
-from ..graphics import CanvasSelection, canvas_selection, DispatchEvent, ReceiveEvent
+from .JupyterCanvas import JupyterCanvas
+from ..graphics import CanvasSelection, canvas_selection, EventHandler, DispatchEvent, ReceiveEvent
 
-
-class JupyterWidget(DOMWidget):
-    _model_name = Unicode('CanvasModel').tag(sync=True)
+class JupyterClient(DOMWidget, EventHandler):
+    _model_name = Unicode('AlgorithmxModel').tag(sync=True)
     _model_module = Unicode(module_name).tag(sync=True)
     _model_module_version = Unicode(module_version).tag(sync=True)
-    _view_name = Unicode('CanvasView').tag(sync=True)
+    _view_name = Unicode('AlgorithmxView').tag(sync=True)
     _view_module = Unicode(module_name).tag(sync=True)
     _view_module_version = Unicode(module_version).tag(sync=True)
 
-    _dispatch_events: SyncList = SyncList(Unicode, []).tag(sync=True)
-    _show_buttons: SyncBool = SyncBool(False).tag(sync=True)
-
     _subscriptions: List[Callable[[ReceiveEvent], Any]]
 
+    events: SyncList = SyncList(Unicode, []).tag(sync=True)
+    show_buttons: SyncBool = SyncBool(False).tag(sync=True)
+
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
 
         self._subscriptions = []
         if 'buttons' in kwargs:
-            self._show_buttons = kwargs['buttons']
+            self.show_buttons = kwargs['buttons']
 
         def on_msg(widget, content, buffers):
             event = json.loads(content)
@@ -38,17 +38,10 @@ def on_msg(widget, content, buffers):
 
     def dispatch(self, event: DispatchEvent):
         str_event = json.dumps(event)
-        self._dispatch_events = self._dispatch_events + [str_event]
+        self.events = self.events + [str_event]
 
     def subscribe(self, listener: Callable[[ReceiveEvent], Any]):
         self._subscriptions.append(listener)
 
-    def canvas(self) -> CanvasSelection:
-        """
-        Creates a new :class:`~graphics.CanvasSelection` which will dispatch and receive events through the Jupyter
-        widget. The default canvas size is (400, 250).
-
-        Note that by default, you need to hold down the ``ctrl``/``cmd`` key to zoom in
-        (see :meth:`~graphics.CanvasSelection.zoomkey`).
-        """
-        return canvas_selection('_jupyter', self)
+    def canvas(self) -> JupyterCanvas:
+        return canvas_selection('_jupyter', self, JupyterCanvas)

algorithmx/jupyter/__init__.py

@@ -1,4 +1,5 @@
 from ..graphics import EventHandler, ReceiveEvent, DispatchEvent
 from ..graphics import CanvasSelection
 
-from .JupyterWidget import JupyterWidget
+from .JupyterClient import JupyterClient
+from .JupyterCanvas import JupyterCanvas

algorithmx/jupyter/_frontend.py

@@ -3,4 +3,4 @@
 """
 
 module_name = 'algorithmx-jupyter'
-module_version = '^1.0.0'
+module_version = '^2.0.0'

algorithmx/main.py

@@ -1,5 +1,6 @@
 from .server import Server
-from .jupyter import JupyterWidget
+from .jupyter import JupyterClient, JupyterCanvas
+from .graphics import CanvasSelection
 
 def http_server(file: str = None, port: int = 5050) -> Server:
     """
@@ -18,11 +19,14 @@ def http_server(file: str = None, port: int = 5050) -> Server:
     """
     return Server(file, port)
 
-def jupyter_widget(buttons: bool = False) -> JupyterWidget:
+def jupyter_client(buttons: bool = False) -> JupyterClient:
+    return JupyterClient(buttons=buttons)
+
+def jupyter_canvas(buttons: bool = False) -> JupyterCanvas:
     """
-    Creates a new Jupyter widget for displaying the network.
+    Creates a new :class:`~graphics.CanvasSelection` which will dispatch and receive events through a Jupyter
+    widget, and which can be displayed using the IPython ``display`` function.
 
-    :param buttons: Whether or not the widget should include buttons for starting/stopping/restarting events on the
-        network (useful for algorithm simulations). Disabled by default.
+    By default, the canvas size is (400, 250), and requires the ``ctrl``/``cmd`` to be held down while zooming.
     """
-    return JupyterWidget(buttons=buttons)
+    return jupyter_client(buttons=buttons).canvas()