Key guessing before and after list of valid properties

Also tripped when no underscore paths are used, e.g.,

fig.data[0].line["colr"] = "blue"

Author: nicholas-esterer

packages/python/plotly/_plotly_utils/utils.py

@@ -433,6 +433,8 @@ def levenshtein(s1, s2):
 
 def find_closest_string(string, strings):
     def _key(s):
-        return levenshtein(s, string)
+        # sort by levenshtein distance and lexographically to maintain a stable
+        # sort for different keys with the same levenshtein distance
+        return (levenshtein(s, string), s)
 
     return sorted(strings, key=_key)[0]

packages/python/plotly/plotly/basedatatypes.py

@@ -238,17 +238,6 @@ def _check_path_in_prop_tree(obj, path, error_cast=None):
                         prop_idcs, i, length=_len_dict_item(prop[i]), char="^"
                     ),
                 )
-                guessed_prop = None
-                # If obj has _valid_props then we can try and guess what key was intended
-                try:
-                    guessed_prop = find_closest_string(prop[i], obj._valid_props)
-                except Exception:
-                    pass
-                if guessed_prop is not None:
-                    arg += """
-Did you mean "%s"?""" % (
-                        guessed_prop,
-                    )
             # Make KeyError more pretty by changing it to a PlotlyKeyError,
             # because the Python interpreter has a special way of printing
             # KeyError
@@ -4968,15 +4957,29 @@ def _ret(*args):
                 else:
                     full_obj_name = module_root + self.__class__.__name__
 
+                guessed_prop = None
+                if len(invalid_props) == 1:
+                    try:
+                        guessed_prop = find_closest_string(
+                            invalid_props[0], self._valid_props
+                        )
+                    except Exception:
+                        pass
+                guessed_prop_suggestion = ""
+                if guessed_prop is not None:
+                    guessed_prop_suggestion = 'Did you mean "%s"?' % (guessed_prop,)
                 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(
+                    "{full_obj_name}: {invalid_str}\n"
+                    "\n{guessed_prop_suggestion}\n"
+                    "\n    Valid properties:\n"
+                    "{prop_descriptions}"
+                    "\n{guessed_prop_suggestion}\n".format(
                         prop_str=prop_str,
                         full_obj_name=full_obj_name,
                         invalid_str=invalid_str,
                         prop_descriptions=self._prop_descriptions,
+                        guessed_prop_suggestion=guessed_prop_suggestion,
                     )
                 )
 

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

@@ -49,10 +49,9 @@ def test_raises_on_bad_dot_property(some_fig):
             e.args[0].find(
                 """Bad property path:
 layout.shapes[1].x2000
-                 ^^^^^
-Did you mean "x0"?"""
+                 ^^^^^"""
             )
-            >= 0
+            and (e.args[0].find("""Did you mean "x0"?""") >= 0) >= 0
         )
     assert raised
 
@@ -69,10 +68,9 @@ def test_raises_on_bad_ancestor_dot_property(some_fig):
             e.args[0].find(
                 """Bad property path:
 layout.shapa[1].x2000
-       ^^^^^
-Did you mean "shapes"?"""
+       ^^^^^"""
             )
-            >= 0
+            and (e.args[0].find("""Did you mean "shapes"?""") >= 0) >= 0
         )
     assert raised
 
@@ -118,19 +116,18 @@ def test_raises_on_bad_indexed_underscore_property(some_fig):
             """
 Bad property path:
 data[0].line_colr
-             ^^^^
-Did you mean "color"?""",
+             ^^^^""",
         )
         assert (
             (
                 e.args[0].find(
                     """Bad property path:
 data[0].line_colr
-             ^^^^
-Did you mean "color"?"""
+             ^^^^"""
                 )
                 >= 0
             )
+            and (e.args[0].find("""Did you mean "color"?""") >= 0)
             and (e_substr == e_correct_substr)
         )
     assert raised
