Skip to content

gh-70319: Deprecate usage of load_module() #23469

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
brettcannon merged 12 commits into from
Dec 4, 2020
Merged

gh-70319: Deprecate usage of load_module() #23469

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
4c7284c
bpo-26131: deprecate the use of load_module()
brettcannon Oct 23, 2020
f05002b
Fix a grammatical error in a comment
brettcannon Oct 23, 2020
0c09542
Merge branch 'master' into deprecate-load_module
brettcannon Oct 27, 2020
57f6a12
Update to print out the loader's name in the ImportWarning
brettcannon Oct 27, 2020
7c54914
Merge branch 'master' into deprecate-load_module
brettcannon Nov 21, 2020
023cdaf
Deprecate zipimport's load_module() method
brettcannon Nov 21, 2020
0a3d4c9
Silence ImportWarning in test_venv
brettcannon Nov 21, 2020
7a673ac
Add a news entry for the zipimport deprecation
brettcannon Nov 22, 2020
15e6b70
Add a What's New entry for zipimport deprecation
brettcannon Nov 22, 2020
305d2a7
Tweak the deprecation message for zipimport
brettcannon Nov 22, 2020
5985e10
Re-generate zipimport
brettcannon Nov 22, 2020
9575bc2
Merge branch 'master' into deprecate-load_module
brettcannon Dec 4, 2020
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
Prev Previous commit
Next Next commit
Deprecate zipimport's load_module() method
  • Loading branch information
@brettcannon
brettcannon committed Nov 21, 2020
commit 023cdaf8db231484ef6fa3f20766261ad81b909a
51 changes: 31 additions & 20 deletions Lib/test/test_zipimport.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
import time
import unittest
import unittest.mock
import warnings

from test import support
from test.support import import_helper
Expand Down Expand Up @@ -453,15 +454,17 @@ def testZipImporterMethods(self):
self.assertTrue(zi.is_package(TESTPACK))

# PEP 302
find_mod = zi.find_module('spam')
self.assertIsNotNone(find_mod)
self.assertIsInstance(find_mod, zipimport.zipimporter)
self.assertFalse(find_mod.is_package('spam'))
load_mod = find_mod.load_module('spam')
self.assertEqual(find_mod.get_filename('spam'), load_mod.__file__)

mod = zi.load_module(TESTPACK)
self.assertEqual(zi.get_filename(TESTPACK), mod.__file__)
with warnings.catch_warnings():
warnings.simplefilter("ignore", DeprecationWarning)
find_mod = zi.find_module('spam')
self.assertIsNotNone(find_mod)
self.assertIsInstance(find_mod, zipimport.zipimporter)
self.assertFalse(find_mod.is_package('spam'))
load_mod = find_mod.load_module('spam')
self.assertEqual(find_mod.get_filename('spam'), load_mod.__file__)

mod = zi.load_module(TESTPACK)
self.assertEqual(zi.get_filename(TESTPACK), mod.__file__)

# PEP 451
spec = zi.find_spec('spam')
Expand Down Expand Up @@ -522,8 +525,10 @@ def testZipImporterMethodsInSubDirectory(self):
self.assertEqual(zi.prefix, packdir)
self.assertTrue(zi.is_package(TESTPACK2))
# PEP 302
mod = zi.load_module(TESTPACK2)
self.assertEqual(zi.get_filename(TESTPACK2), mod.__file__)
with warnings.catch_warnings():
warnings.simplefilter("ignore", DeprecationWarning)
mod = zi.load_module(TESTPACK2)
self.assertEqual(zi.get_filename(TESTPACK2), mod.__file__)
# PEP 451
spec = zi.find_spec(TESTPACK2)
mod = importlib.util.module_from_spec(spec)
Expand All @@ -536,13 +541,15 @@ def testZipImporterMethodsInSubDirectory(self):
pkg_path = TEMP_ZIP + os.sep + packdir + TESTPACK2
zi2 = zipimport.zipimporter(pkg_path)
# PEP 302
find_mod_dotted = zi2.find_module(TESTMOD)
self.assertIsNotNone(find_mod_dotted)
self.assertIsInstance(find_mod_dotted, zipimport.zipimporter)
self.assertFalse(zi2.is_package(TESTMOD))
load_mod = find_mod_dotted.load_module(TESTMOD)
self.assertEqual(
find_mod_dotted.get_filename(TESTMOD), load_mod.__file__)
with warnings.catch_warnings():
warnings.simplefilter("ignore", DeprecationWarning)
find_mod_dotted = zi2.find_module(TESTMOD)
self.assertIsNotNone(find_mod_dotted)
self.assertIsInstance(find_mod_dotted, zipimport.zipimporter)
self.assertFalse(zi2.is_package(TESTMOD))
load_mod = find_mod_dotted.load_module(TESTMOD)
self.assertEqual(
find_mod_dotted.get_filename(TESTMOD), load_mod.__file__)

# PEP 451
spec = zi2.find_spec(TESTMOD)
Expand Down Expand Up @@ -778,10 +785,12 @@ def _testBogusZipFile(self):
z = zipimport.zipimporter(TESTMOD)

try:
with warnings.catch_warnings():
warnings.simplefilter("ignore", DeprecationWarning)
self.assertRaises(TypeError, z.load_module, None)
self.assertRaises(TypeError, z.find_module, None)
self.assertRaises(TypeError, z.find_spec, None)
self.assertRaises(TypeError, z.exec_module, None)
self.assertRaises(TypeError, z.load_module, None)
self.assertRaises(TypeError, z.is_package, None)
self.assertRaises(TypeError, z.get_code, None)
self.assertRaises(TypeError, z.get_data, None)
Expand All @@ -791,7 +800,9 @@ def _testBogusZipFile(self):
self.assertIsNone(z.find_module('abc'))
self.assertIsNone(z.find_spec('abc'))

self.assertRaises(error, z.load_module, 'abc')
with warnings.catch_warnings():
warnings.simplefilter("ignore", DeprecationWarning)
self.assertRaises(error, z.load_module, 'abc')
self.assertRaises(error, z.get_code, 'abc')
self.assertRaises(OSError, z.get_data, 'abc')
self.assertRaises(error, z.get_source, 'abc')
Expand Down
4 changes: 4 additions & 0 deletions Lib/zipimport.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import marshal # for loads
import sys # for modules
import time # for mktime
import _warnings # For warn()

__all__ = ['ZipImportError', 'zipimporter']

Expand Down Expand Up @@ -270,6 +271,9 @@ def load_module(self, fullname):

Deprecated since Python 3.10. use exec_module() instead.
"""
msg = ("the load_module() method is deprecated and slated for removal in "
"Python 3.12; use exec_module() instead")
_warnings.warn(msg, DeprecationWarning)
code, ispackage, modpath = _get_module_code(self, fullname)
mod = sys.modules.get(fullname)
if mod is None or not isinstance(mod, _module_type):
Expand Down
Loading