8000 bpo-42135: Deprecate implementations of find_module() and find_loader… · python/cpython@57c6cb5 · GitHub
[go: up one dir, main page]
Skip to content

Commit 57c6cb5

Browse files
brettcannonbrettcannon
authored
bpo-42135: Deprecate implementations of find_module() and find_loader() (GH-25169)
1 parent efccff9 commit 57c6cb5

20 files changed

+3808
-3640
lines changed

‎Doc/library/importlib.rst

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,10 @@ ABC hierarchy::
257257
Returns ``None`` when called instead of raising
258258
:exc:`NotImplementedError`.
259259

260+
.. deprecated:: 3.10
261+
Implement :meth:`MetaPathFinder.find_spec` or
262+
:meth:`PathEntryFinder.find_spec` instead.
263+
260264

261265
.. class:: MetaPathFinder
262266

@@ -265,6 +269,9 @@ ABC hierarchy::
265269

266270
.. versionadded:: 3.3
267271

272+
.. versionchanged:: 3.10
273+
No longer a subclass of :class:`Finder`.
274+
268275
.. method:: find_spec(fullname, path, target=None)
269276

270277
An abstract method for finding a :term:`spec <module spec>` for
@@ -313,11 +320,13 @@ ABC hierarchy::
313320
An abstract base class representing a :term:`path entry finder`. Though
314321
it bears some similarities to :class:`MetaPathFinder`, ``PathEntryFinder``
315322
is meant for use only within the path-based import subsystem provided
316-
by :class:`PathFinder`. This ABC is a subclass of :class:`Finder` for
317-
compatibility reasons only.
323+
by :class:`importlib.machinery.PathFinder`.
318324

319325
.. versionadded:: 3.3
320326

327+
.. versionchanged:: 3.10
328+
No longer a subclass of :class:`Finder`.
329+
321330
.. method:: find_spec(fullname, target=None)
322331

323332
An abstract method for finding a :term:`spec <module spec>` for
@@ -363,7 +372,8 @@ ABC hierarchy::
363372
.. method:: invalidate_caches()
364373

365374
An optional method which, when called, should invalidate any internal
366-
cache used by the finder. Used by :meth:`PathFinder.invalidate_caches`
375+
cache used by the finder. Used by
376+
:meth:`importlib.machinery.PathFinder.invalidate_caches`
367377
when invalidating the caches of all cached finders.
368378

369379

@@ -1193,6 +1203,9 @@ find and load modules.
11931203

11941204
Attempt to find the loader to handle *fullname* within :attr:`path`.
11951205

1206+
.. deprecated:: 3.10
1207+
Use :meth:`find_spec` instead.
1208+
11961209
.. method:: invalidate_caches()
11971210

11981211
Clear out the internal cache.

‎Doc/whatsnew/3.10.rst

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1062,6 +1062,39 @@ Deprecated
10621062
:func:`importlib.util.spec_from_loader` to help in porting.
10631063
(Contributed by Brett Cannon in :issue:`43672`.)
10641064
1065+
* The various implementations of
1066+
:meth:`importlib.abc.MetaPathFinder.find_module` (
1067+
:meth:`importlib.machinery.BuiltinImporter.find_module`,
1068+
:meth:`importlib.machinery.FrozenImporter.find_module`,
1069+
:meth:`importlib.machinery.WindowsRegistryFinder.find_module`,
1070+
:meth:`importlib.machinery.PathFinder.find_module`,
1071+
:meth:`importlib.abc.MetaPathFinder.find_module`),
1072+
:meth:`importlib.abc.PathEntryFinder.find_module` (
1073+
:meth:`importlib.machinery.FileFinder.find_module`,
1074+
), and
1075+
:meth:`importlib.abc.PathEntryFinder.find_loader` (
1076+
:meth:`importlib.machinery.FileFinder.find_loader`
1077+
) now raise :exc:`DeprecationWarning` and are slated for removal in
1078+
Python 3.12 (previously they were documented as deprecated in Python 3.4).
1079+
(Contributed by Brett Cannon in :issue:`42135`.)
1080+
1081+
* :class:`importlib.abc.Finder` is deprecated (including its sole method,
1082+
:meth:`~importlib.abc.Finder.find_module`). Both
1083+
:class:`importlib.abc.MetaPathFinder` and :class:`importlib.abc.PathEntryFinder`
1084+
no longer inherit from the class. Users should inherit from one of these two
1085+
classes as appropriate instead.
1086+
(Contributed by Brett Cannon in :issue:`42135`.)
1087+
1088+
* The deprecations of :mod:`imp`, :func:`importlib.find_loader`,
1089+
:func:`importlib.util.set_package_wrapper`,
1090+
:func:`importlib.util.set_loader_wrapper`,
1091+
:func:`importlib.util.module_for_loader`,
1092+
:class:`pkgutil.ImpImporter`, and
1093+
:class:`pkgutil.ImpLoader` have all been updated to list Python 3.12 as the
1094+
slated version of removal (they began raising :exc:`DeprecationWarning` in
1095+
previous versions of Python).
1096+
(Contributed by Brett Cannon in :issue:`43720`.)
1097+
10651098
* The import system now uses the ``__spec__`` attribute on modules before
10661099
falling back on :meth:`~importlib.abc.Loader.module_repr` for a module's
10671100
``__repr__()`` method. Removal of the use of ``module_repr()`` is scheduled

