Added basic Jupyter tests and fix issues

glue_vispy_viewers/common/qt/data_viewer.py

@@ -18,10 +18,19 @@
 class BaseVispyViewer(BaseVispyViewerMixin, DataViewer):
 
     _options_cls = VispyOptionsWidget
+    tools = BaseVispyViewerMixin.tools
     subtools = {'save': ['vispy:save']}
 
     _toolbar_cls = VispyQtToolbar
 
+    # If imageio is available, we can add the record icon
+    try:
+        import imageio  # noqa
+    except ImportError:
+        pass
+    else:
+        tools.insert(1, 'vispy:record')
+
     def __init__(self, session, state=None, parent=None):
         super().__init__(session, state=state, parent=parent)
         self.setup_widget_and_callbacks()

glue_vispy_viewers/common/qt/tools.py

@@ -0,0 +1,83 @@
+import os
+
+from qtpy import QtGui, compat
+
+from glue.viewers.common.tool import Tool, CheckableTool
+
+from glue.config import viewer_tool
+
+from vispy import app, io
+
+RECORD_START_ICON = os.path.join(os.path.dirname(__file__), 'glue_record_start.png')
+RECORD_STOP_ICON = os.path.join(os.path.dirname(__file__), 'glue_record_stop.png')
+
+
+@viewer_tool
+class SaveTool(Tool):
+
+    icon = 'glue_filesave'
+    tool_id = 'vispy:save'
+    action_text = 'Save the figure to a file'
+    tool_tip = 'Save the figure to a file'
+
+    def activate(self):
+        outfile, file_filter = compat.getsavefilename(caption='Save File',
+                                                      filters='PNG Files (*.png);;'
+                                                              'JPEG Files (*.jpeg);;'
+                                                              'TIFF Files (*.tiff);;',
+                                                      selectedfilter='PNG Files (*.png);;')
+
+        # This indicates that the user cancelled
+        if not outfile:
+            return
+        img = self.viewer._vispy_widget.canvas.render()
+        try:
+            file_filter = str(file_filter).split()[0]
+            io.imsave(outfile, img, format=file_filter)
+        except ImportError:
+            # TODO: give out a window to notify that only .png file format is supported
+            if '.' not in outfile:
+                outfile += '.png'
+            io.write_png(outfile, img)
+
+
+@viewer_tool
+class RecordTool(CheckableTool):
+
+    icon = RECORD_START_ICON
+    tool_id = 'vispy:record'
+    action_text = 'Record an animation'
+    tool_tip = 'Start/Stop the recording'
+
+    def __init__(self, viewer):
+        super(RecordTool, self).__init__(viewer=viewer)
+        self.record_timer = app.Timer(connect=self.record)
+        self.writer = None
+        self.next_action = 'start'
+
+    def activate(self):
+
+        # pop up a window for file saving
+        outfile, file_filter = compat.getsavefilename(caption='Save Animation',
+                                                      filters='GIF Files (*.gif);;')
+
+        # if outfile is not set, the user cancelled
+        if outfile:
+            import imageio
+            self.set_icon(RECORD_STOP_ICON)
+            self.writer = imageio.get_writer(outfile)
+            self.record_timer.start(0.1)
+
+    def deactivate(self):
+
+        self.record_timer.stop()
+        if self.writer is not None:
+            self.writer.close()
+        self.set_icon(RECORD_START_ICON)
+
+    def set_icon(self, icon):
+        self.viewer.toolbar.actions[self.tool_id].setIcon(QtGui.QIcon(icon))
+
+    def record(self, event):
+        im = self.viewer._vispy_widget.canvas.render()
+        self.writer.append_data(im)

glue_vispy_viewers/common/tools.py

@@ -1,16 +1,12 @@
 import os
 
-from qtpy import QtGui, compat
-
 from glue.viewers.common.tool import Tool, CheckableTool
 
 from glue.config import viewer_tool
 
