Skip to content

[3.12] gh-125519: Improve traceback if importlib.reload() is called with a non-module object (GH-125520) #125769

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 2 commits into from
Oct 21, 2024
Merged

[3.12] gh-125519: Improve traceback if importlib.reload() is called with a non-module object (GH-125520) #125769

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
c8311f6
gh-125519: Improve traceback if `importlib.reload()` is called with a…
AlexWaygood Oct 21, 2024
e6bc55c
Update test_api.py
AlexWaygood Oct 21, 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
2 changes: 1 addition & 1 deletion Lib/importlib/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ def reload(module):
try:
name = module.__name__
except AttributeError:
raise TypeError("reload() argument must be a module")
raise TypeError("reload() argument must be a module") from None

if sys.modules.get(name) is not module:
raise ImportError(f"module {name} not in sys.modules", name=name)
Expand Down
16 changes: 16 additions & 0 deletions Lib/test/test_importlib/test_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
import sys
from test.support import import_helper
from test.support import os_helper
from test import support
import traceback
import types
import unittest
import warnings
Expand Down Expand Up @@ -354,6 +356,20 @@ def test_module_missing_spec(self):
with self.assertRaises(ModuleNotFoundError):
self.init.reload(module)

def test_reload_traceback_with_non_str(self):
# gh-125519
with support.captured_stdout() as stdout:
try:
self.init.reload("typing")
except TypeError as exc:
traceback.print_exception(exc, file=stdout)
else:
self.fail("Expected TypeError to be raised")
printed_traceback = stdout.getvalue()
self.assertIn("TypeError", printed_traceback)
self.assertNotIn("AttributeError", printed_traceback)
self.assertNotIn("module.__spec__.name", printed_traceback)


(Frozen_ReloadTests,
Source_ReloadTests
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Library/2024-10-15-14-01-03.gh-issue-125519.TqGh6a.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Improve traceback if :func:`importlib.reload` is called with an object that
is not a module. Patch by Alex Waygood.
Loading