DeprecationWarning: the imp module is deprecated in favour of importlib

[noelleleigh]

When running a Django project using ddtrace with warnings enabled, this warning is emitted:

Issue

/usr/local/lib/python3.7/dist-packages/ddtrace/bootstrap/sitecustomize.py:7: DeprecationWarning: the imp module is deprecated in favour of importlib; see the module's documentation for alternative uses

Details

The line in question:

dd-trace-py/ddtrace/bootstrap/sitecustomize.py

Line 7 in 9414832

import imp

How it's used:

dd-trace-py/ddtrace/bootstrap/sitecustomize.py

Lines 103 to 120 in 9414832

	# Ensure sitecustomize.py is properly called if available in application directories:
	# * exclude `bootstrap_dir` from the search
	# * find a user `sitecustomize.py` module
	# * import that module via `imp`
	bootstrap_dir = os.path.dirname(__file__)
	path = list(sys.path)
	if bootstrap_dir in path:
	path.remove(bootstrap_dir)
	try:
	(f, path, description) = imp.find_module("sitecustomize", path)
	except ImportError:
	pass
	else:
	# `sitecustomize.py` found, load it
	log.debug("sitecustomize from user found in: %s", path)
	imp.load_module("sitecustomize", f, path, description)

Documentation note for imp.find_module():

Deprecated since version 3.3: Use importlib.util.find_spec() instead unless Python 3.3 compatibility is required, in which case use importlib.find_loader(). For example usage of the former case, see the Examples section of the importlib documentation.

Documentation note for imp.load_module():

Deprecated since version 3.3: If previously used in conjunction with imp.find_module() then consider using importlib.import_module(), otherwise use the loader returned by the replacement you chose for imp.find_module(). If you called imp.load_module() and related functions directly with file path arguments then use a combination of importlib.util.spec_from_file_location() and importlib.util.module_from_spec(). See the Examples section of the importlib documentation for details of the various approaches.

Resolution

I suspect this example could be worth building off of to do the necessary path customization.

[Kyle-Verhoog]

Thanks for the report @noelleleigh! We'll target upgrading to importlib for version 0.45.