-from vispy import app, io
+from vispy import app
 
 
-RECORD_START_ICON = os.path.join(os.path.dirname(__file__), 'glue_record_start.png')
-RECORD_STOP_ICON = os.path.join(os.path.dirname(__file__), 'glue_record_stop.png')
 ROTATE_ICON = os.path.join(os.path.dirname(__file__), 'glue_rotate.png')
 
 
@@ -28,77 +24,6 @@ def activate(self):
         self.viewer.state.reset_limits()
 
 
-@viewer_tool
-class SaveTool(Tool):
-
-    icon = 'glue_filesave'
-    tool_id = 'vispy:save'
-    action_text = 'Save the figure to a file'
-    tool_tip = 'Save the figure to a file'
-
-    def activate(self):
-        outfile, file_filter = compat.getsavefilename(caption='Save File',
-                                                      filters='PNG Files (*.png);;'
-                                                              'JPEG Files (*.jpeg);;'
-                                                              'TIFF Files (*.tiff);;',
-                                                      selectedfilter='PNG Files (*.png);;')
-
-        # This indicates that the user cancelled
-        if not outfile:
-            return
-        img = self.viewer._vispy_widget.canvas.render()
-        try:
-            file_filter = str(file_filter).split()[0]
-            io.imsave(outfile, img, format=file_filter)
-        except ImportError:
-            # TODO: give out a window to notify that only .png file format is supported
-            if '.' not in outfile:
-                outfile += '.png'
-            io.write_png(outfile, img)
-
-
-@viewer_tool
-class RecordTool(CheckableTool):
-
-    icon = RECORD_START_ICON
-    tool_id = 'vispy:record'
-    action_text = 'Record an animation'
-    tool_tip = 'Start/Stop the recording'
-
-    def __init__(self, viewer):
-        super(RecordTool, self).__init__(viewer=viewer)
-        self.record_timer = app.Timer(connect=self.record)
-        self.writer = None
-        self.next_action = 'start'
-
-    def activate(self):
-
-        # pop up a window for file saving
-        outfile, file_filter = compat.getsavefilename(caption='Save Animation',
-                                                      filters='GIF Files (*.gif);;')
-
-        # if outfile is not set, the user cancelled
-        if outfile:
-            import imageio
-            self.set_icon(RECORD_STOP_ICON)
-            self.writer = imageio.get_writer(outfile)
-            self.record_timer.start(0.1)
-
-    def deactivate(self):
-
-        self.record_timer.stop()
-        if self.writer is not None:
-            self.writer.close()
-        self.set_icon(RECORD_START_ICON)
-
-    def set_icon(self, icon):
-        self.viewer.toolbar.actions[self.tool_id].setIcon(QtGui.QIcon(icon))
-
-    def record(self, event):
-        im = self.viewer._vispy_widget.canvas.render()
-        self.writer.append_data(im)
-
-
 @viewer_tool
 class RotateTool(CheckableTool):
 

glue_vispy_viewers/common/vispy_data_viewer.py

@@ -15,14 +15,6 @@ class BaseVispyViewerMixin:
 
     tools = ['vispy:reset', 'vispy:rotate']
 
-    # If imageio is available, we can add the record icon
-    try:
-        import imageio  # noqa
-    except ImportError:
-        pass
-    else:
-        tools.insert(1, 'vispy:record')
-
     def setup_widget_and_callbacks(self):
 
         self._vispy_widget = VispyWidgetHelper(viewer_state=self.state)

glue_vispy_viewers/conftest.py

@@ -13,6 +13,13 @@
 else:
     GLUEQT_INSTALLED = True
 
+try:
+    import glue_jupyter  # noqa
+except ImportError:
+    GLUEJUPYTER_INSTALLED = False
+else:
+    GLUEJUPYTER_INSTALLED = True
+
 try:
     import objgraph
 except ImportError:
@@ -44,8 +51,11 @@ def pytest_unconfigure(config):
 
 
 def pytest_ignore_collect(collection_path, path, config):
