Repository navigation
Raise ImportWarning when loader.load_module() is used #70319
Description
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
assignee = None
closed_at = <Date 2020-12-07.21:27:33.787>
created_at = <Date 2016-01-15.21:44:04.899>
labels = ['interpreter-core', 'type-bug']
title = 'Raise ImportWarning when loader.load_module() is used'
updated_at = <Date 2020-12-14.13:06:12.676>
user = 'https://github.com/brettcannon'bugs.python.org fields:
activity = <Date 2020-12-14.13:06:12.676>
actor = 'vstinner'
assignee = 'none'
closed = True
closed_date = <Date 2020-12-07.21:27:33.787>
closer = 'brett.cannon'
components = ['Interpreter Core']
creation = <Date 2016-01-15.21:44:04.899>
creator = 'brett.cannon'
dependencies = []
files = []
hgrepos = []
issue_num = 26131
keywords = ['patch']
message_count = 14.0
messages = ['258333', '347561', '347580', '349284', '349286', '349287', '349295', '379389', '382548', '382796', '382799', '382801', '382874', '382986']
nosy_count = 8.0
nosy_names = ['brett.cannon', 'ncoghlan', 'vstinner', 'eric.snow', 'webknjaz', 'michaelanckaert', 'brandtbucher', 'nanjekyejoannah']
pr_nums = ['22905', '23469']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue26131'
versions = ['Python 3.6']
Activity
brettcannon commentedon Jan 15, 2016
Since loader.load_module() is documented as deprecated, we should consider raising an ImportWarning when it is used. That way when Python 2.7 support ends we can either remove it or have one more release where the various ImportWarnings turn into DeprecationWarnings and we finally clean up the import semantics to only be spec-based.
nanjekyejoannah commentedon Jul 9, 2019
@brett Since this was opened like years ago. Before I work on it, I was wondering If it is still relevant.
brettcannon commentedon Jul 9, 2019
@joannah no clue if this ever happened. Could you check the code if DeprecationWarning is being raised yet?
MichaelAnckaert commentedon Aug 9, 2019
I checked out the source (Lib/imp.py:219) and only see the docstring marking this method als Deprecated. No exceptions are being raised.
I would like to work on this issue.
MichaelAnckaert commentedon Aug 9, 2019
Clarification: the imp module shows a DeprecationWarning when imported. Was this what was meant?
nanjekyejoannah commentedon Aug 9, 2019
Feel free to open a PR.
brettcannon commentedon Aug 9, 2019
If you look at https://github.com/python/cpython/blob/master/Lib/importlib/_bootstrap.py and https://github.com/python/cpython/blob/master/Lib/importlib/_bootstrap_external.py you will notice a bunch of comments near all the calls to load_module(). Those are the places that should be somehow triggering a DeprecationWarning.
I think there's a compatibility shim function which would need to raise an exception so that anyone who has implemented load_module() as the only way to handle loading get a warning (but I think that requires certain loaders to have appropriate support which hopefully they have already but someone needs to double-check). After that every implementation of load_module() should have a warning.
brettcannon commentedon Oct 23, 2020
A PR is now up. I ended up deprecating the load_module() methods in importlib itself and then raise ImportWarning in the import system itself when falling back to load_module().
brettcannon commentedon Dec 4, 2020
New changeset 2de5097 by Brett Cannon in branch 'master':
bpo-26131: Deprecate usage of load_module() (GH-23469)
2de5097
brandtbucher commentedon Dec 9, 2020
I'm seeing the following test failure locally on master (doesn't seem to be showing up in CI though). I'm not too familiar with this stuff, but it looks related to this change:
======================================================================
FAIL: test_all (test.test___all__.AllTest) (module='distutils.command')
----------------------------------------------------------------------
Should we be ignoring the new warning in this test as well? I'm still not sure why I seem to be the only one seeing it.
brettcannon commentedon Dec 9, 2020
What is "VendorImporter" (see the message of the ImportWarning)? That's not in the stdlib, so it looks like your system is injecting something via some
.pthfile or environment variable that doesn't define exec_module().brandtbucher commentedon Dec 9, 2020
Yep, looks like that was it. Thanks!
webknjaz commentedon Dec 11, 2020
@brett.cannon
VendorImporteris something comping frompkg_resources. Because of an entangled traceback and the fact that it dynamically injects a vendored copy ofsix, it's hard to spot. Here's an upstream issue I filed about this warning: pypa/setuptools#2481.vstinner commentedon Dec 14, 2020
I wrote benjaminp/six#343 to fix the six module. I would appreciate a review.