WIP optional property validation

Author: jonmmease

packages/python/plotly/_plotly_utils/basevalidators.py

@@ -2569,7 +2569,7 @@ def __init__(
         )
 
         self.class_strs_map = class_strs_map
-        self._class_map = None
+        self._class_map = {}
         self.set_uid = set_uid
 
     def description(self):

packages/python/plotly/codegen/__init__.py

@@ -267,7 +267,9 @@ def perform_codegen():
     root_alls = []
 
     # TODO: come back to FigureWidget
-    optional_figure_widget_import = ""
+    optional_figure_widget_import = """
+from .._validate import validate
+"""
 #     optional_figure_widget_import = f"""
 #
 # try:

packages/python/plotly/codegen/datatypes.py

@@ -309,6 +309,10 @@ def __init__(self"""
 
     buffer.write(f"""
         super({datatype_class}, self).__init__('{node.name_property}')
+
+        if '_parent' in kwargs:
+            self._parent = kwargs['_parent']
+            return
 """)
 
     if datatype_class == "Layout":
@@ -354,27 +358,23 @@ def __init__(self"""
             self['{name_prop}'] = _v"""
         )
 
-#     # ### Literals ###
-#     if literal_nodes:
-#         buffer.write(
-#             f"""
-#
-#         # Read-only literals
-#         # ------------------
-#         from _plotly_utils.basevalidators import LiteralValidator"""
-#         )
-#         for literal_node in literal_nodes:
-#             lit_name = literal_node.name_property
-#             lit_parent = literal_node.parent_path_str
-#             lit_val = repr(literal_node.node_data)
-#             buffer.write(
-#                 f"""
-#         self._props['{lit_name}'] = {lit_val}
-#         self._validators['{lit_name}'] =\
-# LiteralValidator(plotly_name='{lit_name}',\
-#     parent_name='{lit_parent}', val={lit_val})
-#         arg.pop('{lit_name}', None)"""
-#             )
+    # ### Literals ###
+    if literal_nodes:
+        buffer.write(
+            f"""
+
+        # Read-only literals
+        # ------------------
+"""
+        )
+        for literal_node in literal_nodes:
+            lit_name = literal_node.name_property
+            lit_val = repr(literal_node.node_data)
+            buffer.write(
+                f"""
+        self._props['{lit_name}'] = {lit_val}
+        arg.pop('{lit_name}', None)"""
+            )
 
     buffer.write(
         f"""

packages/python/plotly/plotly/__init__.py

@@ -77,4 +77,5 @@
     # from plotly import _docstring_gen
 
 # TODO: Set default template here to make sure import process is complete
-# io.templates._default = "plotly"
+from plotly.io import templates
+templates._default = "plotly"

packages/python/plotly/plotly/_validate.py

@@ -0,0 +1,12 @@
+class validate(object):
+    _should_validate = True
+
+    def __init__(self, should_validate):
+        self._old = validate._should_validate
+        validate._should_validate = should_validate
+
+    def __enter__(self):
+        pass
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        validate._should_validate = self._old

packages/python/plotly/plotly/basedatatypes.py

@@ -10,6 +10,7 @@
 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
@@ -1933,9 +1934,11 @@ def _init_child_props(self, child):
     def _initialize_layout_template(self):
         import plotly.io as pio
 
-        if self._layout_obj.template is None:
+        if self._layout_obj._props.get('template', None) is None:
             if pio.templates.default is not None:
-                self._layout_obj.template = pio.templates.default
+                with validate(False):
+                    template_dict = pio.templates[pio.templates.default].to_plotly_json()
+                    self._layout_obj.template = template_dict
             else:
                 self._layout_obj.template = None
 
@@ -3021,6 +3024,9 @@ 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:
+                # Set extra property as-is
+                self[k] = v
             else:
                 invalid_kwargs[k] = v
 
@@ -3338,14 +3344,17 @@ def __getitem__(self, prop):
 
             if isinstance(validator, CompoundValidator):
                 if self._compound_props.get(prop, None) is None:
-                    self[prop] = {}
-                    # self._compound_props[prop] = validator.validate_coerce(None)
+                    # Init compound objects
+                    self._compound_props[prop] = validator.data_class(_parent=self)
 
                 return validator.present(self._compound_props[prop])
             elif isinstance(validator, CompoundArrayValidator):
                 if self._compound_array_props.get(prop, None) is None:
-                    self[prop] = []
-                    # self._compound_array_props[prop] = validator.validate_coerce(None)
+                    # Init list of compound objects
+                    self._compound_array_props[prop] = [
+                        validator.data_class(_parent=self)
+                        for _ in self._props.get(prop, [])
+                    ]
 
                 return validator.present(self._compound_array_props[prop])
             elif self._props is not None and prop in self._props:
@@ -3450,24 +3459,29 @@ def __setitem__(self, prop, value):
             # ### Unwrap scalar tuple ###
             prop = prop[0]
 
-            # ### Validate prop ###
-            if prop not in self._valid_props:
-                self._raise_on_invalid_property_error(prop)
+            if validate._should_validate:
+                # ### Validate prop ###
+                if prop not in self._valid_props:
+                    self._raise_on_invalid_property_error(prop)
 
-            # ### Get validator for this property ###
-            validator = self._get_validator(prop)
+                # ### Get validator for this property ###
+                validator = self._get_validator(prop)
 
-            # ### Handle compound property ###
-            if isinstance(validator, CompoundValidator):
-                self._set_compound_prop(prop, value)
+                # ### Handle compound property ###
+                if isinstance(validator, CompoundValidator):
+                    self._set_compound_prop(prop, value)
 
-            # ### Handle compound array property ###
-            elif isinstance(validator, (CompoundArrayValidator, BaseDataValidator)):
-                self._set_array_prop(prop, value)
+                # ### Handle compound array property ###
+                elif isinstance(validator, (CompoundArrayValidator, BaseDataValidator)):
+                    self._set_array_prop(prop, value)
 
-            # ### Handle simple property ###
+                # ### Handle simple property ###
+                else:
+                    self._set_prop(prop, value)
             else:
-                self._set_prop(prop, value)
+                # Make sure properties dict is initialized
+                self._init_props()
+                self._props[prop] = value
 
         # Handle non-scalar case
         # ----------------------

packages/python/plotly/plotly/graph_objs/__init__.py

@@ -257,3 +257,6 @@
             "._deprecations.Histogram2dcontour",
         ],
     )
+
+
+from .._validate import validate

packages/python/plotly/plotly/graph_objs/_area.py

@@ -872,6 +872,10 @@ def __init__(
         """
         super(Area, self).__init__("area")
 
+        if "_parent" in kwargs:
+            self._parent = kwargs["_parent"]
+            return
+
         # Validate arg
         # ------------
         if arg is None:
@@ -983,6 +987,12 @@ def __init__(
         if _v is not None:
             self["visible"] = _v
 
+        # Read-only literals
+        # ------------------
+
+        self._props["type"] = "area"
+        arg.pop("type", None)
+
         # Process unknown kwargs
         # ----------------------
         self._process_kwargs(**dict(arg, **kwargs))

packages/python/plotly/plotly/graph_objs/_bar.py

@@ -2626,6 +2626,10 @@ def __init__(
         """
         super(Bar, self).__init__("bar")
 
+        if "_parent" in kwargs:
+            self._parent = kwargs["_parent"]
+            return
+
         # Validate arg
         # ------------
         if arg is None:
@@ -2909,6 +2913,12 @@ def __init__(
         if _v is not None:
             self["ysrc"] = _v
 
+        # Read-only literals
+        # ------------------
+
+        self._props["type"] = "bar"
+        arg.pop("type", None)
+
         # Process unknown kwargs
         # ----------------------
         self._process_kwargs(**dict(arg, **kwargs))

packages/python/plotly/plotly/graph_objs/_barpolar.py

@@ -1641,6 +1641,10 @@ def __init__(
         """
         super(Barpolar, self).__init__("barpolar")
 
+        if "_parent" in kwargs:
+            self._parent = kwargs["_parent"]
+            return
+
         # Validate arg
         # ------------
         if arg is None:
@@ -1836,6 +1840,12 @@ def __init__(
         if _v is not None:
             self["widthsrc"] = _v
 
+        # Read-only literals
+        # ------------------
+
+        self._props["type"] = "barpolar"
+        arg.pop("type", None)
+
         # Process unknown kwargs
         # ----------------------
         self._process_kwargs(**dict(arg, **kwargs))

packages/python/plotly/plotly/graph_objs/_box.py

@@ -2621,6 +2621,10 @@ def __init__(
         """
         super(Box, self).__init__("box")
 
+        if "_parent" in kwargs:
+            self._parent = kwargs["_parent"]
+            return
+
         # Validate arg
         # ------------
         if arg is None:
@@ -2924,6 +2928,12 @@ def __init__(
         if _v is not None:
             self["ysrc"] = _v
 
+        # Read-only literals
+        # ------------------
+
+        self._props["type"] = "box"
+        arg.pop("type", None)
+
         # Process unknown kwargs
         # ----------------------
         self._process_kwargs(**dict(arg, **kwargs))

packages/python/plotly/plotly/graph_objs/_candlestick.py

@@ -1386,6 +1386,10 @@ def __init__(
         """
         super(Candlestick, self).__init__("candlestick")
 
+        if "_parent" in kwargs:
+            self._parent = kwargs["_parent"]
+            return
+
         # Validate arg
         # ------------
         if arg is None:
@@ -1565,6 +1569,12 @@ def __init__(
         if _v is not None:
             self["yaxis"] = _v
 
+        # Read-only literals
+        # ------------------
+
+        self._props["type"] = "candlestick"
+        arg.pop("type", None)
+
         # Process unknown kwargs
         # ----------------------
         self._process_kwargs(**dict(arg, **kwargs))

packages/python/plotly/plotly/graph_objs/_carpet.py

@@ -1589,6 +1589,10 @@ def __init__(
         """
         super(Carpet, self).__init__("carpet")
 
+        if "_parent" in kwargs:
+            self._parent = kwargs["_parent"]
+            return
+
         # Validate arg
         # ------------
         if arg is None:
@@ -1740,6 +1744,12 @@ def __init__(
         if _v is not None:
             self["ysrc"] = _v
 
+        # Read-only literals
+        # ------------------
+
+        self._props["type"] = "carpet"
+        arg.pop("type", None)
+
         # Process unknown kwargs
         # ----------------------
         self._process_kwargs(**dict(arg, **kwargs))

packages/python/plotly/plotly/graph_objs/_choropleth.py

@@ -1910,6 +1910,10 @@ def __init__(
         """
         super(Choropleth, self).__init__("choropleth")
 
+        if "_parent" in kwargs:
+            self._parent = kwargs["_parent"]
+            return
+
         # Validate arg
         # ------------
         if arg is None:
@@ -2109,6 +2113,12 @@ def __init__(
         if _v is not None:
             self["zsrc"] = _v
 
+        # Read-only literals
+        # ------------------
+
+        self._props["type"] = "choropleth"
+        arg.pop("type", None)
+
         # Process unknown kwargs
         # ----------------------
         self._process_kwargs(**dict(arg, **kwargs))

packages/python/plotly/plotly/graph_objs/_choroplethmapbox.py

@@ -1903,6 +1903,10 @@ def __init__(
         """
         super(Choroplethmapbox, self).__init__("choroplethmapbox")
 
+        if "_parent" in kwargs:
+            self._parent = kwargs["_parent"]
+            return
+
         # Validate arg
         # ------------
         if arg is None:
@@ -2102,6 +2106,12 @@ def __init__(
         if _v is not None:
             self["zsrc"] = _v
 
+        # Read-only literals
+        # ------------------
+
+        self._props["type"] = "choroplethmapbox"
+        arg.pop("type", None)
+
         # Process unknown kwargs
         # ----------------------
         self._process_kwargs(**dict(arg, **kwargs))