Skip to content

gh-122255: Synchronize warnings in C and Python implementations of the warnings module #122824

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.

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
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
64 changes: 49 additions & 15 deletions Lib/linecache.py
Original file line number Diff line number Diff line change
Expand Up @@ -175,21 +175,55 @@ def lazycache(filename, module_globals):
return False
if not filename or (filename.startswith('<') and filename.endswith('>')):
return False
# Try for a __loader__, if available
if module_globals and '__name__' in module_globals:
spec = module_globals.get('__spec__')
name = getattr(spec, 'name', None) or module_globals['__name__']
loader = getattr(spec, 'loader', None)
if loader is None:
loader = module_globals.get('__loader__')
get_source = getattr(loader, 'get_source', None)

if name and get_source:
def get_lines(name=name, *args, **kwargs):
return get_source(name, *args, **kwargs)
cache[filename] = (get_lines,)
return True
return False

if module_globals is not None and not isinstance(module_globals, dict):
raise TypeError(f'module_globals must be a dict, not {type(module_globals).__name__}')
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
raise TypeError(f'module_globals must be a dict, not {type(module_globals).__name__}')
raise TypeError(f'module_globals must be a dict, not {type(module_globals).__qualname__}')

if not module_globals or '__name__' not in module_globals:
return False

spec = module_globals.get('__spec__')
name = getattr(spec, 'name', None) or module_globals['__name__']
if name is None:
return False

loader = _bless_my_loader(module_globals)
if loader is None:
return False

get_source = getattr(loader, 'get_source', None)
if get_source is None:
return False

def get_lines(name=name, *args, **kwargs):
return get_source(name, *args, **kwargs)
cache[filename] = (get_lines,)
return True

def _bless_my_loader(module_globals):
# Similar to _bless_my_loader() in importlib._bootstrap_external,
# but always emits warnings instead of errors.
loader = module_globals.get('__loader__')
if loader is None and '__spec__' not in module_globals:
return None

spec = module_globals.get('__spec__')
spec_loader = getattr(spec, 'loader', None)
if spec_loader is None:
import warnings
warnings.warn(
'Module globals is missing a __spec__.loader',
DeprecationWarning)
return loader

assert spec_loader is not None
Copy link
Member

Choose a reason for hiding this comment

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

This assertion looks redundant.

if loader is not None and loader != spec_loader:
import warnings
warnings.warn(
'Module globals; __loader__ != __spec__.loader',
DeprecationWarning)
return loader

return spec_loader


def _register_code(code, string, name):
Expand Down
32 changes: 27 additions & 5 deletions Lib/test/test_linecache.py
Original file line number Diff line number Diff line change
Expand Up @@ -256,22 +256,44 @@ def raise_memoryerror(*args, **kwargs):
def test_loader(self):
filename = 'scheme://path'

for loader in (None, object(), NoSourceLoader()):
linecache.clearcache()
module_globals = {'__name__': 'a.b.c', '__loader__': None}
self.assertEqual(linecache.getlines(filename, module_globals), [])

for loader in object(), NoSourceLoader():
linecache.clearcache()
module_globals = {'__name__': 'a.b.c', '__loader__': loader}
self.assertEqual(linecache.getlines(filename, module_globals), [])
with self.assertWarns(DeprecationWarning) as w:
self.assertEqual(linecache.getlines(filename, module_globals), [])
self.assertEqual(str(w.warning),
'Module globals is missing a __spec__.loader')

linecache.clearcache()
module_globals = {'__name__': 'a.b.c', '__loader__': FakeLoader()}
self.assertEqual(linecache.getlines(filename, module_globals),
['source for a.b.c\n'])
with self.assertWarns(DeprecationWarning) as w:
self.assertEqual(linecache.getlines(filename, module_globals),
['source for a.b.c\n'])
self.assertEqual(str(w.warning),
'Module globals is missing a __spec__.loader')

for spec in (None, object(), ModuleSpec('', FakeLoader())):
for spec in None, object():
linecache.clearcache()
module_globals = {'__name__': 'a.b.c', '__loader__': FakeLoader(),
'__spec__': spec}
with self.assertWarns(DeprecationWarning) as w:
self.assertEqual(linecache.getlines(filename, module_globals),
['source for a.b.c\n'])
self.assertEqual(str(w.warning),
'Module globals is missing a __spec__.loader')

linecache.clearcache()
module_globals = {'__name__': 'a.b.c', '__loader__': FakeLoader(),
'__spec__': ModuleSpec('', FakeLoader())}
with self.assertWarns(DeprecationWarning) as w:
self.assertEqual(linecache.getlines(filename, module_globals),
['source for a.b.c\n'])
self.assertEqual(str(w.warning),
'Module globals; __loader__ != __spec__.loader')

linecache.clearcache()
spec = ModuleSpec('x.y.z', FakeLoader())
Expand Down
5 changes: 1 addition & 4 deletions Lib/test/test_warnings/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -652,7 +652,7 @@ def check_module_globals(self, module_globals):

def check_module_globals_error(self, module_globals, errmsg, errtype=ValueError):
if self.module is py_warnings:
self.check_module_globals(module_globals)
self.check_module_globals_deprecated(module_globals, errmsg)
return
with original_warnings.catch_warnings(module=self.module, record=True) as w:
self.module.filterwarnings('always')
Expand All @@ -663,9 +663,6 @@ def check_module_globals_error(self, module_globals, errmsg, errtype=ValueError)
self.assertEqual(len(w), 0)

def check_module_globals_deprecated(self, module_globals, msg):
if self.module is py_warnings:
self.check_module_globals(module_globals)
return
with original_warnings.catch_warnings(module=self.module, record=True) as w:
self.module.filterwarnings('always')
self.module.warn_explicit(
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
In the :mod:`linecache` module and in the Python implementation of the
:mod:`warnings` module, a ``DeprecationWarning`` is issued when
``m.__loader__`` differs from ``m.__spec__.loader`` (like in the C
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
``m.__loader__`` differs from ``m.__spec__.loader`` (like in the C
``mod.__loader__`` differs from ``mod.__spec__.loader`` (like in the C

implementation of the :mod:`!warnings` module).
Loading