Skip to content

Commit e4f41de

Browse files
brettcannonbrettcannon
committed
Issue #17177: The imp module is pending deprecation.
To make sure there is no issue with code that is both Python 2 and 3 compatible, there are no plans to remove the module any sooner than Python 4 (unless the community moves to Python 3 solidly before then).
1 parent 39295e7 commit e4f41de

File tree

15 files changed

+103
-85
lines changed

15 files changed

+103
-85
lines changed

‎Doc/library/imp.rst‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
================================================================
33

44
.. deprecated:: 3.4
5-
The :mod:`imp` package has been deprecated in favor of :mod:`importlib`.
5+
The :mod:`imp` package is pending deprecation in favor of :mod:`importlib`.
66

77
.. module:: imp
88
:synopsis: Access the implementation of the import statement.
@@ -232,7 +232,7 @@ file paths.
232232
Return the :pep:`3147` magic tag string matching this version of Python's
233233
magic number, as returned by :func:`get_magic`.
234234

235-
.. note::
235+
.. deprecated:: 3.4
236236
You may use :attr:`sys.implementation.cache_tag` directly starting
237237
in Python 3.3.
238238

@@ -355,6 +355,9 @@ to indicate the search result of :func:`find_module`.
355355
``None`` is inserted into ``sys.path_importer_cache`` instead of an
356356
instance of :class:`NullImporter`.
357357

358+
.. deprecated:: 3.4
359+
Insert ``None`` into ``sys.path_importer_cache`` instead.
360+
358361

359362
.. _examples-imp:
360363

‎Doc/whatsnew/3.4.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,9 @@ Deprecated Python modules, functions and methods
230230
:meth:`importlib.abc.Loader.init_module_attrs` allows subclasses of a loader
231231
to more easily customize module loading.
232232

233+
* The :mod:`imp` module is pending deprecation. To keep compatibility with
234+
Python 2/3 code bases, the module's removal is currently not scheduled.
235+
233236

234237
Deprecated functions and types of the C API
235238
-------------------------------------------

‎Lib/imp.py‎

Lines changed: 42 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@
2727
import types
2828
import warnings
2929

30+
warnings.warn("the imp module is deprecated in favour of importlib; "
31+
"see the module's documentation for alternative uses",
32+
PendingDeprecationWarning)
3033

3134
# DEPRECATED
3235
SEARCH_ERROR = 0
@@ -98,9 +101,7 @@ def source_from_cache(path):
98101

99102

100103
def get_suffixes():
101-
warnings.warn('imp.get_suffixes() is deprecated; use the constants '
102-
'defined on importlib.machinery instead',
103-
DeprecationWarning, 2)
104+
"""**DEPRECATED**"""
104105
extensions = [(s, 'rb', C_EXTENSION) for s in machinery.EXTENSION_SUFFIXES]
105106
source = [(s, 'U', PY_SOURCE) for s in machinery.SOURCE_SUFFIXES]
106107
bytecode = [(s, 'rb', PY_COMPILED) for s in machinery.BYTECODE_SUFFIXES]
@@ -110,7 +111,11 @@ def get_suffixes():
110111

111112
class NullImporter:
112113

113-
"""Null import object."""
114+
"""**DEPRECATED**
115+
116+
Null import object.
117+
118+
"""
114119

115120
def __init__(self, path):
116121
if path == '':
@@ -152,10 +157,6 @@ class _LoadSourceCompatibility(_HackedGetData, machinery.SourceFileLoader):
152157

153158

154159
def load_source(name, pathname, file=None):
155-
msg = ('imp.load_source() is deprecated; use '
156-
'importlib.machinery.SourceFileLoader(name, pathname).load_module()'
157-
' instead')
158-
warnings.warn(msg, DeprecationWarning, 2)
159160
_LoadSourceCompatibility(name, pathname, file).load_module(name)
160161
module = sys.modules[name]
161162
# To allow reloading to potentially work, use a non-hacked loader which
@@ -170,10 +171,7 @@ class _LoadCompiledCompatibility(_HackedGetData, SourcelessFileLoader):
170171

171172

172173
def load_compiled(name, pathname, file=None):
173-
msg = ('imp.load_compiled() is deprecated; use '
174-
'importlib.machinery.SourcelessFileLoader(name, pathname).'
175-
'load_module() instead ')
176-
warnings.warn(msg, DeprecationWarning, 2)
174+
"""**DEPRECATED**"""
177175
_LoadCompiledCompatibility(name, pathname, file).load_module(name)
178176
module = sys.modules[name]
179177
# To allow reloading to potentially work, use a non-hacked loader which
@@ -183,10 +181,7 @@ def load_compiled(name, pathname, file=None):
183181

184182

