Skip to content

Commit

Permalink
Warn the user when distutils is present to discourage this usage and …
Browse files Browse the repository at this point in the history
…direct users to the recommended usage. Closes #2230.
  • Loading branch information
jaraco committed Jul 12, 2020
1 parent 6ecd778 commit 03c5c77
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion setuptools/distutils_patch.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,26 @@
import warnings


is_pypy = '__pypy__' in sys.builtin_module_names


def warn_distutils_present():
if 'distutils' not in sys.modules:
return
if is_pypy and sys.version_info < (3, 7):
# PyPy for 3.6 unconditionally imports distutils, so bypass the warning
# https://foss.heptapod.net/pypy/pypy/-/blob/be829135bc0d758997b3566062999ee8b23872b4/lib-python/3/site.py#L250
return
warnings.warn(
"Distutils was imported before Setuptools. This usage is discouraged "
"and may exhibit undesirable behaviors or errors. Please use "
"Setuptools' objects directly or at least import Setuptools first.")


def clear_distutils():
if 'distutils' not in sys.modules:
return
warnings.warn("Setuptools is replacing distutils")
warnings.warn("Setuptools is replacing distutils.")
mods = [name for name in sys.modules if re.match(r'distutils\b', name)]
for name in mods:
del sys.modules[name]
Expand All @@ -40,5 +56,6 @@ def ensure_local_distutils():
assert '_distutils' in core.__file__, core.__file__


warn_distutils_present()
if enabled():
ensure_local_distutils()

0 comments on commit 03c5c77

Please sign in to comment.