Remove global go.validate object and replace with Figure-level validate property

Author: jonmmease

packages/python/plotly/_plotly_utils/basevalidators.py

@@ -2438,12 +2438,12 @@ def description(self):
 
         return desc
 
-    def validate_coerce(self, v, skip_invalid=False):
+    def validate_coerce(self, v, skip_invalid=False, validate=True):
         if v is None:
             v = self.data_class()
 
         elif isinstance(v, dict):
-            v = self.data_class(v, skip_invalid=skip_invalid)
+            v = self.data_class(v, skip_invalid=skip_invalid, validate=validate)
 
         elif isinstance(v, self.data_class):
             # Copy object
@@ -2614,7 +2614,7 @@ def get_trace_class(self, trace_name):
 
         return self._class_map[trace_name]
 
-    def validate_coerce(self, v, skip_invalid=False):
+    def validate_coerce(self, v, skip_invalid=False, validate=True):
         from plotly.basedatatypes import BaseTraceType
 
         # Import Histogram2dcontour, this is the deprecated name of the
@@ -2649,15 +2649,15 @@ def validate_coerce(self, v, skip_invalid=False):
                         if skip_invalid:
                             # Treat as scatter trace
                             trace = self.get_trace_class("scatter")(
-                                skip_invalid=skip_invalid, **v_copy
+                                skip_invalid=skip_invalid, validate=validate, **v_copy
                             )
                             res.append(trace)
                         else:
                             res.append(None)
                             invalid_els.append(v_el)
                     else:
                         trace = self.get_trace_class(trace_type)(
-                            skip_invalid=skip_invalid, **v_copy
+                            skip_invalid=skip_invalid, validate=validate, **v_copy
                         )
                         res.append(trace)
                 else:

packages/python/plotly/plotly/_validate.py

@@ -10,7 +10,6 @@
 from copy import deepcopy, copy
 
 from _plotly_utils.utils import _natural_sort_strings
-from plotly._validate import validate
 from .optional_imports import get_module
 
 # Create Undefined sentinel value
@@ -92,6 +91,9 @@ class is a subclass of both BaseFigure and widgets.DOMWidget.
 
         super(BaseFigure, self).__init__()
 
+        # Initialize validation
+        self._validate = kwargs.pop("validate", True)
+
         # Assign layout_plotly to layout
         # ------------------------------
         # See docstring note for explanation
@@ -140,7 +142,9 @@ class is a subclass of both BaseFigure and widgets.DOMWidget.
         self._data_validator = DataValidator(set_uid=self._set_trace_uid)
 
         # ### Import traces ###
-        data = self._data_validator.validate_coerce(data, skip_invalid=skip_invalid)
+        data = self._data_validator.validate_coerce(
+            data, skip_invalid=skip_invalid, validate=self._validate
+        )
 
         # ### Save tuple of trace objects ###
         self._data_objs = data
@@ -182,7 +186,7 @@ class is a subclass of both BaseFigure and widgets.DOMWidget.
 
         # ### Import Layout ###
         self._layout_obj = self._layout_validator.validate_coerce(
-            layout, skip_invalid=skip_invalid
+            layout, skip_invalid=skip_invalid, validate=self._validate
         )
 
         # ### Import clone of layout properties ###
@@ -314,6 +318,8 @@ def __setitem__(self, prop, value):
             for p in prop[:-1]:
                 res = res[p]
 
+            res._validate = self._validate
+
             res[prop[-1]] = value
 
     def __setattr__(self, prop, value):
@@ -1940,10 +1946,14 @@ def _initialize_layout_template(self):
 
         if self._layout_obj._props.get("template", None) is None:
             if pio.templates.default is not None:
-                with validate(False):
-                    # Assume default template is already validated
+                # Assume default template is already validated
+                self._layout_obj._validate = False
+                try:
                     template_dict = pio.templates[pio.templates.default]
                     self._layout_obj.template = template_dict
+                except Exception:
+                    self._layout_obj._validate = self._validate
+                    raise
 
     @property
     def layout(self):
@@ -3339,6 +3349,8 @@ def __init__(self, plotly_name, **kwargs):
         # invalid properties will result in an exception
         self._skip_invalid = False
 
+        self._validate = True
+
         # Validate inputs
         # ---------------
         self._process_kwargs(**kwargs)
@@ -3378,6 +3390,14 @@ def __init__(self, plotly_name, **kwargs):
         # ### Backing property for backward compatible _validator property ##
         self.__validators = None
 
+    # @property
+    # def _validate(self):
+    #     fig = self.figure
+    #     if fig is None:
+    #         return True
+    #     else:
+    #         return fig._validate
+
     def _get_validator(self, prop):
         from .validator_cache import ValidatorCache
 
@@ -3425,7 +3445,7 @@ def _process_kwargs(self, **kwargs):
             if k in self:
                 # e.g. underscore kwargs like marker_line_color
                 self[k] = v
-            elif not validate._should_validate:
+            elif not self._validate:
                 # Set extra property as-is
                 self[k] = v
             else:
@@ -3885,7 +3905,7 @@ def __setitem__(self, prop, value):
             # ### Unwrap scalar tuple ###
             prop = prop[0]
 
-            if validate._should_validate:
+            if self._validate:
                 if prop not in self._valid_props:
                     self._raise_on_invalid_property_error(prop)
 
@@ -3937,6 +3957,8 @@ def __setitem__(self, prop, value):
             for p in prop[:-1]:
                 res = res[p]
 
+            res._validate = self._validate
+
             res[prop[-1]] = value
 
     def __setattr__(self, prop, value):

packages/python/plotly/plotly/basedatatypes.py

@@ -88,7 +88,7 @@ def __getitem__(self, item):
                     )
                     template_str = pkgutil.get_data("plotly", path).decode("utf-8")
                     template_dict = json.loads(template_str)
-                    template = Template(template_dict)
+                    template = Template(template_dict, validate=False)
 
                     self._templates[template_name] = template
             templates.append(self._templates[template_name])

packages/python/plotly/plotly/io/_templates.py

@@ -5,7 +5,7 @@
 
 
 def build_invalid_fig():
-    return go.Figure(
+    return dict(
         data=[{"type": "bar", "y": "not_a_list", "bogus": 23}],
         layout_title_text="valid title",
         layout_colorway="not a dict",
@@ -20,29 +20,17 @@ def build_invalid_fig():
 
 def test_validate_false():
     template = pio.templates.default
-    should_validate = go.validate._should_validate
     try:
         pio.templates.default = None
 
         # Build figure with variety of invalid properties (both name and value),
         # make sure underscore notation is still applied properly
-        with go.validate(False):
-            fig = build_invalid_fig()
-            assert json.loads(fig.to_json()) == expected_invalid_dict
 
-        with go.validate(True):
-            with pytest.raises(ValueError):
-                build_invalid_fig()
-
-        # Use validate as callable
-        go.validate(False)
-        fig = build_invalid_fig()
+        fig = go.Figure(**build_invalid_fig(), validate=False)
         assert json.loads(fig.to_json()) == expected_invalid_dict
 
-        go.validate(True)
         with pytest.raises(ValueError):
-            build_invalid_fig()
+            go.Figure(**build_invalid_fig(), validate=True)
 
     finally:
         pio.templates.default = template
-        go.validate(should_validate)