-
-
Notifications
You must be signed in to change notification settings - Fork 34.9k
gh-151128: Improve SyntaxError message for cross language keywords #151129
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.
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
Changes from 4 commits
ba55af2
bb0200a
3a2926f
27b89b6
f3cdecc
2cdd76e
bca2327
9e13d74
896dd06
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -1485,8 +1485,12 @@ def _find_keyword_typos(self): | |||||
| # Limit the number of possible matches to try | ||||||
| max_matches = 3 | ||||||
| matches = [] | ||||||
|
|
||||||
| hint = _get_cross_language_keyword_hint(wrong_name) | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
If it is only used once, and is marked as a "private" method, I would suggest calling the body directly
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not sure about this. I still think a get method looks nicer.. |
||||||
| if hint: | ||||||
| matches.append(hint) | ||||||
| if _suggestions is not None: | ||||||
| suggestion = _suggestions._generate_suggestions(keyword.kwlist, wrong_name) | ||||||
| suggestion = _suggestions._generate_suggestions(keyword.kwlist + keyword.softkwlist, wrong_name) | ||||||
| if suggestion: | ||||||
| matches.append(suggestion) | ||||||
| matches.extend(difflib.get_close_matches(wrong_name, keyword.kwlist, n=max_matches, cutoff=0.5)) | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Maybe we should add softkwlist here too? |
||||||
|
|
@@ -1787,6 +1791,20 @@ def print(self, *, file=None, chain=True, **kwargs): | |||||
| }) | ||||||
|
|
||||||
|
|
||||||
| # Cross-language keyword suggestions. | ||||||
| _CROSS_LANGUAGE_KEYWORD_HINTS = frozendict({ | ||||||
| # C/C++ equivalents | ||||||
| 'switch': 'match', | ||||||
| 'delete': 'del', | ||||||
| # function define equivalents | ||||||
| 'function': 'def', | ||||||
| 'func': 'def', | ||||||
|
serhiy-storchaka marked this conversation as resolved.
|
||||||
| # null equivalents | ||||||
| 'NULL': 'None', | ||||||
| 'null': 'None', | ||||||
| 'nil': 'None', | ||||||
| }) | ||||||
|
|
||||||
| def _substitution_cost(ch_a, ch_b): | ||||||
| if ch_a == ch_b: | ||||||
| return 0 | ||||||
|
|
@@ -1866,6 +1884,13 @@ def _get_cross_language_hint(obj, wrong_name): | |||||
| return None | ||||||
|
|
||||||
|
|
||||||
| def _get_cross_language_keyword_hint(wrong_name): | ||||||
| """Check if wrong_name is a common keyword from another language | ||||||
| """ | ||||||
| hint = _CROSS_LANGUAGE_KEYWORD_HINTS.get(wrong_name) | ||||||
| return hint | ||||||
This comment was marked as resolved.
Sorry, something went wrong. |
||||||
|
|
||||||
|
|
||||||
| def _get_safe___dir__(obj): | ||||||
| # Use obj.__dir__() to avoid a TypeError when calling dir(obj). | ||||||
| # See gh-131001 and gh-139933. | ||||||
|
|
||||||
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice. This is actually a different feature. You can even open a separate issue and PR for this (if there is no already open). Anyway, this is a nice improvement.
I suggest to add also cases for
<>("not equal" in Pascal and Python 2), "=<", "=>" and "=!" (typo in "<=", ">=" and "!="), "===" ("is" in JavaScript and PHP).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually there is already a PR for improving SyntaxError message of && and ||: #150906
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for review, great suggestion, I will add those~
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Then let's focus on keywords in this PR.