185183
def load_package(name, path):
186-
msg = ('imp.load_package() is deprecated; use either '
187-
'importlib.machinery.SourceFileLoader() or '
188-
'importlib.machinery.SourcelessFileLoader() instead')
189-
warnings.warn(msg, DeprecationWarning, 2)
184+
"""**DEPRECATED**"""
190185
if os.path.isdir(path):
191186
extensions = (machinery.SOURCE_SUFFIXES[:] +
192187
machinery.BYTECODE_SUFFIXES[:])
@@ -208,32 +203,30 @@ def load_module(name, file, filename, details):
208203
209204
"""
210205
suffix, mode, type_ = details
211-
with warnings.catch_warnings():
212-
warnings.simplefilter('ignore')
213-
if mode and (not mode.startswith(('r', 'U')) or '+' in mode):
214-
raise ValueError('invalid file open mode {!r}'.format(mode))
215-
elif file is None and type_ in {PY_SOURCE, PY_COMPILED}:
216-
msg = 'file object required for import (type code {})'.format(type_)
217-
raise ValueError(msg)
218-
elif type_ == PY_SOURCE:
219-
return load_source(name, filename, file)
220-
elif type_ == PY_COMPILED:
221-
return load_compiled(name, filename, file)
222-
elif type_ == C_EXTENSION and load_dynamic is not None:
223-
if file is None:
224-
with open(filename, 'rb') as opened_file:
225-
return load_dynamic(name, filename, opened_file)
226-
else:
227-
return load_dynamic(name, filename, file)
228-
elif type_ == PKG_DIRECTORY:
229-
return load_package(name, filename)
230-
elif type_ == C_BUILTIN:
231-
return init_builtin(name)
232-
elif type_ == PY_FROZEN:
233-
return init_frozen(name)
206+
if mode and (not mode.startswith(('r', 'U')) or '+' in mode):
207+
raise ValueError('invalid file open mode {!r}'.format(mode))
208+
elif file is None and type_ in {PY_SOURCE, PY_COMPILED}:
209+
msg = 'file object required for import (type code {})'.format(type_)
210+
raise ValueError(msg)
211+
elif type_ == PY_SOURCE:
212+
return load_source(name, filename, file)
213+
elif type_ == PY_COMPILED:
214+
return load_compiled(name, filename, file)
215+
elif type_ == C_EXTENSION and load_dynamic is not None:
216+
if file is None:
217+
with open(filename, 'rb') as opened_file:
218+
return load_dynamic(name, filename, opened_file)
234219
else:
235-
msg = "Don't know how to import {} (type code {})".format(name, type_)
236-
raise ImportError(msg, name=name)
220+
return load_dynamic(name, filename, file)
221+
elif type_ == PKG_DIRECTORY:
222+
return load_package(name, filename)
223+
elif type_ == C_BUILTIN:
224+
return init_builtin(name)
225+
elif type_ == PY_FROZEN:
226+
return init_frozen(name)
227+
else:
228+
msg = "Don't know how to import {} (type code {})".format(name, type_)
229+
raise ImportError(msg, name=name)
237230

238231

239232
def find_module(name, path=None):
@@ -269,16 +262,14 @@ def find_module(name, path=None):
269262
file_path = os.path.join(package_directory, package_file_name)
270263
if os.path.isfile(file_path):
271264
return None, package_directory, ('', '', PKG_DIRECTORY)
272-
with warnings.catch_warnings():
273-
warnings.simplefilter('ignore')
274-
for suffix, mode, type_ in get_suffixes():
275-
file_name = name + suffix
276-
file_path = os.path.join(entry, file_name)
277-
if os.path.isfile(file_path):
278-
break
279-
else:
280-
continue
281-
break # Break out of outer loop when breaking out of inner loop.
265+
for suffix, mode, type_ in get_suffixes():
266+
file_name = name + suffix
267+
file_path = os.path.join(entry, file_name)
268+
if os.path.isfile(file_path):
269+
break
270+
else:
271+
continue
272+
break # Break out of outer loop when breaking out of inner loop.
282273
else:
283274
raise ImportError(_ERR_MSG.format(name), name=name)
284275

‎Lib/inspect.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@
3131
__author__ = ('Ka-Ping Yee <ping@lfw.org>',
3232
'Yury Selivanov <yselivanov@sprymix.com>')
3333

34-
import imp
3534
import importlib.machinery
3635
import itertools
3736
import linecache
@@ -440,6 +439,9 @@ def getmoduleinfo(path):
440439
"""Get the module name, suffix, mode, and module type for a given file."""
441440
warnings.warn('inspect.getmoduleinfo() is deprecated', DeprecationWarning,
442441
2)
442+
with warnings.catch_warnings():
443+
warnings.simplefilter('ignore', PendingDeprecationWarning)
444+
import imp
443445
filename = os.path.basename(path)
444446
suffixes = [(-len(suffix), suffix, mode, mtype)
445447
for suffix, mode, mtype in imp.get_suffixes()]

‎Lib/modulefinder.py‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
"""Find modules used by a script, using introspection."""
22

33
import dis
4-
import imp
54
import importlib.machinery
65
import marshal
76
import os
87
import sys
98
import types
109
import struct
10+
import warnings
11+
with warnings.catch_warnings():
12+
warnings.simplefilter('ignore', PendingDeprecationWarning)
13+
import imp
1114

1215
# XXX Clean up once str8's cstor matches bytes.
1316
LOAD_CONST = bytes([dis.opname.index('LOAD_CONST')])

‎Lib/pkgutil.py‎

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
"""Utilities to support packages."""
22

33
from functools import singledispatch as simplegeneric
4-
import imp
54
import importlib
5+
import importlib.util
66
import os
77
import os.path
88
import sys
99
from types import ModuleType
10-
from warnings import warn
10+
import warnings
1111

1212
__all__ = [
1313
'get_importer', 'iter_importers', 'get_loader', 'find_loader',
@@ -21,7 +21,7 @@ def read_code(stream):
2121
import marshal
2222

2323
magic = stream.read(4)
24-
if magic != imp.get_magic():
24+
if magic != importlib.util.MAGIC_NUMBER:
2525
return None
2626

2727
stream.read(8) # Skip timestamp and size
@@ -160,6 +160,13 @@ def _iter_file_finder_modules(importer, prefix=''):
160160
iter_importer_modules.register(
161161
importlib.machinery.FileFinder, _iter_file_finder_modules)
162162

163+
164+
def _import_imp():
165+
global imp
166+
with warnings.catch_warnings():
167+
warnings.simplefilter('ignore', PendingDeprecationWarning)
168+
imp = importlib.import_module('imp')
169+
163170
class ImpImporter:
164171
"""PEP 302 Importer that wraps Python's "classic" import algorithm
165172
@@ -172,8 +179,10 @@ class ImpImporter:
172179
"""
173180

174181
def __init__(self, path=None):
175-
warn("This emulation is deprecated, use 'importlib' instead",
182+
global imp
183+
warnings.warn("This emulation is deprecated, use 'importlib' instead",
176184
DeprecationWarning)
185+
_import_imp()
177186
self.path = path
178187

179188
def find_module(self, fullname, path=None):
@@ -238,8 +247,9 @@ class ImpLoader:
238247
code = source = None
239248

240249
def __init__(self, fullname, file, filename, etc):
241-
warn("This emulation is deprecated, use 'importlib' instead",
242-
DeprecationWarning)
250+
warnings.warn("This emulation is deprecated, use 'importlib' instead",
251+
DeprecationWarning)
252+
_import_imp()
243253
self.file = file
244254
self.filename = filename
245255
self.fullname = fullname

‎Lib/runpy.py‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313
import os
1414
import sys
1515
import importlib.machinery # importlib first so we can test #15386 via -m
16-
import imp
1716
import types
1817
from pkgutil import read_code, get_loader, get_importer
1918

@@ -224,7 +223,12 @@ def run_path(path_name, init_globals=None, run_name=None):
224223
run_name = "<run_path>"
225224
pkg_name = run_name.rpartition(".")[0]
226225
importer = get_importer(path_name)
227-
if isinstance(importer, (type(None), imp.NullImporter)):
226+
# Trying to avoid importing imp so as to not consume the deprecation warning.
227+
is_NullImporter = False
228+
if type(importer).__module__ == 'imp':
229+
if type(importer).__name__ == 'NullImporter':
230+
is_NullImporter = True
231+
if isinstance(importer, type(None)) or is_NullImporter:
228232
# Not a valid sys.path entry, so run the code directly
229233
# execfile() doesn't help as we want to allow compiled files
230234
code, mod_loader = _get_code_from_file(run_name, path_name)

‎Lib/test/test_fork1.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""This test checks for correct fork() behavior.
22
"""
33

4-
import imp
4+
import _imp as imp
55
import os
66
import signal
77
import sys

‎Lib/test/test_imp.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
import _thread
33
except ImportError:
44
_thread = None
5-
import imp
65
import importlib
76
import os
87
import os.path
@@ -11,6 +10,9 @@
1110
from test import support
1211
import unittest
1312
import warnings
13+
with warnings.catch_warnings():
14+
warnings.simplefilter('ignore', PendingDeprecationWarning)
15+
import imp
1416

1517

1618
def requires_load_dynamic(meth):

0 commit comments

Comments
 (0)