Skip to content

feat: add did you mean message for strict check #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 28, 2024
Merged

feat: add did you mean message for strict check #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
710041d
feat: add did you mean message for strict check
njzjz Mar 28, 2024
4c09729
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Mar 28, 2024
1dae824
fix test
njzjz Mar 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion dargs/dargs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,8 +465,10 @@ 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
Expand Down
3 changes: 2 additions & 1 deletion tests/test_checker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,9 @@ def test_sub_fields(self):
ca.check(err_dict1)
err_dict1["base"]["sub2"]["subsub2"]["subsubsub1"] = 111
ca.check(err_dict1) # now should pass
with self.assertRaises(ArgumentKeyError):
with self.assertRaises(ArgumentKeyError) as cm:
ca.check(err_dict1, strict=True) # but should fail when strict
self.assertIn("Did you mean: subsubsub1?", str(cm.exception))
err_dict1["base"]["sub2"] = None
with self.assertRaises(ArgumentTypeError):
ca.check(err_dict1)
Expand Down