feat: add did you mean message for strict check

deepmodeling · Mar 28, 2024 · 710041d · 710041d
1 parent 2c5e762
commit 710041d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/dargs/dargs.py b/dargs/dargs.py
@@ -465,8 +465,9 @@ def _check_strict(self, value: dict, path=None):
             return
         for name in value.keys():
             if name not in allowed_keys:
+                dym_message = did_you_mean(name, allowed_keys)
                 raise ArgumentKeyError(
-                    path, f"undefined key `{name}` is " "not allowed in strict mode"
+                    path, f"undefined key `{name}` is not allowed in strict mode. {dym_message}"
                 )
 
     # above are type checking part

diff --git a/tests/test_checker.py b/tests/test_checker.py
@@ -18,8 +18,9 @@ def test_name_type(self):
         # possible error
         with self.assertRaises(ArgumentKeyError):
             ca.check({"key2": 1})
-        with self.assertRaises(ArgumentKeyError):
+        with self.assertRaises(ArgumentKeyError) as cm:
             ca.check({"key1": 1, "key2": 1}, strict=True)
+        self.assertIn("Did you mean: key1?", str(cm.exception))
         with self.assertRaises(ArgumentTypeError):
             ca.check({"key1": 1.0})
         # special handle of None