Restore 'add_shim' as the way to invoke the hook. Avoids compatibilit…

…y issues between different versions of Setuptools with the distutils local implementation. Renamed the former 'add_shim' as 'insert_shim'. Fixes #2983
pypa · Dec 29, 2021 · d0da014 · d0da014
1 parent b324f92
commit d0da014
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 5 deletions.
diff --git a/_distutils_hack/__init__.py b/_distutils_hack/__init__.py
@@ -136,20 +136,20 @@ def frame_file_is_setup(frame):
 DISTUTILS_FINDER = DistutilsMetaFinder()
 
 
-def ensure_shim():
-    DISTUTILS_FINDER in sys.meta_path or add_shim()
+def add_shim():
+    DISTUTILS_FINDER in sys.meta_path or insert_shim()
 
 
 @contextlib.contextmanager
 def shim():
-    add_shim()
+    insert_shim()
     try:
         yield
     finally:
         remove_shim()
 
 
-def add_shim():
+def insert_shim():
     sys.meta_path.insert(0, DISTUTILS_FINDER)
 
 

diff --git a/changelog.d/2983.misc.rst b/changelog.d/2983.misc.rst
@@ -0,0 +1 @@
+Restore 'add_shim' as the way to invoke the hook. Avoids compatibility issues between different versions of Setuptools with the distutils local implementation.
diff --git a/setup.py b/setup.py
@@ -55,7 +55,7 @@ class install_with_pth(install):
         import os
         var = 'SETUPTOOLS_USE_DISTUTILS'
         enabled = os.environ.get(var, 'local') == 'local'
-        enabled and __import__('_distutils_hack').ensure_shim()
+        enabled and __import__('_distutils_hack').add_shim()
         """).lstrip().replace('\n', '; ')
 
     def initialize_options(self):
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Restore 'add_shim' as the way to invoke the hook. Avoids compatibility issues between different versions of Setuptools with the distutils local implementation.