Changed dict path error display to always ^

and underneath the whole offending part of the path e.g.,

the_badpart_of_the_path
    ^^^^^^^

for both property and subscripting errors.

Author: nicholas-esterer

packages/python/plotly/plotly/basedatatypes.py

@@ -28,6 +28,22 @@
 Undefined = object()
 
 
+def _len_dict_item(item):
+    """
+    Because a parsed dict path is a tuple containings strings or integers, to
+    know the length of the resulting string when printing we might need to
+    convert to a string before calling len on it.
+    """
+    if type(item) == type(str()):
+        return len(item)
+    elif type(item) == type(int()):
+        return len("%d" % (item,))
+    else:
+        raise ValueError(
+            "Cannot find string length of an item that is neither a string nor an integer."
+        )
+
+
 def _str_to_dict_path_full(key_path_str):
     """
     Convert a key path string into a tuple of key path elements and also
@@ -162,7 +178,7 @@ def _check_path_in_prop_tree(obj, path, error_cast=None):
 %s""" % (
                     path,
                     display_string_positions(
-                        prop_idcs, disp_i, length=len(prop[disp_i]), char="~"
+                        prop_idcs, disp_i, length=_len_dict_item(prop[disp_i]), char="^"
                     ),
                 )
             else:
@@ -173,7 +189,9 @@ def _check_path_in_prop_tree(obj, path, error_cast=None):
 %s
 %s""" % (
                     path,
-                    display_string_positions(prop_idcs, i, length=1, char="^"),
+                    display_string_positions(
+                        prop_idcs, i, length=_len_dict_item(prop[i]), char="^"
+                    ),
                 )
             # Make KeyError more pretty by changing it to a PlotlyKeyError,
             # because the Python interpreter has a special way of printing

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

@@ -49,7 +49,7 @@ def test_raises_on_bad_dot_property(some_fig):
             e.args[0].find(
                 """Bad property path:
 layout.shapes[1].x2000
-                 ^"""
+                 ^^^^^"""
             )
             >= 0
         )
@@ -68,7 +68,7 @@ def test_raises_on_bad_ancestor_dot_property(some_fig):
             e.args[0].find(
                 """Bad property path:
 layout.shapa[1].x2000
-       ^"""
+       ^^^^^"""
             )
             >= 0
         )
@@ -99,7 +99,7 @@ def test_raises_on_bad_indexed_underscore_property(some_fig):
             """
 Bad property path:
 colr
-^""",
+^^^^""",
         )
     # if the string starts with "Bad property path:" then this test cannot work
     # this way.
@@ -116,14 +116,14 @@ def test_raises_on_bad_indexed_underscore_property(some_fig):
             """
 Bad property path:
 data[0].line_colr
-             ^""",
+             ^^^^""",
         )
         assert (
             (
                 e.args[0].find(
                     """Bad property path:
 data[0].line_colr
-             ^"""
+             ^^^^"""
                 )
                 >= 0
             )
@@ -142,7 +142,7 @@ def test_raises_on_bad_indexed_underscore_property(some_fig):
             """
 Bad property path:
 colr
-^""",
+^^^^""",
         )
     assert raised
 
@@ -159,14 +159,14 @@ def test_raises_on_bad_indexed_underscore_property(some_fig):
             """
 Bad property path:
 line_colr
-     ^""",
+     ^^^^""",
         )
         assert (
             (
                 e.args[0].find(
                     """Bad property path:
 line_colr
-     ^"""
+     ^^^^"""
                 )
                 >= 0
             )
@@ -187,7 +187,7 @@ def test_raises_on_bad_indexed_underscore_property(some_fig):
             """
 Bad property path:
 txt
-^""",
+^^^""",
         )
     assert raised
 
@@ -204,7 +204,7 @@ def test_raises_on_bad_indexed_underscore_property(some_fig):
             """
 Bad property path:
 layout_title_txt
-             ^""",
+             ^^^""",
         )
         # also remove the invalid Figure property string added by the Figure constructor
         e_substr = error_substr(
@@ -217,7 +217,7 @@ def test_raises_on_bad_indexed_underscore_property(some_fig):
                 e.args[0].find(
                     """Bad property path:
 layout_title_txt
-             ^"""
+             ^^^"""
                 )
                 >= 0
             )
@@ -237,7 +237,7 @@ def test_raises_on_bad_indexed_underscore_property(some_fig):
             """
 Bad property path:
 ltaxis
-^""",
+^^^^^^""",
         )
     assert raised
 
@@ -251,14 +251,14 @@ def test_raises_on_bad_indexed_underscore_property(some_fig):
             """
 Bad property path:
 geo_ltaxis_showgrid
-    ^""",
+    ^^^^^^""",
         )
         assert (
             (
                 e.args[0].find(
                     """Bad property path:
 geo_ltaxis_showgrid
-    ^"""
+    ^^^^^^"""
                 )
                 >= 0
             )
@@ -303,15 +303,15 @@ def test_describes_subscripting_error(some_fig):
 
 Property does not support subscripting:
 text_yo
-~~~~""",
+^^^^""",
         )
         assert (
             (
                 e.args[0].find(
                     """
 Property does not support subscripting:
 text_yo
-~~~~"""
+^^^^"""
                 )
                 >= 0
             )
@@ -346,15 +346,15 @@ def test_describes_subscripting_error(some_fig):
 
 Property does not support subscripting:
 textfont_family_yo
-         ~~~~~~""",
+         ^^^^^^""",
         )
         assert (
             (
                 e.args[0].find(
                     """
 Property does not support subscripting:
 textfont_family_yo
-         ~~~~~~"""
+         ^^^^^^"""
                 )
                 >= 0
             )
@@ -389,7 +389,7 @@ def test_described_subscript_error_on_type_error(some_fig):
 
 Property does not support subscripting:
 template_layout_plot_bgcolor_x
-                ~~~~~~~~~~~~"""
+                ^^^^^^^^^^^^"""
     assert raised
     raised = False
     try: