Updated the tests to reflect the new Exception behaviour

I believe the new behaviour is consistent with the previous exception
behaviour, but we will run the CI tests to be sure.

Author: nicholas-esterer

packages/python/plotly/plotly/basedatatypes.py

@@ -489,7 +489,7 @@ def __setitem__(self, prop, value):
         # ----------------------
         # e.g. ('foo', 1)
         else:
-            err = _check_path_in_prop_tree(self, orig_prop)
+            err = _check_path_in_prop_tree(self, orig_prop, error_cast=ValueError)
             if err is not None:
                 raise err
             res = self
@@ -3456,7 +3456,7 @@ def _perform_update(plotly_obj, update_obj, overwrite=False):
             # This should be valid even if xaxis2 hasn't been initialized:
             # >>> layout.update(xaxis2={'title': 'xaxis 2'})
             for key in update_obj:
-                err = _check_path_in_prop_tree(plotly_obj, key)
+                err = _check_path_in_prop_tree(plotly_obj, key, error_cast=ValueError)
                 if err is not None:
                     if isinstance(plotly_obj, BaseLayoutType):
                         # try _subplot_re_match
@@ -3672,7 +3672,7 @@ def _process_kwargs(self, **kwargs):
         """
         invalid_kwargs = {}
         for k, v in kwargs.items():
-            err = _check_path_in_prop_tree(self, k)
+            err = _check_path_in_prop_tree(self, k, error_cast=ValueError)
             if err is None:
                 # e.g. underscore kwargs like marker_line_color
                 self[k] = v
@@ -4007,7 +4007,9 @@ def __getitem__(self, prop):
             # Unwrap scalar tuple
             prop = prop[0]
             if prop not in self._valid_props:
-                self._raise_on_invalid_property_error(prop)
+                self._raise_on_invalid_property_error(_error_to_raise=PlotlyKeyError)(
+                    prop
+                )
 
             validator = self._get_validator(prop)
 
@@ -4145,7 +4147,7 @@ def __setitem__(self, prop, value):
 
             if self._validate:
                 if prop not in self._valid_props:
-                    self._raise_on_invalid_property_error(prop)
+                    self._raise_on_invalid_property_error()(prop)
 
                 # ### Get validator for this property ###
                 validator = self._get_validator(prop)
@@ -4219,7 +4221,7 @@ def __setattr__(self, prop, value):
             super(BasePlotlyType, self).__setattr__(prop, value)
         else:
             # Raise error on unknown public properties
-            self._raise_on_invalid_property_error(prop)
+            self._raise_on_invalid_property_error()(prop)
 
     def __iter__(self):
         """
@@ -4328,10 +4330,11 @@ def __repr__(self):
 
         return repr_str
 
-    def _raise_on_invalid_property_error(self, *args):
+    def _raise_on_invalid_property_error(self, _error_to_raise=None):
         """
-        Raise informative exception when invalid property names are
-        encountered
+        Returns a function that raises informative exception when invalid
+        property names are encountered. The _error_to_raise argument allows
+        specifying the exception to raise, which is ValueError if None.
 
         Parameters
         ----------
@@ -4341,37 +4344,45 @@ def _raise_on_invalid_property_error(self, *args):
 
         Raises
         ------
-        PlotlyKeyError
-            Always
-        """
-        invalid_props = args
-        if invalid_props:
-            if len(invalid_props) == 1:
-                prop_str = "property"
-                invalid_str = repr(invalid_props[0])
-            else:
-                prop_str = "properties"
-                invalid_str = repr(invalid_props)
+        ValueError by default, or _error_to_raise if not None
+        """
+        if _error_to_raise is None:
+            _error_to_raise = ValueError
 
-            module_root = "plotly.graph_objs."
-            if self._parent_path_str:
-                full_obj_name = (
-                    module_root + self._parent_path_str + "." + self.__class__.__name__
+        def _ret(*args):
+            invalid_props = args
+            if invalid_props:
+                if len(invalid_props) == 1:
+                    prop_str = "property"
+                    invalid_str = repr(invalid_props[0])
+                else:
+                    prop_str = "properties"
+                    invalid_str = repr(invalid_props)
+
+                module_root = "plotly.graph_objs."
+                if self._parent_path_str:
+                    full_obj_name = (
+                        module_root
+                        + self._parent_path_str
+                        + "."
+                        + self.__class__.__name__
+                    )
+                else:
+                    full_obj_name = module_root + self.__class__.__name__
+
+                raise _error_to_raise(
+                    "Invalid {prop_str} specified for object of type "
+                    "{full_obj_name}: {invalid_str}\n\n"
+                    "    Valid properties:\n"
+                    "{prop_descriptions}".format(
+                        prop_str=prop_str,
+                        full_obj_name=full_obj_name,
+                        invalid_str=invalid_str,
+                        prop_descriptions=self._prop_descriptions,
+                    )
                 )
-            else:
-                full_obj_name = module_root + self.__class__.__name__
 
-            raise ValueError(
-                "Invalid {prop_str} specified for object of type "
-                "{full_obj_name}: {invalid_str}\n\n"
-                "    Valid properties:\n"
-                "{prop_descriptions}".format(
-                    prop_str=prop_str,
-                    full_obj_name=full_obj_name,
-                    invalid_str=invalid_str,
-                    prop_descriptions=self._prop_descriptions,
-                )
-            )
+        return _ret
 
     def update(self, dict1=None, overwrite=False, **kwargs):
         """

