Don't error when a literal property is set to it's correct value.

This avoids errors when performing updates like figure.update(data=[go.Scatter(...), ...])

Author: jonmmease

_plotly_utils/basevalidators.py

@@ -1658,16 +1658,21 @@ class LiteralValidator(BaseValidator):
     """
     Validator for readonly literal values
     """
-    def __init__(self, plotly_name, parent_name, **kwargs):
-        super(LiteralValidator, self).__init__(plotly_name=plotly_name,
-                         parent_name=parent_name,
-                         **kwargs)
+    def __init__(self, plotly_name, parent_name, val, **kwargs):
+        super(LiteralValidator, self).__init__(
+            plotly_name=plotly_name,
+            parent_name=parent_name,
+            **kwargs)
+        self.val = val
 
     def validate_coerce(self, v):
-        raise ValueError("""\
-The '{plotly_name}' property of {parent_name} is read-only""".format(
-            plotly_name=self.plotly_name, parent_name=self.parent_name
-        ))
+        if v != self.val:
+            raise ValueError("""\
+    The '{plotly_name}' property of {parent_name} is read-only""".format(
+                plotly_name=self.plotly_name, parent_name=self.parent_name
+            ))
+        else:
+            return v
 
 
 class ImageUriValidator(BaseValidator):

_plotly_utils/tests/validators/test_literal_validator.py

@@ -0,0 +1,28 @@
+import pytest
+from _plotly_utils.basevalidators import LiteralValidator
+import numpy as np
+
+
+# Fixtures
+# --------
+@pytest.fixture()
+def validator():
+    return LiteralValidator('prop', 'parent', 'scatter')
+
+
+# Tests
+# -----
+# ### Acceptance ###
+@pytest.mark.parametrize('val', ['scatter'])
+def test_acceptance(val, validator):
+    assert validator.validate_coerce(val) is val
+
+
+# ### Test rejection ###
+@pytest.mark.parametrize('val',
+                         ['hello', (), [], [1, 2, 3], set(), '34'])
+def test_rejection(val, validator):
+    with pytest.raises(ValueError) as validation_failure:
+        validator.validate_coerce(val)
+
+    assert 'read-only' in str(validation_failure.value)

codegen/datatypes.py

@@ -254,11 +254,12 @@ def __init__(self""")
         for literal_node in literal_nodes:
             lit_name = literal_node.name_property
             lit_parent = literal_node.parent_path_str
-            lit_val = literal_node.node_data
+            lit_val = repr(literal_node.node_data)
             buffer.write(f"""
-        self._props['{lit_name}'] = '{lit_val}'
+        self._props['{lit_name}'] = {lit_val}
         self._validators['{lit_name}'] =\
-LiteralValidator(plotly_name='{lit_name}', parent_name='{lit_parent}')""")
+LiteralValidator(plotly_name='{lit_name}',\
+    parent_name='{lit_parent}', val={lit_val})""")
 
     buffer.write(f"""
     

codegen/utils.py

@@ -423,6 +423,8 @@ def get_validator_params(self):
                 if colorscale_node_list:
                     colorscale_path = colorscale_node_list[0].path_str
                     params['colorscale_path'] = repr(colorscale_path)
+            elif self.datatype == 'literal':
+                params['val'] = self.node_data
 
         return params
 

plotly/graph_objs/_area.py

@@ -785,7 +785,7 @@ def __init__(
         from _plotly_utils.basevalidators import LiteralValidator
         self._props['type'] = 'area'
         self._validators['type'] = LiteralValidator(
-            plotly_name='type', parent_name='area'
+            plotly_name='type', parent_name='area', val='area'
         )
 
         # Process unknown kwargs

plotly/graph_objs/_bar.py

@@ -2172,7 +2172,7 @@ def __init__(
         from _plotly_utils.basevalidators import LiteralValidator
         self._props['type'] = 'bar'
         self._validators['type'] = LiteralValidator(
-            plotly_name='type', parent_name='bar'
+            plotly_name='type', parent_name='bar', val='bar'
         )
 
         # Process unknown kwargs

plotly/graph_objs/_box.py

@@ -1574,7 +1574,7 @@ def __init__(
         from _plotly_utils.basevalidators import LiteralValidator
         self._props['type'] = 'box'
         self._validators['type'] = LiteralValidator(
-            plotly_name='type', parent_name='box'
+            plotly_name='type', parent_name='box', val='box'
         )
 
         # Process unknown kwargs

plotly/graph_objs/_candlestick.py

@@ -1234,7 +1234,7 @@ def __init__(
         from _plotly_utils.basevalidators import LiteralValidator
         self._props['type'] = 'candlestick'
         self._validators['type'] = LiteralValidator(
-            plotly_name='type', parent_name='candlestick'
+            plotly_name='type', parent_name='candlestick', val='candlestick'
         )
 
         # Process unknown kwargs

plotly/graph_objs/_carpet.py

@@ -1712,7 +1712,7 @@ def __init__(
         from _plotly_utils.basevalidators import LiteralValidator
         self._props['type'] = 'carpet'
         self._validators['type'] = LiteralValidator(
-            plotly_name='type', parent_name='carpet'
+            plotly_name='type', parent_name='carpet', val='carpet'
         )
 
         # Process unknown kwargs

plotly/graph_objs/_choropleth.py

@@ -1478,7 +1478,7 @@ def __init__(
         from _plotly_utils.basevalidators import LiteralValidator
         self._props['type'] = 'choropleth'
         self._validators['type'] = LiteralValidator(
-            plotly_name='type', parent_name='choropleth'
+            plotly_name='type', parent_name='choropleth', val='choropleth'
         )
 
         # Process unknown kwargs