‎Lib/importlib/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,8 @@ def find_loader(name, path=None):
7878
This function is deprecated in favor of importlib.util.find_spec().
7979
8080
"""
81-
warnings.warn('Deprecated since Python 3.4. '
82-
'Use importlib.util.find_spec() instead.',
81+
warnings.warn('Deprecated since Python 3.4 and slated for removal in '
82+
'Python 3.10; use importlib.util.find_spec() instead',
8383
DeprecationWarning, stacklevel=2)
8484
try:
8585
loader = sys.modules[name].__loader__

‎Lib/importlib/_bootstrap.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -761,6 +761,9 @@ def find_module(cls, fullname, path=None):
761761
This method is deprecated. Use find_spec() instead.
762762
763763
"""
764+
_warnings.warn("BuiltinImporter.find_module() is deprecated and "
765+
"slated for removal in Python 3.12; use find_spec() instead",
766+
DeprecationWarning)
764767
spec = cls.find_spec(fullname, path)
765768
return spec.loader if spec is not None else None
766769

@@ -834,6 +837,9 @@ def find_module(cls, fullname, path=None):
834837
This method is deprecated. Use find_spec() instead.
835838
836839
"""
840+
_warnings.warn("FrozenImporter.find_module() is deprecated and "
841+
"slated for removal in Python 3.12; use find_spec() instead",
842+
DeprecationWarning)
837843
return cls if _imp.is_frozen(fullname) else None
838844

839845
@staticmethod

‎Lib/importlib/_bootstrap_external.py

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -533,6 +533,9 @@ def _find_module_shim(self, fullname):
533533
This method is deprecated in favor of finder.find_spec().
534534
535535
"""
536+
_warnings.warn("find_module() is deprecated and "
537+
"slated for removal in Python 3.12; use find_spec() instead",
538+
DeprecationWarning)
536539
# Call find_loader(). If it returns a string (indicating this
537540
# is a namespace package portion), generate a warning and
538541
# return None.
@@ -801,9 +804,12 @@ def find_spec(cls, fullname, path=None, target=None):
801804
def find_module(cls, fullname, path=None):
802805
"""Find module named in the registry.
803806
804-
This method is deprecated. Use exec_module() instead.
807+
This method is deprecated. Use find_spec() instead.
805808
806809
"""
810+
_warnings.warn("WindowsRegistryFinder.find_module() is deprecated and "
811+
"slated for removal in Python 3.12; use find_spec() instead",
812+
DeprecationWarning)
807813
spec = cls.find_spec(fullname, path)
808814
if spec is not None:
809815
return spec.loader
@@ -1404,6 +1410,9 @@ def find_module(cls, fullname, path=None):
14041410
This method is deprecated. Use find_spec() instead.
14051411
14061412
"""
1413+
_warnings.warn("PathFinder.find_module() is deprecated and "
1414+
"slated for removal in Python 3.12; use find_spec() instead",
1415+
DeprecationWarning)
14071416
spec = cls.find_spec(fullname, path)
14081417
if spec is None:
14091418
return None
@@ -1459,6 +1468,9 @@ def find_loader(self, fullname):
14591468
This method is deprecated. Use find_spec() instead.
14601469
14611470
"""
1471+
_warnings.warn("FileFinder.find_loader() is deprecated and "
1472+
"slated for removal in Python 3.12; use find_spec() instead",
1473+
DeprecationWarning)
14621474
spec = self.find_spec(fullname)
14631475
if spec is None:
14641476
return None, []

