FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-151128: Improve SyntaxError message for cross language keywords by zang-langyan · Pull Request #151129 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

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.

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
serhiy-storchaka merged 9 commits into from
Jun 15, 2026
Conversation 19 Commits 9 Checks 53 Files changed
Merged

gh-151128: Improve SyntaxError message for cross language keywords #151129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ba55af2
gh-151128 Improve SyntaxError message for match
zang-langyan Jun 9, 2026
bb0200a
suggestion does not compute full match distance
zang-langyan Jun 9, 2026
3a2926f
add cross language keyword hints list as a general implementation
zang-langyan Jun 9, 2026
27b89b6
trim trailing whitespace
zang-langyan Jun 9, 2026
f3cdecc
focus on keyword suggestion
zang-langyan Jun 11, 2026
2cdd76e
remove trailing whitespace
zang-langyan Jun 11, 2026
bca2327
add test for soft keywords
zang-langyan Jun 11, 2026
9e13d74
add tests for keyword lazy and add void as another crosslang case
zang-langyan Jun 12, 2026
896dd06
remove whitespace
zang-langyan Jun 12, 2026
File filter

Filter by extension

Filter by extension .py  (2) .rst  (1) All 2 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
12 changes: 12 additions & 0 deletions Lib/test/test_traceback.py
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -1815,6 +1815,18 @@ class TestKeywordTypoSuggestions(unittest.TestCase):
("[x for x\nin range(3)\nof x]", "if"),
("[123 fur x\nin range(3)\nif x]", "for"),
("for x im n:\n pass", "in"),
("mach x:", "match"),
("math x:", "match"),
("match 1:\n cse 1:", "case"),
("typ x = int", "type"),
("typed x = int", "type"),
Comment thread
serhiy-storchaka marked this conversation as resolved.
("lazi import x", "lazy"),
("lezi import x", "lazy"),
("switch x:\n case:", "match"),
("delete x", "del"),
("function f():", "def"),
("func f():", "def"),
("void f():", "def"),
]

def test_keyword_suggestions_from_file(self):
Expand Down
32 changes: 30 additions & 2 deletions Lib/traceback.py
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -1485,11 +1485,22 @@ 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)

edvilme Jun 11, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality
Suggested change
hint = _get_cross_language_keyword_hint(wrong_name)
hint = _CROSS_LANGUAGE_KEYWORD_HINTS.get(wrong_name)

If it is only used once, and is marked as a "private" method, I would suggest calling the body directly

zang-langyan Jun 12, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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))
matches.extend(
difflib.get_close_matches(
wrong_name,
keyword.kwlist + keyword.softkwlist,
n=max_matches,
cutoff=0.5
)
)
matches = matches[:max_matches]
for suggestion in matches:
if not suggestion or suggestion == wrong_name:
Expand Down Expand Up @@ -1787,6 +1798,17 @@ 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',
Comment thread
serhiy-storchaka marked this conversation as resolved.
'void': 'def',
})

def _substitution_cost(ch_a, ch_b):
if ch_a == ch_b:
return 0
Expand Down Expand Up @@ -1866,6 +1888,12 @@ 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
"""
return _CROSS_LANGUAGE_KEYWORD_HINTS.get(wrong_name)


def _get_safe___dir__(obj):
# Use obj.__dir__() to avoid a TypeError when calling dir(obj).
# See gh-131001 and gh-139933.
Expand Down
3 changes: 3 additions & 0 deletions Misc/NEWS.d/next/Library/2026-06-12-00-17-29.gh-issue-151128.-LYO3a.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Cross-language keyword suggestions are now shown for :exc:`SyntaxError` messages.
For example, ``switch x:`` suggests ``match``, ``delete x`` suggests ``del``,
``function f():`` suggests ``def``. Contributed by Zang Langyan.
Loading
Back | FazBrowse Home | New Git URL