Added state patch for translating Qt sessions to Jupyter sessions, add test and fix translation for basic plots

Author: astrofrog

glue_jupyter/app.py

@@ -641,11 +641,17 @@ def restore_session(path):
         finally:
             os.chdir(start_dir)
 
+    def __gluestate__(self, context):
+        viewers = [context.id(v) for v in self.viewers]
+        data = self.session.data_collection
+        from glue.main import _loaded_plugins
+        return dict(session=context.id(self.session), viewers=viewers,
+                    data=context.id(data), plugins=_loaded_plugins)
+
     @classmethod
     def __setgluestate__(cls, rec, context):
         self = super(JupyterApplication, cls).__setgluestate__(rec, context)
-        for tab in rec['viewers']:
-            for v in tab:
-                viewer = context.object(v)
-                self._viewer_refs.append(weakref.ref(viewer))
+        for v in rec['viewers']:
+            viewer = context.object(v)
+            self._viewer_refs.append(weakref.ref(viewer))
         return self

glue_jupyter/bqplot/histogram/tests/test_viewer.py

@@ -1,5 +1,6 @@
 from itertools import permutations, product
 from glue.core.subset import SubsetState
+from glue.core.tests.test_state import clone
 
 
 def test_non_hex_colors(app, dataxyz):
@@ -66,3 +67,13 @@ def test_zorder(app, data_volume, dataxz, dataxyz):
         vol.state.zorder, xz.state.zorder, xyz.state.zorder = p
         it = iter(s.figure.marks)
         assert all(layer.bars in it for layer in s.layers)
+
+
+def test_session(app, dataxz, dataxyz):
+
+    # Test that the viewer can be saved and restored from a session file
+
+    v = app.histogram1d(data=dataxyz)
+    v.add_data(dataxz)
+    app.data_collection.new_subset_group(subset_state=dataxz.id['x'] > 1, label='subset')
+    clone(app)

glue_jupyter/bqplot/image/state.py

@@ -33,8 +33,6 @@ class BqplotImageLayerState(ImageLayerState):
 
     def __init__(self, *args, **kwargs):
 