‎Lib/importlib/abc.py

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,27 @@ class Finder(metaclass=abc.ABCMeta):
4141
Deprecated since Python 3.3
4242
"""
4343

44+
def __init__(self):
45+
warnings.warn("the Finder ABC is deprecated and "
46+
"slated for removal in Python 3.12; use MetaPathFinder "
47+
"or PathEntryFinder instead",
48+
DeprecationWarning)
49+
4450
@abc.abstractmethod
4551
def find_module(self, fullname, path=None):
4652
"""An abstract method that should find a module.
4753
The fullname is a str and the optional path is a str or None.
4854
Returns a Loader object or None.
4955
"""
56+
warnings.warn("importlib.abc.Finder along with its find_module() "
57+
"method are deprecated and "
58+
"slated for removal in Python 3.12; use "
59+
"MetaPathFinder.find_spec() or "
60+
"PathEntryFinder.find_spec() instead",
61+
DeprecationWarning)
5062

5163

52-
class MetaPathFinder(Finder):
64+
class MetaPathFinder(metaclass=abc.ABCMeta):
5365

5466
"""Abstract base class for import finders on sys.meta_path."""
5567

@@ -68,8 +80,8 @@ def find_module(self, fullname, path):
6880
6981
"""
7082
warnings.warn("MetaPathFinder.find_module() is deprecated since Python "
71-
"3.4 in favor of MetaPathFinder.find_spec() "
72-
"(available since 3.4)",
83+
"3.4 in favor of MetaPathFinder.find_spec() and is "
84+
"slated for removal in Python 3.12",
7385
DeprecationWarning,
7486
stacklevel=2)
7587
if not hasattr(self, 'find_spec'):
@@ -86,7 +98,7 @@ def invalidate_caches(self):
8698
machinery.PathFinder, machinery.WindowsRegistryFinder)
8799

88100

89-
class PathEntryFinder(Finder):
101+
class PathEntryFinder(metaclass=abc.ABCMeta):
90102

91103
"""Abstract base class for path entry finders used by PathFinder."""
92104

‎Lib/test/test_importlib/builtin/test_finder.py

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
import sys
77
import unittest
8+
import warnings
89

910

1011
@unittest.skipIf(util.BUILTINS.good_name is None, 'no reasonable builtin module')
@@ -58,7 +59,9 @@ class FinderTests(abc.FinderTests):
5859
def test_module(self):
5960
# Common case.
6061
with util.uncache(util.BUILTINS.good_name):
61-
found = self.machinery.BuiltinImporter.find_module(util.BUILTINS.good_name)
62+
with warnings.catch_warnings():
63+
warnings.simplefilter("ignore", DeprecationWarning)
64+
found = self.machinery.BuiltinImporter.find_module(util.BUILTINS.good_name)
6265
self.assertTrue(found)
6366
self.assertTrue(hasattr(found, 'load_module'))
6467

@@ -70,14 +73,19 @@ def test_module(self):
7073

7174
def test_failure(self):
7275
assert 'importlib' not in sys.builtin_module_names
73-
loader = self.machinery.BuiltinImporter.find_module('importlib')
76+
with warnings.catch_warnings():
77+
warnings.simplefilter("ignore", DeprecationWarning)
78+
loader = self.machinery.BuiltinImporter.find_module('importlib')
7479
self.assertIsNone(loader)
7580

7681
def test_ignore_path(self):
7782
# The value for 'path' should always trigger a failed import.
7883
with util.uncache(util.BUILTINS.good_name):
79-
loader = self.machinery.BuiltinImporter.find_module(util.BUILTINS.good_name,
80-
['pkg'])
84+
with warnings.catch_warnings():
85+
warnings.simplefilter("ignore", DeprecationWarning)
86+
loader = self.machinery.BuiltinImporter.find_module(
87+
util.BUILTINS.good_name,
88+
['pkg'])
8189
self.assertIsNone(loader)
8290

8391

‎Lib/test/test_importlib/extension/test_case_sensitivity.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,30 +12,30 @@
1212
@util.case_insensitive_tests
1313
class ExtensionModuleCaseSensitivityTest(util.CASEOKTestBase):
1414

15-
def find_module(self):
15+
def find_spec(self):
1616
good_name = util.EXTENSIONS.name
1717
bad_name = good_name.upper()
1818
assert good_name != bad_name
1919
finder = self.machinery.FileFinder(util.EXTENSIONS.path,
2020
(self.machinery.ExtensionFileLoader,
2121
self.machinery.EXTENSION_SUFFIXES))
22-
return finder.find_module(bad_name)
22+
return finder.find_spec(bad_name)
2323

2424
@unittest.skipIf(sys.flags.ignore_environment, 'ignore_environment flag was set')
2525
def test_case_sensitive(self):
2626
with os_helper.EnvironmentVarGuard() as env:
2727
env.unset('PYTHONCASEOK')
2828
self.caseok_env_changed(should_exist=False)
29-
loader = self.find_module()
30-
self.assertIsNone(loader)
29+
spec = self.find_spec()
30+
self.assertIsNone(spec)
3131

