Merge pull request #4727 from plotly/add-skipped-key-tests

Add tests for the keys that should be skipped in base64 conversion

Author: marthacryan

packages/python/plotly/_plotly_utils/basevalidators.py

@@ -1,6 +1,7 @@
 import base64
 import numbers
 import textwrap
+import traceback
 import uuid
 from importlib import import_module
 import copy
@@ -291,6 +292,15 @@ def is_typed_array_spec(v):
     return isinstance(v, dict) and "bdata" in v and "dtype" in v
 
 
+def has_skipped_key(all_parent_keys):
+    """
+    Return whether any keys in the parent hierarchy are in the list of keys that
+    are skipped for conversion to the typed array spec
+    """
+    skipped_keys = ["geojson", "layer", "range"]
+    return any(skipped_key in all_parent_keys for skipped_key in skipped_keys)
+
+
 def is_none_or_typed_array_spec(v):
     return v is None or is_typed_array_spec(v)
 
@@ -488,9 +498,10 @@ def description(self):
         )
 
     def validate_coerce(self, v):
-
         if is_none_or_typed_array_spec(v):
             pass
+        elif has_skipped_key(self.parent_name):
+            v = to_scalar_or_list(v)
         elif is_homogeneous_array(v):
             v = to_typed_array_spec(v)
         elif is_simple_array(v):

packages/python/plotly/plotly/tests/test_optional/test_graph_objs/test_skipped_b64_keys.py

@@ -0,0 +1,85 @@
+from unittest import TestCase
+import numpy as np
+from plotly.tests.test_optional.optional_utils import NumpyTestUtilsMixin
+import plotly.graph_objs as go
+
+
+class TestShouldNotUseBase64InUnsupportedKeys(NumpyTestUtilsMixin, TestCase):
+    def test_np_geojson(self):
+        normal_coordinates = [
+            [
+                [-87, 35],
+                [-87, 30],
+                [-85, 30],
+                [-85, 35],
+            ]
+        ]
+
+        numpy_coordinates = np.array(normal_coordinates)
+
+        data = [
+            {
+                "type": "choropleth",
+                "locations": ["AL"],
+                "featureidkey": "properties.id",
+                "z": np.array([10]),
+                "geojson": {
+                    "type": "Feature",
+                    "properties": {"id": "AL"},
+                    "geometry": {"type": "Polygon", "coordinates": numpy_coordinates},
+                },
+            }
+        ]
+
+        fig = go.Figure(data=data)
+
+        assert (
+            fig["data"][0]["geojson"]["geometry"]["coordinates"] == normal_coordinates
+        ).all()
+
+    def test_np_layers(self):
+        layout = {
+            "mapbox": {
+                "layers": [
+                    {
+                        "sourcetype": "geojson",
+                        "type": "line",
+                        "line": {"dash": np.array([2.5, 1])},
+                        "source": {
+                            "type": "FeatureCollection",
+                            "features": [
+                                {
+                                    "type": "Feature",
+                                    "geometry": {
+                                        "type": "LineString",
+                                        "coordinates": np.array(
+                                            [[0.25, 52], [0.75, 50]]
+                                        ),
+                                    },
+                                }
+                            ],
+                        },
+                    },
+                ],
+                "center": {"lon": 0.5, "lat": 51},
+            },
+        }
+        data = [{"type": "scattermapbox"}]
+
+        fig = go.Figure(data=data, layout=layout)
+
+        assert fig.layout["mapbox"]["layers"][0]["line"]["dash"] == (2.5, 1)
+
+        assert (
+            fig.layout["mapbox"]["layers"][0]["source"]["features"][0]["geometry"][
+                "coordinates"
+            ]
+            == [[0.25, 52], [0.75, 50]]
+        ).all()
+
+    def test_np_range(self):
+        layout = {"xaxis": {"range": np.array([0, 1])}}
+
+        fig = go.Figure(data=[{"type": "scatter"}], layout=layout)
+
+        assert fig.layout["xaxis"]["range"] == (0, 1)