packages/python/plotly/plotly/tests/test_core/test_errors/test_dict_path_errors.py

@@ -23,7 +23,7 @@ def test_raises_on_bad_index(some_fig):
     raised = False
     try:
         x0 = some_fig["layout.shapes[2].x0"]
-    except IndexError as e:
+    except KeyError as e:
         raised = True
         assert (
             e.args[0].find(
@@ -91,7 +91,7 @@ def test_raises_on_bad_indexed_underscore_property(some_fig):
     try:
         # get the error without using a path-like key, we compare with this error
         some_fig.data[0].line["colr"] = "blue"
-    except KeyError as e_correct:
+    except ValueError as e_correct:
         raised = True
         # remove "Bad property path:
         e_correct_substr = error_substr(
@@ -109,7 +109,7 @@ def test_raises_on_bad_indexed_underscore_property(some_fig):
     raised = False
     try:
         some_fig["data[0].line_colr"] = "blue"
-    except KeyError as e:
+    except ValueError as e:
         raised = True
         e_substr = error_substr(
             e.args[0],
@@ -135,7 +135,7 @@ def test_raises_on_bad_indexed_underscore_property(some_fig):
     try:
         # get the error without using a path-like key
         some_fig.add_trace(go.Scatter(x=[1, 2], y=[3, 4], line=dict(colr="blue")))
-    except KeyError as e_correct:
+    except ValueError as e_correct:
         raised = True
         e_correct_substr = error_substr(
             e_correct.args[0],
@@ -152,7 +152,7 @@ def test_raises_on_bad_indexed_underscore_property(some_fig):
     # the path
     try:
         some_fig.add_trace(go.Scatter(x=[1, 2], y=[3, 4], line_colr="blue"))
-    except KeyError as e:
+    except ValueError as e:
         raised = True
         e_substr = error_substr(
             e.args[0],
@@ -180,7 +180,7 @@ def test_raises_on_bad_indexed_underscore_property(some_fig):
     # the path
     try:
         fig2 = go.Figure(layout=dict(title=dict(txt="two")))
-    except KeyError as e_correct:
+    except ValueError as e_correct:
         raised = True
         e_correct_substr = error_substr(
             e_correct.args[0],
@@ -196,9 +196,9 @@ def test_raises_on_bad_indexed_underscore_property(some_fig):
         fig2 = go.Figure(layout_title_txt="two")
     except TypeError as e:
         raised = True
-        # when the Figure constructor sees the same KeyError above, a
-        # TypeError is raised and adds an error message in front of the same
-        # KeyError thrown above
+        # when the Figure constructor sees the same ValueError above, a
+        # ValueError is raised and adds an error message in front of the same
+        # ValueError thrown above
         e_substr = error_substr(
             e.args[0],
             """
@@ -230,7 +230,7 @@ def test_raises_on_bad_indexed_underscore_property(some_fig):
     # works when the bad part is not the last part in the path
     try:
         some_fig.update_layout(geo=dict(ltaxis=dict(showgrid=True)))
-    except KeyError as e_correct:
+    except ValueError as e_correct:
         raised = True
         e_correct_substr = error_substr(
             e_correct.args[0],
@@ -244,7 +244,7 @@ def test_raises_on_bad_indexed_underscore_property(some_fig):
     raised = False
     try:
         some_fig.update_layout(geo_ltaxis_showgrid=True)
-    except KeyError as e:
+    except ValueError as e:
         raised = True
         e_substr = error_substr(
             e.args[0],
@@ -287,7 +287,7 @@ def test_describes_subscripting_error(some_fig):
     raised = False
     try:
         some_fig.update_traces(text_yo="hey")
-    except TypeError as e:
+    except ValueError as e:
         raised = True
         print(e.args[0])
         e_substr = error_substr(
@@ -332,7 +332,7 @@ def test_describes_subscripting_error(some_fig):
     raised = False
     try:
         go.Figure(go.Scatter()).update_traces(textfont_family_yo="hey")
-    except TypeError as e:
+    except ValueError as e:
         raised = True
         e_substr = error_substr(
             e.args[0],