Merge pull request #11262 from pradyunsg/reuse-environment-runner-sccript

Move `__pip-runner__` script into a module

Author: sbidoul

src/pip/__pip-runner__.py

@@ -0,0 +1,36 @@
+"""Execute exactly this copy of pip, within a different environment.
+
+This file is named as it is, to ensure that this module can't be imported via
+an import statement.
+"""
+
+import runpy
+import sys
+import types
+from importlib.machinery import ModuleSpec, PathFinder
+from os.path import dirname
+from typing import Optional, Sequence, Union
+
+PIP_SOURCES_ROOT = dirname(dirname(__file__))
+
+
+class PipImportRedirectingFinder:
+    @classmethod
+    def find_spec(
+        self,
+        fullname: str,
+        path: Optional[Sequence[Union[bytes, str]]] = None,
+        target: Optional[types.ModuleType] = None,
+    ) -> Optional[ModuleSpec]:
+        if fullname != "pip":
+            return None
+
+        spec = PathFinder.find_spec(fullname, [PIP_SOURCES_ROOT], target)
+        assert spec, (PIP_SOURCES_ROOT, fullname)
+        return spec
+
+
+sys.meta_path.insert(0, PipImportRedirectingFinder())
+
+assert __name__ == "__main__", "Cannot run __pip-runner__.py as a non-main module"
+runpy.run_module("pip", run_name="__main__", alter_sys=True)

src/pip/_internal/build_env.py

@@ -1,7 +1,6 @@
 """Build Environment used for isolation during sdist building
 """
 
-import contextlib
 import logging
 import os
 import pathlib
@@ -10,7 +9,7 @@
 from collections import OrderedDict
 from sysconfig import get_paths
 from types import TracebackType
-from typing import TYPE_CHECKING, Generator, Iterable, List, Optional, Set, Tuple, Type
+from typing import TYPE_CHECKING, Iterable, List, Optional, Set, Tuple, Type
 
 from pip._vendor.certifi import where
 from pip._vendor.packaging.requirements import Requirement
@@ -28,29 +27,6 @@
 
 logger = logging.getLogger(__name__)
 
-PIP_RUNNER = """
-import importlib.util
-import os
-import runpy
-import sys
-
-
-class PipImportRedirectingFinder:
-
-    @classmethod
-    def find_spec(cls, fullname, path=None, target=None):
-        if not fullname.startswith("pip."):
-            return None
-
-        # Import pip from the current source directory
-        location = os.path.join({source!r}, *fullname.split("."))
-        return importlib.util.spec_from_file_location(fullname, location)
-
-
-sys.meta_path.insert(0, PipImportRedirectingFinder())
-runpy.run_module("pip", run_name="__main__")
-"""
-
 
 class _Prefix:
     def __init__(self, path: str) -> None:
@@ -63,26 +39,20 @@ def __init__(self, path: str) -> None:
         self.lib_dirs = get_prefixed_libs(path)
 
 
-@contextlib.contextmanager
-def _create_runnable_pip() -> Generator[str, None, None]:
-    """Create a "pip runner" file.
+def _get_runnable_pip() -> str:
+    """Get a file to pass to a Python executable, to run the currently-running pip.
 
-    The runner file ensures that import for pip happens using the currently-running pip.
-    It will be used to install requirements into the build environment.
+    This is used to run a pip subprocess, for installing requirements into the build
+    environment.
     """
     source = pathlib.Path(pip_location).resolve().parent
 
-    # Return the current instance if `source` is not a directory. It likely
-    # means that this copy of pip is already standalone.
     if not source.is_dir():
-        yield str(source)
-        return
+        # This would happen if someone is using pip from inside a zip file. In that
+        # case, we can use that directly.
+        return str(source)
 
-    with TempDirectory(kind="standalone-pip") as tmp_dir:
-        pip_runner = os.path.join(tmp_dir.path, "__pip-runner__.py")
-        with open(pip_runner, "w", encoding="utf8") as f:
-            f.write(PIP_RUNNER.format(source=os.fsdecode(source)))
-        yield pip_runner
+    return os.fsdecode(source / "__pip-runner__.py")
 
 
 class BuildEnvironment:
@@ -223,15 +193,13 @@ def install_requirements(
         prefix.setup = True
         if not requirements:
             return
-        with contextlib.ExitStack() as ctx:
-            pip_runnable = ctx.enter_context(_create_runnable_pip())
-            self._install_requirements(
-                pip_runnable,
-                finder,
-                requirements,
-                prefix,
-                kind=kind,
-            )
+        self._install_requirements(
+            _get_runnable_pip(),
+            finder,
+            requirements,
+            prefix,
+            kind=kind,
+        )
 
     @staticmethod
     def _install_requirements(

tests/functional/test_pip_runner_script.py

@@ -0,0 +1,20 @@
+import os
+from pathlib import Path
+
+from pip import __version__
+from tests.lib import PipTestEnvironment
+
+
+def test_runner_work_in_environments_with_no_pip(
+    script: PipTestEnvironment, pip_src: Path
+) -> None:
+    runner = pip_src / "src" / "pip" / "__pip-runner__.py"
+
+    # Ensure there's no pip installed in the environment
+    script.pip("uninstall", "pip", "--yes", use_module=True)
+    script.pip("--version", expect_error=True)
+
+    # The runner script should still invoke a usable pip
+    result = script.run("python", os.fspath(runner), "--version")
+
+    assert __version__ in result.stdout