@@ -170,10 +167,9 @@ def test_raises_on_bad_indexed_underscore_property(some_fig):
                 e.args[0].find(
                     """Bad property path:
 line_colr
-     ^^^^
-Did you mean "color"?"""
+     ^^^^"""
                 )
-                >= 0
+                and (e.args[0].find("""Did you mean "color"?""") >= 0) >= 0
             )
             and (e_substr == e_correct_substr)
         )
@@ -192,8 +188,7 @@ def test_raises_on_bad_indexed_underscore_property(some_fig):
             """
 Bad property path:
 txt
-^^^
-Did you mean "text"?""",
+^^^""",
         )
     assert raised
 
@@ -210,8 +205,7 @@ def test_raises_on_bad_indexed_underscore_property(some_fig):
             """
 Bad property path:
 layout_title_txt
-             ^^^
-Did you mean "text"?""",
+             ^^^""",
         )
         # also remove the invalid Figure property string added by the Figure constructor
         e_substr = error_substr(
@@ -224,11 +218,11 @@ def test_raises_on_bad_indexed_underscore_property(some_fig):
                 e.args[0].find(
                     """Bad property path:
 layout_title_txt
-             ^^^
-Did you mean "text"?""",
+             ^^^""",
                 )
                 >= 0
             )
+            and (e.args[0].find("""Did you mean "text"?""") >= 0)
             and (e_substr == e_correct_substr)
         )
     assert raised
@@ -245,8 +239,7 @@ def test_raises_on_bad_indexed_underscore_property(some_fig):
             """
 Bad property path:
 ltaxis
-^^^^^^
-Did you mean "lataxis"?""",
+^^^^^^""",
         )
     assert raised
 
@@ -260,19 +253,18 @@ def test_raises_on_bad_indexed_underscore_property(some_fig):
             """
 Bad property path:
 geo_ltaxis_showgrid
-    ^^^^^^
-Did you mean "lataxis"?""",
+    ^^^^^^""",
         )
         assert (
             (
                 e.args[0].find(
                     """Bad property path:
 geo_ltaxis_showgrid
-    ^^^^^^
-Did you mean "lataxis"?"""
+    ^^^^^^"""
                 )
                 >= 0
             )
+            and (e.args[0].find("""Did you mean "lataxis"?""") >= 0)
             and (e_substr == e_correct_substr)
         )
     assert raised
@@ -494,6 +486,7 @@ def _raise_bad_property_path_real():
             ("bogus", "_hey_yall"),
             ("^^^^^", "^^^^"),
             ('Did you mean "boxgap"', 'Did you mean "geo"'),
+            ('Did you mean "boxgap"', 'Did you mean "geo"'),
         ],
     )
     check_error_string(_raise_bad_property_path_real, ValueError, correct_err_str, [])
@@ -537,7 +530,8 @@ def _raise_bad_property_path_real():
         [
             ("bogusey", "_family"),
             ("bogusey", "_family"),
-            ('Did you mean "size"?', 'Did you mean "family"?'),
+            ('Did you mean "color"?', 'Did you mean "family"?'),
+            ('Did you mean "color"?', 'Did you mean "family"?'),
         ],
     )
     # no need to replace ^^^^^ because bogus and font_ are same length
@@ -560,6 +554,7 @@ def _raise_bad_property_path_real():
             ("bogus", "_"),
             ("^^^^^", "^"),
             ('Did you mean "boxgap"', 'Did you mean "geo"'),
+            ('Did you mean "boxgap"', 'Did you mean "geo"'),
         ],
     )
     check_error_string(_raise_bad_property_path_real, ValueError, correct_err_str, [])
@@ -581,6 +576,7 @@ def _raise_bad_property_path_real():
             ("bogus", "__"),
             ("^^^^^", "^^"),
             ('Did you mean "boxgap"', 'Did you mean "geo"'),
+            ('Did you mean "boxgap"', 'Did you mean "geo"'),
         ],
     )
     check_error_string(_raise_bad_property_path_real, ValueError, correct_err_str, [])
@@ -645,7 +641,8 @@ def _raise_bad_property_path_real():
         [
             ("bogusey", "_family"),
             ("bogusey", "_family"),
-            ('Did you mean "size"?', 'Did you mean "family"?'),
+            ('Did you mean "color"?', 'Did you mean "family"?'),
+            ('Did you mean "color"?', 'Did you mean "family"?'),
         ],
     )
     check_error_string(_raise_bad_property_path_real, ValueError, correct_err_str, [])