Merge branch 'ipyplotly_integration' of https://github.com/plotly/plotly.py into ipyplotly_integration

Author: Kully

plotly/basedatatypes.py

@@ -517,7 +517,7 @@ def data(self, new_data):
 
     # Restyle
     # -------
-    def _plotly_restyle(self, restyle_data, trace_indexes=None, **kwargs):
+    def plotly_restyle(self, restyle_data, trace_indexes=None, **kwargs):
         """
         Perform a Plotly restyle operation on the figure's traces
 
@@ -543,7 +543,7 @@ def _plotly_restyle(self, restyle_data, trace_indexes=None, **kwargs):
             example, the following command would be used to update the 'x'
             property of the first trace to the list [1, 2, 3]
 
-            >>> fig._plotly_restyle({'x': [[1, 2, 3]]}, 0)
+            >>> fig.plotly_restyle({'x': [[1, 2, 3]]}, 0)
 
         trace_indexes : int or list of int
             Trace index, or list of trace indexes, that the restyle operation
@@ -552,18 +552,6 @@ def _plotly_restyle(self, restyle_data, trace_indexes=None, **kwargs):
         Returns
         -------
         None
-
-        Notes
-        -----
-        This method is does not create new graph_obj objects in the figure
-        hierarchy. Some things that can go wrong...
-
-          1) ``_plotly_restyle({'dimensions[2].values': [0, 1, 2]})``
-          For a ``parcoords`` trace that has not been intialized with at
-          least 3 dimensions.
-
-        This isn't a problem for style operations originating from the
-        front-end, but should be addressed before making this method public.
         """
 
         # Normalize trace indexes
@@ -581,15 +569,20 @@ def _plotly_restyle(self, restyle_data, trace_indexes=None, **kwargs):
 
         # Perform restyle on trace dicts
         # ------------------------------
-        restyle_changes = self._perform_plotly_restyle(restyle_data, trace_indexes)
+        restyle_changes = self._perform_plotly_restyle(restyle_data,
+                                                       trace_indexes)
         if restyle_changes:
             # The restyle operation resulted in a change to some trace
             # properties, so we dispatch change callbacks and send the
             # restyle message to the frontend (if any)
+            msg_kwargs = ({'source_view_id': source_view_id}
+                          if source_view_id is not None
+                          else {})
+
             self._send_restyle_msg(
                 restyle_changes,
                 trace_indexes=trace_indexes,
-                source_view_id=source_view_id)
+                **msg_kwargs)
 
             self._dispatch_trace_change_callbacks(
                 restyle_changes, trace_indexes)
@@ -633,17 +626,29 @@ def _perform_plotly_restyle(self, restyle_data, trace_indexes):
                 # Get new value for this particular trace
                 trace_v = v[i % len(v)] if isinstance(v, list) else v
 
-                # Apply set operation for this trace and thist value
-                val_changed = BaseFigure._set_in(self._data[trace_ind],
-                                                 key_path_str,
-                                                 trace_v)
+                if trace_v is not Undefined:
+
+                    # Get trace being updated
+                    trace_obj = self.data[trace_ind]
+
+                    # Validate key_path_str
+                    if not BaseFigure._is_key_path_compatible(
+                            key_path_str, trace_obj):
 
-                # Update any_vals_changed status
-                any_vals_changed = (any_vals_changed or val_changed)
+                        trace_class = trace_obj.__class__.__name__
+                        raise ValueError("""
+Invalid property path '{key_path_str}' for trace class {trace_class}
+""".format(key_path_str=key_path_str, trace_class=trace_class))
+
+                    # Apply set operation for this trace and thist value
+                    val_changed = BaseFigure._set_in(self._data[trace_ind],
+                                                     key_path_str,
+                                                     trace_v)
+
+                    # Update any_vals_changed status
+                    any_vals_changed = (any_vals_changed or val_changed)
 
             if any_vals_changed:
-                # At lease one of the values for one of the traces has
-                # changed for the current key_path_str.
                 restyle_changes[key_path_str] = v
 
         return restyle_changes
@@ -1308,7 +1313,7 @@ def layout(self, new_layout):
         # Notify JS side
         self._send_relayout_msg(new_layout_data)
 
