Fix for GH1072. Empty array properties are replaced during update

Author: jonmmease

plotly/basedatatypes.py

@@ -378,7 +378,16 @@ def update(self, dict1=None, **kwargs):
             for d in [dict1, kwargs]:
                 if d:
                     for k, v in d.items():
-                        BaseFigure._perform_update(self[k], v)
+                        if self[k] == ():
+                            # existing data or frames property is empty
+                            # In this case we accept the v as is.
+                            if k == 'data':
+                                self.add_traces(v)
+                            else:
+                                # Accept v
+                                self[k] = v
+                        else:
+                            BaseFigure._perform_update(self[k], v)
 
         return self
 
@@ -1059,11 +1068,6 @@ def add_traces(self, data, rows=None, cols=None):
         ...                 rows=[1, 2], cols=[1, 1])
         """
 
-        if self._in_batch_mode:
-            self._batch_layout_edits.clear()
-            self._batch_trace_edits.clear()
-            raise ValueError('Traces may not be added in a batch context')
-
         # Validate traces
         data = self._data_validator.validate_coerce(data)
 
@@ -2133,8 +2137,15 @@ def _perform_update(plotly_obj, update_obj):
                     BaseFigure._perform_update(
                         plotly_obj[key], val)
                 elif isinstance(validator, CompoundArrayValidator):
-                    BaseFigure._perform_update(
-                        plotly_obj[key], val)
+                    if plotly_obj[key]:
+                        # plotly_obj has an existing non-empty array for key
+                        # In this case we merge val into the existing elements
+                        BaseFigure._perform_update(
+                            plotly_obj[key], val)
+                    else:
+                        # plotly_obj is an empty or uninitialized list for key
+                        # In this case we accept val as is
+                        plotly_obj[key] = val
                 else:
                     # Assign non-compound value
                     plotly_obj[key] = val

plotly/tests/test_core/test_graph_objs/test_figure_properties.py

@@ -2,8 +2,10 @@
 import plotly.graph_objs as go
 from nose.tools import raises
 
+from plotly.tests.test_optional.optional_utils import NumpyTestUtilsMixin
 
-class TestFigureProperties(TestCase):
+
+class TestFigureProperties(TestCase, NumpyTestUtilsMixin):
 
     def setUp(self):
         # Construct initial scatter object
@@ -121,6 +123,28 @@ def test_update_data(self):
         self.figure.update({'data': {0: {'marker': {'color': 'yellow'}}}})
         self.assertEqual(self.figure.data[0].marker.color, 'yellow')
 
+    def test_update_data_empty(self):
+        # Create figure with empty data (no traces)
+        figure = go.Figure(layout={'width': 1000})
+
+        # Update data with new traces
+        figure.update(data=[go.Scatter(y=[2, 1, 3]), go.Bar(y=[1, 2, 3])])
+
+        # Build expected dict
+        expected = {
+            'data': [{'y': [2, 1, 3], 'type': 'scatter'},
+                     {'y': [1, 2, 3], 'type': 'bar'}],
+            'layout': {'width': 1000}
+        }
+
+        # Compute expected figure dict (pop uids for comparison)
+        result = figure.to_dict()
+        del result['data'][0]['uid']
+        del result['data'][1]['uid']
+
+        # Perform comparison
+        self.assertEqual(result, expected)
+
     def test_update_frames(self):
         # Check initial frame axis title
         self.assertEqual(self.figure.frames[0].layout.yaxis.title, 'f1')

plotly/tests/test_core/test_graph_objs/test_update.py

@@ -1,60 +1,123 @@
 from __future__ import absolute_import
 from unittest import skip
 
+import plotly.graph_objs as go
 from plotly.graph_objs import Data, Figure, Layout, Line, Scatter, scatter, XAxis
 from plotly.tests.utils import strip_dict_params
 
+from unittest import TestCase
 
-def test_update_dict():
-    title = 'this'
-    fig = Figure()
-    fig.update(layout=Layout(title=title))
-    assert fig == Figure(layout=Layout(title=title))
-    fig['layout'].update(xaxis=XAxis())
-    assert fig == Figure(layout=Layout(title=title, xaxis=XAxis()))
-
-
-def test_update_list():
-    trace1 = Scatter(x=[1, 2, 3], y=[2, 1, 2])
-    trace2 = Scatter(x=[1, 2, 3], y=[3, 2, 1])
-    fig = Figure([trace1, trace2])
-    update = dict(x=[2, 3, 4], y=[1, 2, 3])
-    fig.data[0].update(update)
-    fig.data[1].update(update)
-
-    d1, d2 = strip_dict_params(fig.data[0], Scatter(x=[2, 3, 4], y=[1, 2, 3]))
-    assert d1 == d2
-    d1, d2 = strip_dict_params(fig.data[1], Scatter(x=[2, 3, 4], y=[1, 2, 3]))
-    assert d1 == d2
-
-
-def test_update_dict_empty():
-    trace1 = Scatter(x=[1, 2, 3], y=[2, 1, 2])
-    trace2 = Scatter(x=[1, 2, 3], y=[3, 2, 1])
-    fig = Figure([trace1, trace2])
-    fig.update({})
-    d1, d2 = strip_dict_params(fig.data[0], Scatter(x=[1, 2, 3], y=[2, 1, 2]))
-    assert d1 == d2
-    d1, d2 = strip_dict_params(fig.data[1], Scatter(x=[1, 2, 3], y=[3, 2, 1]))
-    assert d1 == d2
-
-
-def test_update_list_empty():
-    trace1 = Scatter(x=[1, 2, 3], y=[2, 1, 2])
-    trace2 = Scatter(x=[1, 2, 3], y=[3, 2, 1])
-    fig = Figure([trace1, trace2])
-    fig.update([])
-    d1, d2 = strip_dict_params(fig.data[0], Scatter(x=[1, 2, 3], y=[2, 1, 2]))
-    assert d1 == d2
-    d1, d2 = strip_dict_params(fig.data[1], Scatter(x=[1, 2, 3], y=[3, 2, 1]))
-    assert d1 == d2
-
-
-@skip('See https://github.com/plotly/python-api/issues/291')
-def test_update_list_make_copies_false():
-    trace1 = Scatter(x=[1, 2, 3], y=[2, 1, 2])
-    trace2 = Scatter(x=[1, 2, 3], y=[3, 2, 1])
-    data = Data([trace1, trace2])
-    update = dict(x=[2, 3, 4], y=[1, 2, 3], line=Line())
-    data.update(update, make_copies=False)
-    assert data[0]['line'] is data[1]['line']
+
+class TestUpdateMethod(TestCase):
+    def setUp(self):
+        print('Setup!')
+
+    def test_update_dict(self):
+        title = 'this'
+        fig = Figure()
+        fig.update(layout=Layout(title=title))
+        assert fig == Figure(layout=Layout(title=title))
+        fig['layout'].update(xaxis=XAxis())
+        assert fig == Figure(layout=Layout(title=title, xaxis=XAxis()))
+
+
+    def test_update_list(self):
+        trace1 = Scatter(x=[1, 2, 3], y=[2, 1, 2])
+        trace2 = Scatter(x=[1, 2, 3], y=[3, 2, 1])
+        fig = Figure([trace1, trace2])
+        update = dict(x=[2, 3, 4], y=[1, 2, 3])
+        fig.data[0].update(update)
+        fig.data[1].update(update)
+
+        d1, d2 = strip_dict_params(fig.data[0], Scatter(x=[2, 3, 4], y=[1, 2, 3]))
+        assert d1 == d2
+        d1, d2 = strip_dict_params(fig.data[1], Scatter(x=[2, 3, 4], y=[1, 2, 3]))
+        assert d1 == d2
+
+
+    def test_update_dict_empty(self):
+        trace1 = Scatter(x=[1, 2, 3], y=[2, 1, 2])
+        trace2 = Scatter(x=[1, 2, 3], y=[3, 2, 1])
+        fig = Figure([trace1, trace2])
+        fig.update({})
+        d1, d2 = strip_dict_params(fig.data[0], Scatter(x=[1, 2, 3], y=[2, 1, 2]))
+        assert d1 == d2
+        d1, d2 = strip_dict_params(fig.data[1], Scatter(x=[1, 2, 3], y=[3, 2, 1]))
+        assert d1 == d2
+
+
+    def test_update_list_empty(self):
+        trace1 = Scatter(x=[1, 2, 3], y=[2, 1, 2])
+        trace2 = Scatter(x=[1, 2, 3], y=[3, 2, 1])
+        fig = Figure([trace1, trace2])
+        fig.update([])
+        d1, d2 = strip_dict_params(fig.data[0], Scatter(x=[1, 2, 3], y=[2, 1, 2]))
+        assert d1 == d2
+        d1, d2 = strip_dict_params(fig.data[1], Scatter(x=[1, 2, 3], y=[3, 2, 1]))
+        assert d1 == d2
+
+
+    @skip('See https://github.com/plotly/python-api/issues/291')
+    def test_update_list_make_copies_false(self):
+        trace1 = Scatter(x=[1, 2, 3], y=[2, 1, 2])
+        trace2 = Scatter(x=[1, 2, 3], y=[3, 2, 1])
+        data = Data([trace1, trace2])
+        update = dict(x=[2, 3, 4], y=[1, 2, 3], line=Line())
+        data.update(update, make_copies=False)
+        assert data[0]['line'] is data[1]['line']
+
+    def test_update_uninitialized_list_with_list(self):
+        """
+        If the original list is undefined, the updated list should be
+        accepted in full.
+
+        See GH1072
+        """
+        layout = go.Layout()
+        layout.update(annotations=[
+            go.layout.Annotation(text='one'),
+            go.layout.Annotation(text='two'),
+        ])
+
+        expected = {'annotations': [{'text': 'one'}, {'text': 'two'}]}
+
+        self.assertEqual(len(layout.annotations), 2)
+        self.assertEqual(layout.to_plotly_json(), expected)
+
+    def test_update_initialized_empty_list_with_list(self):
+        """
+        If the original list is empty, treat is just as if it's undefined.
+        This is a change in behavior from version 2
+        (where the input list would just be completly ignored), because
+        in version 3 the difference between an uninitialized and empty list
+        is not obvious to the user.
+        """
+        layout = go.Layout(annotations=[])
+        layout.update(annotations=[
+            go.layout.Annotation(text='one'),
+            go.layout.Annotation(text='two'),
+        ])
+
+        expected = {'annotations': [{'text': 'one'}, {'text': 'two'}]}
+
+        self.assertEqual(len(layout.annotations), 2)
+        self.assertEqual(layout.to_plotly_json(), expected)
+
+    def test_update_initialized_nonempty_list_with_dict(self):
+        """
+        If the original list is defined, a dict from
+        index numbers to property dicts may be used to update select
+        elements of the existing list
+        """
+        layout = go.Layout(annotations=[
+            go.layout.Annotation(text='one'),
+            go.layout.Annotation(text='two'),
+        ])
+
+        layout.update(annotations={1: go.layout.Annotation(width=30)})
+
+        expected = {'annotations': [{'text': 'one'},
+                                    {'text': 'two', 'width': 30}]}
+
+        self.assertEqual(len(layout.annotations), 2)
+        self.assertEqual(layout.to_plotly_json(), expected)