add suggestions to misspelled tendency keywords

Author: SBlokhuizen

waveform_editor/annotations.py

@@ -44,11 +44,11 @@ def add_yaml_error(self, error):
         else:
             self.add(0, f"Unknown YAML error: {error}")
 
-    def create_suggestion(self, match, list):
+    def suggest(self, word_to_match, possible_matches):
         suggestion = ""
-        close_matches = difflib.get_close_matches(match, list, n=1)
+        close_matches = difflib.get_close_matches(word_to_match, possible_matches, n=1)
         if close_matches:
-            suggestion = f"Did you mean {close_matches[0]!r}?"
+            suggestion = f"{close_matches[0]!r}"
 
         return suggestion
 

waveform_editor/tendencies/base.py

@@ -211,15 +211,26 @@ def _check_for_unknown_kwargs(self, kwargs):
                 unknown_kwargs.append(key.replace("user_", ""))
                 del kwargs[key]
         if unknown_kwargs:
+            # Remove the user_ part of the param names to match suggestion
+            params_list = [word.replace("user_", "") for word in list(self.param)]
             if len(unknown_kwargs) == 1:
+                suggestion = self.annotations.suggest(unknown_kwargs[0], params_list)
                 error_msg = (
-                    f"Unknown keyword passed: {', '.join(unknown_kwargs)}",
-                    " it will be ignored.",
+                    f"Unknown keyword passed: {unknown_kwargs[0]!r}. "
+                    f"Did you mean {suggestion}?\n"
+                    "This keyword will be ignored."
                 )
             else:
+                suggestions = []
+                for unknown_kwarg in unknown_kwargs:
+                    suggestions.append(
+                        self.annotations.suggest(unknown_kwarg, params_list)
+                    )
                 error_msg = (
-                    f"Multiple unknown keywords passed: {', '.join(unknown_kwargs)}",
-                    " they will be ignored.",
+                    "Multiple unknown keywords passed: "
+                    f"{', '.join(repr(k) for k in unknown_kwargs)}.\n"
+                    f"Did you mean {', '.join(suggestions)}?\n"
+                    "These keywords will be ignored.",
                 )
 
             self.annotations.add(line_number, error_msg, is_warning=True)

waveform_editor/waveform.py

@@ -137,17 +137,12 @@ def _handle_tendency(self, entry):
             return tendency
         else:
             line_number = entry.pop("line_number")
-
-            suggestions = ""
-            close_matches = difflib.get_close_matches(
-                tendency_type, tendency_map.keys(), n=1
-            )
-            if close_matches:
-                suggestions = f"Did you mean {close_matches[0]!r}?"
+            suggestion = self.annotations.suggest(tendency_type, tendency_map.keys())
 
             error_msg = (
-                f"Unsupported tendency type: {tendency_type}, {suggestions} \n"
-                "This tendency will be ignored.",
+                f"Unsupported tendency type: '{tendency_type}'.\n"
+                f"Did you mean {suggestion}? \n"
+                "This tendency will be ignored."
             )
             self.annotations.add(line_number, error_msg, is_warning=True)
             return None