Skip to content

gh-138542: error message is wrong when inspect a custom module #143769

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
yihong0618 wants to merge 11 commits into
base: main
Choose a base branch
from
Open

gh-138542: error message is wrong when inspect a custom module #143769

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
13f8c0d
fix: error message is wrong when inspect a custom module
yihong0618 Sep 5, 2025
2b31614
Update Lib/inspect.py
yihong0618 Sep 5, 2025
a1402b9
Apply suggestions from code review
yihong0618 Sep 6, 2025
8a4cdc4
Update Lib/inspect.py
yihong0618 Sep 7, 2025
a9bdc58
fix: tests
yihong0618 Sep 7, 2025
ccd79d6
Update Lib/inspect.py
yihong0618 Sep 7, 2025
a8af464
Update Lib/test/test_inspect/test_inspect.py
yihong0618 Sep 7, 2025
0d2d40c
fix: move re to the top
yihong0618 Sep 7, 2025
56d1835
Merge branch 'main' into pr-138543
yihong0618 Jan 13, 2026
49d11e6
fix: apply suggestions
yihong0618 Feb 13, 2026
947feed
Merge branch 'main' into pr-138543
yihong0618 Feb 13, 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
4 changes: 3 additions & 1 deletion Lib/inspect.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -843,7 +843,9 @@ def getfile(object):
if ismodule(object):
if getattr(object, '__file__', None):
return object.__file__
raise TypeError('{!r} is a built-in module'.format(object))
if getattr(object, '__spec__', None) is not None:
raise TypeError(f'{object!r} is a built-in module')
Copy link
Copy Markdown
Contributor

@caje731 caje731 Feb 11, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

I believe the existence of spec does not always guarantee a built-in. The module could also be a pure-Python module loaded from a .py file, or a compiled extension module like .so, .pyd, .dylib, or a namespace package (init) or a built-in, or a frozen module (embedded bytecode in the executable, and so on.

I think it is best to use spec.origin if a spec exists:

            raise TypeError(f'{object!r} is: {object.__spec__.origin}')

In a limited number of cases, origin may be unset/None, but I feel that's better than clubbing everything as a built-in module. WDYT?

Copy link
Copy Markdown
Contributor Author

@yihong0618 yihong0618 Feb 13, 2026

Choose a reason for hiding this comment

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

better will do it

raise TypeError(f'cannot get source from {object!r}')
if isclass(object):
if hasattr(object, '__module__'):
module = sys.modules.get(object.__module__)
Expand Down
8 changes: 7 additions & 1 deletion Lib/test/test_inspect/test_inspect.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
from os.path import normcase
import _pickle
import pickle
import re
import shutil
import stat
import sys
Expand Down Expand Up @@ -858,6 +859,12 @@ def test_getfile_builtin_module(self):
inspect.getfile(sys)
self.assertStartsWith(str(e.exception), '<module')

def test_getfile_custom_module(self):
my_mod = types.ModuleType('my_mod')
msg = re.escape(f'cannot get source from {my_mod!r}')
with self.assertRaisesRegex(TypeError, msg) as e:
inspect.getfile(my_mod)

def test_getfile_builtin_class(self):
with self.assertRaises(TypeError) as e:
inspect.getfile(int)
Expand Down Expand Up @@ -6252,7 +6259,6 @@ def test_pwd_module_has_signatures(self):
self._test_module_has_signatures(pwd)

def test_re_module_has_signatures(self):
import re
methods_no_signature = {'Match': {'group'}}
self._test_module_has_signatures(re,
methods_no_signature=methods_no_signature,
Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Library/2025-09-05-23-18-51.gh-issue-138542.hQ9Q04.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix :func:`inspect.getfile` error message for custom module objects.
Loading