-    if path.isdir() and "qt" in collection_path.parts:
-        return not GLUEQT_INSTALLED
+    if path.isdir():
+        if "qt" in collection_path.parts:
+            return not GLUEQT_INSTALLED
+        if "jupyter" in collection_path.parts:
+            return not GLUEJUPYTER_INSTALLED
 
 
 def pytest_runtest_setup(item):

glue_vispy_viewers/scatter/jupyter/scatter_viewer.py

@@ -16,7 +16,7 @@ class JupyterVispyScatterViewer(VispyScatterViewerMixin, IPyWidgetView):
 
     def __init__(self, *args, **kwargs):
         # Vispy and jupyter_rfb don't work correctly on Linux unless DISPLAY is set
-        if 'DISPLAY' not in os:
+        if 'DISPLAY' not in os.environ:
             os.environ['DISPLAY'] = ':0'
         super().__init__(*args, **kwargs)
         self.setup_widget_and_callbacks()

glue_vispy_viewers/scatter/jupyter/tests/test_viewer.py

@@ -0,0 +1,10 @@
+from glue.core import Data
+from glue_jupyter import jglue
+from ..scatter_viewer import JupyterVispyScatterViewer
+
+
+def test_basic_jupyter_scatter3d():
+    app = jglue()
+    data = Data(x=[1, 2, 3], y=[2, 3, 4], z=[5, 6, 7], label="xyz data")
+    app.add_data(data)
+    app.new_data_viewer(JupyterVispyScatterViewer, data=data)

glue_vispy_viewers/volume/jupyter/tests/test_viewer.py

@@ -0,0 +1,11 @@
+import numpy as np
+from glue.core import Data
+from glue_jupyter import jglue
+from ..volume_viewer import JupyterVispyVolumeViewer
+
+
+def test_basic_jupyter_volume():
+    app = jglue()
+    data = Data(x=np.arange(24).reshape((2, 3, 4)), label="cube data")
+    app.add_data(data)
+    app.new_data_viewer(JupyterVispyVolumeViewer, data=data)

glue_vispy_viewers/volume/jupyter/volume_viewer.py

@@ -15,7 +15,7 @@ class JupyterVispyVolumeViewer(VispyVolumeViewerMixin, IPyWidgetView):
 
     def __init__(self, *args, **kwargs):
         # Vispy and jupyter_rfb don't work correctly on Linux unless DISPLAY is set
-        if 'DISPLAY' not in os:
+        if 'DISPLAY' not in os.environ:
             os.environ['DISPLAY'] = ':0'
         super().__init__(*args, **kwargs)
         self.setup_widget_and_callbacks()

setup.cfg

@@ -42,6 +42,8 @@ pyside =
     qtpy
     glue-qt>=0.1.0
     PySide6
+jupyter =
+    glue-jupyter
 all =
     imageio
 
@@ -50,6 +52,8 @@ glue_vispy_viewers.common = *.png
 glue_vispy_viewers.common.qt = *.ui
 glue_vispy_viewers.scatter.qt = *.ui
 glue_vispy_viewers.volume.qt = *.ui
+glue_vispy_viewers.scatter.jupyter = *.vue
+glue_vispy_viewers.volume.jupyter = *.vue
 glue_vispy_viewers.qt.tests = data/*.glu
 glue_vispy_viewers.extern = README.md, VISPY_LICENSE
 glue_vispy_viewers.extern.vispy = io/_data/*.npy, html/static/js/*.js, app/tests/*.ui

tox.ini

@@ -1,6 +1,6 @@
 [tox]
 envlist =
-    py{38,39,310,311}-{test}-{dev}{,pyqt63,pyside63,pyqt64,pyside64}
+    py{38,39,310,311}-{test}-{dev}{,pyqt63,pyside63,pyqt64,pyside64,jupyter}
     codestyle
 requires = pip >= 18.0
            setuptools >= 30.3.0
@@ -22,6 +22,7 @@ extras =
     test: test
     pyqt63,pyqt64: pyqt
     pyside63,pyside64: pyside
+    jupyter: jupyter
 commands =
     test: pip freeze
     test: pytest --pyargs glue_vispy_viewers --cov glue_vispy_viewers {posargs}