3232
@unittest.skipIf(sys.flags.ignore_environment, 'ignore_environment flag was set')
3333
def test_case_insensitivity(self):
3434
with os_helper.EnvironmentVarGuard() as env:
3535
env.set('PYTHONCASEOK', '1')
3636
self.caseok_env_changed(should_exist=True)
37-
loader = self.find_module()
38-
self.assertTrue(hasattr(loader, 'load_module'))
37+
spec = self.find_spec()
38+
self.assertTrue(spec)
3939

4040

4141
(Frozen_ExtensionCaseSensitivity,

‎Lib/test/test_importlib/extension/test_finder.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,15 @@ class FinderTests(abc.FinderTests):
1111

1212
"""Test the finder for extension modules."""
1313

14-
def find_module(self, fullname):
14+
def find_spec(self, fullname):
1515
importer = self.machinery.FileFinder(util.EXTENSIONS.path,
1616
(self.machinery.ExtensionFileLoader,
1717
self.machinery.EXTENSION_SUFFIXES))
18-
with warnings.catch_warnings():
19-
warnings.simplefilter('ignore', DeprecationWarning)
20-
return importer.find_module(fullname)
18+
19+
return importer.find_spec(fullname)
2120

2221
def test_module(self):
23-
self.assertTrue(self.find_module(util.EXTENSIONS.name))
22+
self.assertTrue(self.find_spec(util.EXTENSIONS.name))
2423

2524
# No extension module as an __init__ available for testing.
2625
test_package = test_package_in_package = None
@@ -32,7 +31,7 @@ def test_module(self):
3231
test_package_over_module = None
3332

3433
def test_failure(self):
35-
self.assertIsNone(self.find_module('asdfjkl;'))
34+
self.assertIsNone(self.find_spec('asdfjkl;'))
3635

3736

3837
(Frozen_FinderTests,

‎Lib/test/test_importlib/frozen/test_finder.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
machinery = util.import_importlib('importlib.machinery')
55

66
import unittest
7+
import warnings
78

89

910
class FindSpecTests(abc.FinderTests):
@@ -49,7 +50,9 @@ class FinderTests(abc.FinderTests):
4950

5051
def find(self, name, path=None):
5152
finder = self.machinery.FrozenImporter
52-
return finder.find_module(name, path)
53+
with warnings.catch_warnings():
54+
warnings.simplefilter("ignore", DeprecationWarning)
55+
return finder.find_module(name, path)
5356

5457
def test_module(self):
5558
name = '__hello__'

‎Lib/test/test_importlib/frozen/test_loader.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ def test_module_repr_indirect(self):
7878
test_state_after_failure = None
7979

8080
def test_unloadable(self):
81-
assert self.machinery.FrozenImporter.find_module('_not_real') is None
81+
assert self.machinery.FrozenImporter.find_spec('_not_real') is None
8282
with self.assertRaises(ImportError) as cm:
8383
self.exec_module('_not_real')
8484
self.assertEqual(cm.exception.name, '_not_real')

‎Lib/test/test_importlib/import_/test_path.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,8 @@ def test_empty_path_hooks(self):
7575
with util.import_state(path_importer_cache={}, path_hooks=[],
7676
path=[path_entry]):
7777
with warnings.catch_warnings(record=True) as w:
78-
warnings.simplefilter('always')
78+
warnings.simplefilter('always', ImportWarning)
79+
warnings.simplefilter('ignore', DeprecationWarning)
7980
self.assertIsNone(self.find('os'))
8081
self.assertIsNone(sys.path_importer_cache[path_entry])
8182
self.assertEqual(len(w), 1)
@@ -216,7 +217,9 @@ def test_invalidate_caches_clear_out_None(self):
216217

217218
class FindModuleTests(FinderTests):
218219
def find(self, *args, **kwargs):
219-
return self.machinery.PathFinder.find_module(*args, **kwargs)
220+
with warnings.catch_warnings():
221+
warnings.simplefilter("ignore", DeprecationWarning)
222+
return self.machinery.PathFinder.find_module(*args, **kwargs)
220223
def check_found(self, found, importer):
221224
self.assertIs(found, importer)
222225

@@ -278,6 +281,7 @@ def find_module(fullname):
278281
path_hooks=[Finder]):
279282
with warnings.catch_warnings():
280283
warnings.simplefilter("ignore", ImportWarning)
284+
warnings.simplefilter("ignore", DeprecationWarning)
281285
self.machinery.PathFinder.find_module(< 4267 span class=pl-s>'importlib')
282286

283287

0 commit comments

Comments
 (0)
0