Skip to content

gh-146401: suggest a module in sys.builtin_module_names #146421

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

Open
Locked-chess-official wants to merge 2 commits into
base: main
Choose a base branch
from
+21 −1
Open

gh-146401: suggest a module in sys.builtin_module_names #146421

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c01925d
just change traceback.py to make it
Locked-chess-official Mar 25, 2026
b57a7e7
add test (why who added the suggestion for module name didn't add the…
Locked-chess-official Mar 26, 2026
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
20 changes: 20 additions & 0 deletions Lib/test/test_traceback.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5004,6 +5004,26 @@ def func():
actual = self.get_suggestion(func)
self.assertIn("forget to import '_io'", actual)

def test_import_builtin_module_typo_suggestion(self):
def func():
import itertool # noqa: F401

actual = self.get_suggestion(func)
self.assertIn("Did you mean: 'itertools'?", actual)

def test_import_file_module_typo_suggestion(self):
def func():
import abs # noqa: F401

actual = self.get_suggestion(func)
self.assertIn("Did you mean: 'abc'?", actual)

def test_import_submodule_typo_suggestion(self):
def func():
import multiprocessing.dumy # noqa: F401

actual = self.get_suggestion(func)
self.assertIn("Did you mean: 'multiprocessing.dummy'?", actual)


class PurePythonSuggestionFormattingTests(
Expand Down
2 changes: 1 addition & 1 deletion Lib/traceback.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1755,7 +1755,7 @@ def _compute_suggestion_error(exc_value, tb, wrong_name):
parent = importlib.util.find_spec(parent_name)
else:
parent = None
d = []
d = list(sys.builtin_module_names)
Copy link
Member

@picnixz picnixz Mar 25, 2026

Choose a reason for hiding this comment

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

Ah now, I see what happens. I'm really sorry. Maybe the change in the finder is ok? cc @brettcannon

Copy link
Member

@brettcannon brettcannon Mar 25, 2026

Choose a reason for hiding this comment

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

I don't know what "finder" you're referring to as this it in the traceback module that's not a finder.

Copy link
Member

@picnixz picnixz Mar 25, 2026

Choose a reason for hiding this comment

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

Sorry for the lack of context. We use "finders" in sys.meta_path to know about the "known" modules via the discover() method but BuiltinImporter (I think it's this one) doesn't have a discover() method. Should we add one to this importer?

Copy link
Member

@picnixz picnixz Mar 25, 2026

Choose a reason for hiding this comment

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

More precisely, we previously had this addition in the importer:

    @classmethod
    def discover(cls, spec=None):
        if spec is not None: # assume that built-in modules have no submodule
            return
        for i in sys.builtin_module_names:
            yield cls.find_spec(i)

for finder in sys.meta_path:
if discover := getattr(finder, 'discover', None):
d += [spec.name for spec in discover(parent)]
Expand Down
Loading