-        super(BqplotImageLayerState, self).__init__(*args, **kwargs)
-
         BqplotImageLayerState.level_mode.set_choices(self, ['Linear', 'Custom'])
         percentile_display = {100: 'Min/Max',
                               99.5: '99.5%',
@@ -46,6 +44,9 @@ def __init__(self, *args, **kwargs):
         BqplotImageLayerState.contour_percentile.set_choices(self, [100, 99.5, 99, 95, 90,
                                                                     'Custom'])
         BqplotImageLayerState.contour_percentile.set_display_func(self, percentile_display.get)
+
+        super(BqplotImageLayerState, self).__init__(*args, **kwargs)
+
         self.contour_lim_helper = StateAttributeLimitsHelper(self, attribute='attribute',
                                                              percentile='contour_percentile',
                                                              lower='c_min', upper='c_max')

glue_jupyter/bqplot/image/tests/test_viewer.py

@@ -1,4 +1,5 @@
 import glue_jupyter.state_traitlets_helpers
+from glue.core.tests.test_state import clone
 
 
 def test_non_hex_colors(app, data_image):
@@ -118,3 +119,11 @@ def test_add_markers_zoom(app, data_image, data_volume, dataxyz):
     assert im.state.x_max == 63.5
     assert im.state.y_min == -0.5
     assert im.state.y_max == 63.5
+
+
+def test_session(app, data_image):
+
+    # Test that the viewer can be saved and restored from a session file
+
+    v = app.imshow(data=data_image)
+    clone(app)

glue_jupyter/bqplot/image/viewer.py

@@ -34,9 +34,8 @@ class BqplotImageView(BqplotBaseView):
     tools = ['bqplot:home', 'bqplot:panzoom', 'bqplot:rectangle', 'bqplot:circle',
              'bqplot:ellipse', 'bqplot:polygon', 'bqplot:lasso']
 
-    def __init__(self, session):
-
-        super(BqplotImageView, self).__init__(session)
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
 
         self.shape = None
 

glue_jupyter/bqplot/profile/tests/test_viewer.py

@@ -12,6 +12,7 @@
 from glue.core.subset import AndState, InvertState, RangeSubsetState
 from glue.config import unit_converter, settings
 from glue.plugins.wcs_autolinking.wcs_autolinking import WCSLink
+from glue.core.tests.test_state import clone
 
 
 def setup_function(func):
@@ -238,3 +239,11 @@ def test_composite_yrange(app):
     assert isinstance(sbst.state1, RangeSubsetState)
     assert (isinstance(sbst.state2, InvertState) and
             isinstance(sbst.state2.state1, RangeSubsetState))
+
+
+def test_session(app, data_volume):
+
+    # Test that the viewer can be saved and restored from a session file
+
+    v = app.scatter2d(data=data_volume)
+    clone(app)

glue_jupyter/bqplot/scatter/tests/test_viewer.py

@@ -1,4 +1,5 @@
 from itertools import permutations
+from glue.core.tests.test_state import clone
 
 
 def test_scatter2d_nd(app, data_4d):
@@ -106,3 +107,11 @@ def test_incompatible_data(app):
 
     assert len(s.layers) == 1
     assert s.layers[0].enabled
+
+
+def test_session(app, dataxyz):
+
+    # Test that the viewer can be saved and restored from a session file
+
+    v = app.scatter2d(data=dataxyz)
+    clone(app)

glue_jupyter/session.py

@@ -0,0 +1,35 @@
+from itertools import chain
+from glue.config import session_patch
+from glue_jupyter.app import JupyterApplication
+
+TRANSLATION = {
+    "glue_qt.viewers.histogram.data_viewer.HistogramViewer": "glue_jupyter.bqplot.histogram.BqplotHistogramView",
+    "glue_qt.viewers.image.data_viewer.ImageViewer": "glue_jupyter.bqplot.image.BqplotImageView",
+    "glue_qt.viewers.profile.data_viewer.ProfileViewer": "glue_jupyter.bqplot.profile.BqplotProfileView",
+    "glue_qt.viewers.scatter.data_viewer.ScatterViewer": "glue_jupyter.bqplot.scatter.BqplotScatterView",
+    "glue.viewers.image.layer_artist.ImageLayerArtist": "glue_jupyter.bqplot.image.BqplotImageLayerArtist",
+    "glue.viewers.image.layer_artist.ImageSubsetLayerArtist": "glue_jupyter.bqplot.image.BqplotImageSubsetLayerArtist",
+    "glue_qt.viewers.profile.layer_artist.QThreadedProfileLayerArtist": "glue_jupyter.bqplot.profile.BqplotProfileLayerArtist",
+    "glue_qt.viewers.histogram.layer_artist.QThreadedHistogramLayerArtist": "glue_jupyter.bqplot.histogram.BqplotHistogramLayerArtist",
+    "glue.viewers.scatter.layer_artist.ScatterLayerArtist": "glue_jupyter.bqplot.scatter.BqplotScatterLayerArtist",
+    "glue.viewers.image.state.ImageLayerState": "glue_jupyter.bqplot.image.state.BqplotImageLayerState",
+    "glue.viewers.image.state.ImageViewerState": "glue_jupyter.bqplot.image.state.BqplotImageViewerState",
+}
+
+
+@session_patch()
+def translate_qt_to_jupyter_session(session):
+
+    session["__main__"]["_type"] = "glue_jupyter.app.JupyterApplication"
+    session["__main__"]["viewers"] = list(chain(*session["__main__"]["viewers"]))
+
+    for key in session:
+        original_type = session[key]["_type"]
+        if original_type in TRANSLATION:
+            session[key]["_type"] = TRANSLATION[original_type]
+
+        if "layers" in session[key]:
+            layers = session[key]["layers"]
+            for layer in layers:
+                if layer["_type"] in TRANSLATION:
+                    layer["_type"] = TRANSLATION[layer["_type"]]