BasePlotlyType._raise_on_invalid_property_error raises PlotlyKeyError

It used to raise ValueError but PlotlyKeyError subclasses KeyError and
is the more relevant exception. PlotlyKeyError maintains the nice
printing of the errors, unlike KeyError.

Author: nicholas-esterer

packages/python/plotly/plotly/basedatatypes.py

@@ -4331,7 +4331,7 @@ def _raise_on_invalid_property_error(self, *args):
 
         Raises
         ------
-        ValueError
+        PlotlyKeyError
             Always
         """
         invalid_props = args
@@ -4351,7 +4351,7 @@ def _raise_on_invalid_property_error(self, *args):
             else:
                 full_obj_name = module_root + self.__class__.__name__
 
-            raise ValueError(
+            raise PlotlyKeyError(
                 "Invalid {prop_str} specified for object of type "
                 "{full_obj_name}: {invalid_str}\n\n"
                 "    Valid properties:\n"

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

@@ -43,7 +43,7 @@ def test_raises_on_bad_dot_property(some_fig):
     raised = False
     try:
         x2000 = some_fig["layout.shapes[1].x2000"]
-    except ValueError as e:
+    except KeyError as e:
         raised = True
         assert (
             e.args[0].find(
@@ -62,7 +62,7 @@ def test_raises_on_bad_ancestor_dot_property(some_fig):
     raised = False
     try:
         x2000 = some_fig["layout.shapa[1].x2000"]
-    except ValueError 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 ValueError as e_correct:
+    except KeyError 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 ValueError as e:
+    except KeyError 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 ValueError as e_correct:
+    except KeyError 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 ValueError as e:
+    except KeyError 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 ValueError as e_correct:
+    except KeyError 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 ValueError above, a
+        # when the Figure constructor sees the same KeyError above, a
         # TypeError is raised and adds an error message in front of the same
-        # ValueError thrown above
+        # KeyError 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 ValueError as e_correct:
+    except KeyError 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 ValueError as e:
+    except KeyError as e:
         raised = True
         e_substr = error_substr(
             e.args[0],

packages/python/plotly/plotly/tests/test_core/test_graph_objs/test_layout_subplots.py

@@ -39,7 +39,7 @@ def test_initial_access_subplot2(self):
             self.layout.xaxis2
 
     def test_initial_access_subplot2(self):
-        with pytest.raises(ValueError):
+        with pytest.raises(KeyError):
             self.layout["xaxis2"]
 
     def test_assign_subplots(self):