-    def _plotly_relayout(self, relayout_data, **kwargs):
+    def plotly_relayout(self, relayout_data, **kwargs):
         """
         Perform a Plotly relayout operation on the figure's layout
 
@@ -1326,21 +1331,6 @@ def _plotly_relayout(self, relayout_data, **kwargs):
         Returns
         -------
         None
-
-        Notes
-        -----
-        This method is does not create new graph_obj objects in the figure
-        hierarchy. Some things that can go wrong...
-
-          1) ``_plotly_relayout({'xaxis2.range': [0, 1]})``
-          If xaxis2 has not been initialized
-
-          2) ``_plotly_relayout({'images[2].source': 'http://...'})``
-          If the images array has not been initialized with at least 3
-          elements
-
-        This isn't a problem for relayout operations originating from the
-        front-end, but should be addressed before making this method public.
         """
 
         # Handle source_view_id
@@ -1393,15 +1383,43 @@ def _perform_plotly_relayout(self, relayout_data):
         # ----------------
         for key_path_str, v in relayout_data.items():
 
+            if not BaseFigure._is_key_path_compatible(
+                    key_path_str, self.layout):
+
+                raise ValueError("""
+Invalid property path '{key_path_str}' for layout
+""".format(key_path_str=key_path_str))
+
             # Apply set operation on the layout dict
             val_changed = BaseFigure._set_in(self._layout, key_path_str, v)
 
             if val_changed:
-                # Save operation to changed dict
                 relayout_changes[key_path_str] = v
 
         return relayout_changes
 
+    @staticmethod
+    def _is_key_path_compatible(key_path_str, plotly_obj):
+        """
+        Return whether the specifieid key path string is compatible with
+        the specified plotly object for the purpose of relayout/restyle
+        operation
+        """
+
+        # Convert string to tuple of path components
+        # e.g. 'foo[0].bar[1]' -> ('foo', 0, 'bar', 1)
+        key_path_tuple = BaseFigure._str_to_dict_path(key_path_str)
+
+        # Remove trailing integer component
+        # e.g. ('foo', 0, 'bar', 1) -> ('foo', 0, 'bar')
+        # We do this because it's fine for relayout/restyle to create new
+        # elements in the final array in the path.
+        if isinstance(key_path_tuple[-1], int):
+            key_path_tuple = key_path_tuple[:-1]
+
+        # Test whether modified key path tuple is in plotly_obj
+        return key_path_tuple in plotly_obj
+
     def _relayout_child(self, child, key_path_str, val):
         """
         Process relayout operation on child layout object
@@ -1583,11 +1601,11 @@ def frames(self, new_frames):
 
     # Update
     # ------
-    def _plotly_update(self,
-                       restyle_data=None,
-                       relayout_data=None,
-                       trace_indexes=None,
-                       **kwargs):
+    def plotly_update(self,
+                      restyle_data=None,
+                      relayout_data=None,
+                      trace_indexes=None,
+                      **kwargs):
         """
         Perform a Plotly update operation on the figure.
 
