Skip to content

Print InspectError traceback in stubgen walk_packages when verbose is specified#18224

Merged
hauntsaninja merged 1 commit intopython:masterfrom
gareth-cross:verbose-import-error-print
Dec 21, 2024
Merged

Print InspectError traceback in stubgen walk_packages when verbose is specified#18224
hauntsaninja merged 1 commit intopython:masterfrom
gareth-cross:verbose-import-error-print

Conversation

@gareth-cross
Copy link
Contributor

@gareth-cross gareth-cross commented Dec 1, 2024

This change modifies walk_packages such that the full ImporError traceback is printed when a module cannot be imported. The goal is to provide the user with more context to debug the error.

I implemented this change by mirroring existing behavior in find_module_paths_using_imports:

mypy/mypy/stubgen.py

Lines 1522 to 1529 in 9405bfd

try:
result = find_module_path_and_all_py3(inspect, mod, verbose)
except CantImport as e:
tb = traceback.format_exc()
if verbose:
sys.stdout.write(tb)
if not quiet:
report_missing(mod, e.message, tb)

@github-actions

This comment has been minimized.

Sign in to view
hamdanal
hamdanal reviewed Dec 21, 2024
View reviewed changes
Copy link
Collaborator

@hamdanal hamdanal left a comment

Choose a reason for hiding this comment

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

Thanks. Could you print the traceback to stderr instead? You might also change find_module_paths_using_imports to print to stderr as well.

@gareth-cross gareth-cross force-pushed the verbose-import-error-print branch from 645f12f to 938757e Compare December 21, 2024 18:51
@gareth-cross
Copy link
Contributor Author

gareth-cross commented Dec 21, 2024

Thanks. Could you print the traceback to stderr instead? You might also change find_module_paths_using_imports to print to stderr as well.

Done for both.

@brianschubert
Copy link
Collaborator

brianschubert commented Dec 21, 2024

(For future reference: try to avoid force pushing. It makes it hard to review changes. We squash merge anyway, so extra commits in the PR history doesn’t matter)

@gareth-cross
Copy link
Contributor Author

gareth-cross commented Dec 21, 2024

(For future reference: try to avoid force pushing. It makes it hard to review changes. We squash merge anyway, so extra commits in the PR history doesn’t matter)

Apologies - good call.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 21, 2024

According to mypy_primer, this change doesn't affect type check results on a corpus of open source code. ✅

hamdanal
hamdanal approved these changes Dec 21, 2024
View reviewed changes
Copy link
Collaborator

@hamdanal hamdanal left a comment

Choose a reason for hiding this comment

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

Thanks.

@hauntsaninja hauntsaninja merged commit ceaf48d into python:master Dec 21, 2024
@gareth-cross gareth-cross deleted the verbose-import-error-print branch December 21, 2024 23:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hauntsaninja hauntsaninja hauntsaninja approved these changes

+1 more reviewer

@hamdanal hamdanal hamdanal approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

topic-stubgen

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@gareth-cross @brianschubert @hauntsaninja @hamdanal