@@ -1609,12 +1627,6 @@ def _plotly_update(self,
         -------
         BaseFigure
             None
-
-        Notes
-        -----
-        This method is does not create new graph_obj objects in the figure
-        hierarchy. See notes for ``_plotly_relayout`` and
-        ``_plotly_restyle`` for examples.
         """
 
         # Handle source_view_id
@@ -1646,8 +1658,8 @@ def _plotly_update(self,
         # Send a plotly_update message to the frontend (if any)
         if restyle_changes or relayout_changes:
             self._send_update_msg(
-                style=restyle_changes,
-                layout=relayout_changes,
+                restyle_data=restyle_changes,
+                relayout_data=relayout_changes,
                 trace_indexes=trace_indexes,
                 **msg_kwargs)
 
@@ -1713,13 +1725,17 @@ def _send_relayout_msg(self, layout, source_view_id=None):
         pass
 
     def _send_update_msg(self,
-                         style,
-                         layout,
+                         restyle_data,
+                         relayout_data,
                          trace_indexes=None,
                          source_view_id=None):
         pass
 
-    def _send_animate_msg(self, styles, layout, trace_indexes, animation_opts):
+    def _send_animate_msg(self,
+                          styles_data,
+                          relayout_data,
+                          trace_indexes,
+                          animation_opts):
         pass
 
     # Context managers
@@ -1780,7 +1796,7 @@ def batch_update(self):
                  trace_indexes) = self._build_update_params_from_batch()
 
                 # ### Call plotly_update ###
-                self._plotly_update(
+                self.plotly_update(
                     restyle_data=restyle_data,
                     relayout_data=relayout_data,
                     trace_indexes=trace_indexes)
@@ -1974,8 +1990,8 @@ def _perform_batch_animate(self, animation_opts):
         # --------------------
         # Sends animate message to the front end (if any)
         self._send_animate_msg(
-            styles=list(animate_styles),
-            layout=animate_layout,
+            styles_data=list(animate_styles),
+            relayout_data=animate_layout,
             trace_indexes=list(animate_trace_indexes),
             animation_opts=animation_opts)
 
@@ -3193,6 +3209,16 @@ def on_change(self, callback, *args, append=False):
         None
         """
 
+        # Warn if object not descendent of a figure
+        # -----------------------------------------
+        if not self.figure:
+            class_name = self.__class__.__name__
+            msg = """
+{class_name} object is not a descendant of a Figure.
+on_change callbacks are not supported in this case.
+""".format(class_name=class_name)
+            raise ValueError(msg)
+
         # Validate args not empty
         # -----------------------
         if len(args) == 0:

plotly/basewidget.py

@@ -751,9 +751,9 @@ def _handler_js2py_restyle(self, change):
 
         # Perform restyle
         # ---------------
-        self._plotly_restyle(restyle_data=style_data,
-                             trace_indexes=style_traces,
-                             source_view_id=source_view_id)
+        self.plotly_restyle(restyle_data=style_data,
+                            trace_indexes=style_traces,
+                            source_view_id=source_view_id)
 
     @observe('_js2py_update')
     def _handler_js2py_update(self, change):
@@ -775,9 +775,9 @@ def _handler_js2py_update(self, change):
 
         # Perform update
         # --------------
-        self._plotly_update(restyle_data=style, relayout_data=layout,
-                            trace_indexes=trace_indexes,
-                            source_view_id=source_view_id)
+        self.plotly_update(restyle_data=style, relayout_data=layout,
+                           trace_indexes=trace_indexes,
+                           source_view_id=source_view_id)
 
     @observe('_js2py_relayout')
     def _handler_js2py_relayout(self, change):
@@ -803,8 +803,8 @@ def _handler_js2py_relayout(self, change):
 
         # Perform relayout
         # ----------------
-        self._plotly_relayout(relayout_data=relayout_data,
-                              source_view_id=source_view_id)
+        self.plotly_relayout(relayout_data=relayout_data,
+                             source_view_id=source_view_id)
 
     @observe('_js2py_pointsCallback')
     def _handler_js2py_pointsCallback(self, change):

plotly/tests/test_core/test_figure_messages/test_batch_animate.py

@@ -47,8 +47,8 @@ def test_batch_animate(self):
 
         # Check that update message was sent
         self.figure._send_animate_msg.assert_called_once_with(
-            styles=[{'marker.color': 'yellow'}, {'marker.opacity': 0.9}],
-            layout={'xaxis.range': [10, 20]},
+            styles_data=[{'marker.color': 'yellow'}, {'marker.opacity': 0.9}],
+            relayout_data={'xaxis.range': [10, 20]},
             trace_indexes=[0, 1],
             animation_opts={'transition': {'easing': 'elastic',
                                            'duration': 1200},

plotly/tests/test_core/test_figure_messages/test_move_delete_traces.py

@@ -1,7 +1,7 @@
 from unittest import TestCase
 from mock import MagicMock
 import plotly.graph_objs as go
-
+from nose.tools import raises
 
 class TestMoveDeleteTracesMessages(TestCase):
     def setUp(self):
@@ -73,3 +73,17 @@ def test_move_and_delete_traces(self):
         self.figure._send_deleteTraces_msg.assert_called_once_with([1])
         self.figure._send_moveTraces_msg.assert_called_once_with(
             [0, 1], [1, 0])
+
+    @raises(ValueError)
+    def test_validate_assigned_traces_are_subset(self):
+        traces = self.figure.data
+        self.figure.data = [traces[2],
+                            go.Scatter(y=[3, 2, 1]),
+                            traces[1]]
+
+    @raises(ValueError)
+    def test_validate_assigned_traces_are_not_duplicates(self):
+        traces = self.figure.data
+        self.figure.data = [traces[2],
+                            traces[1],
+                            traces[1]]