Jan 30, 2024 · Sep 10, 2023 · Sep 15, 2023 · Sep 16, 2023 · Sep 16, 2023 · Sep 16, 2023
diff --git a/Lib/ensurepip/__init__.py b/Lib/ensurepip/__init__.py
 import collections
 import os
 import os.path
 import subprocess
 import sys
 import sysconfig
 import tempfile
 from contextlib import nullcontext
 from importlib import resources
 from pathlib import Path
 from shutil import copy2


 __all__ = ["version", "bootstrap"]
 _PACKAGE_NAMES = ('pip',)
 _PIP_VERSION = "23.3.2"
 _PROJECTS = [
    ("pip", _PIP_VERSION, "py3"),
 ]

 # Packages bundled in ensurepip._bundled have wheel_name set.
 # Packages from WHEEL_PKG_DIR have wheel_path set.
 _Package = collections.namedtuple('Package',
                                  ('version', 'wheel_name', 'wheel_path'))

 # Directory of system wheel packages. Some Linux distribution packaging
 # policies recommend against bundling dependencies. For example, Fedora
 # installs wheel packages in the /usr/share/python-wheels/ directory and don't
 # install the ensurepip._bundled package.
 _WHEEL_PKG_DIR = sysconfig.get_config_var('WHEEL_PKG_DIR')
 if (_pkg_dir := sysconfig.get_config_var('WHEEL_PKG_DIR')) is not None:
    _WHEEL_PKG_DIR = Path(_pkg_dir).resolve()
 else:
    _WHEEL_PKG_DIR = None


 def _find_wheel_pkg_dir_pip():
    if _WHEEL_PKG_DIR is None:
        # NOTE: The compile-time `WHEEL_PKG_DIR` is unset so there is no place
        # NOTE: for looking up the wheels.
        return None

 def _find_packages(path):
    packages = {}
    dist_matching_wheels = _WHEEL_PKG_DIR.glob('pip-*.whl')
    try:
        filenames = os.listdir(path)
    except OSError:
        # Ignore: path doesn't exist or permission error
        filenames = ()
    # Make the code deterministic if a directory contains multiple wheel files
    # of the same package, but don't attempt to implement correct version
    # comparison since this case should not happen.
    filenames = sorted(filenames)
    for filename in filenames:
        # filename is like 'pip-21.2.4-py3-none-any.whl'
        if not filename.endswith(".whl"):
            continue
        for name in _PACKAGE_NAMES:
            prefix = name + '-'
            if filename.startswith(prefix):
                break
        else:
            continue

        # Extract '21.2.4' from 'pip-21.2.4-py3-none-any.whl'
        version = filename.removeprefix(prefix).partition('-')[0]
        wheel_path = os.path.join(path, filename)
        packages[name] = _Package(version, None, wheel_path)
    return packages


 def _get_packages():
    global _PACKAGES, _WHEEL_PKG_DIR
    if _PACKAGES is not None:
        return _PACKAGES

    packages = {}
    for name, version, py_tag in _PROJECTS:
        wheel_name = f"{name}-{version}-{py_tag}-none-any.whl"
        packages[name] = _Package(version, wheel_name, None)
    if _WHEEL_PKG_DIR:
        dir_packages = _find_packages(_WHEEL_PKG_DIR)
        # only used the wheel package directory if all packages are found there
        if all(name in dir_packages for name in _PACKAGE_NAMES):
            packages = dir_packages
    _PACKAGES = packages
    return packages
 _PACKAGES = None
        last_matching_dist_wheel = sorted(dist_matching_wheels)[-1]
    except IndexError:
        # NOTE: `WHEEL_PKG_DIR` does not contain any wheel files for `pip`.
        return None

    return nullcontext(last_matching_dist_wheel)


 def _get_pip_whl_path_ctx():
    # Prefer pip from the wheel package directory, if present.
    if (alternative_pip_wheel_path := _find_wheel_pkg_dir_pip()) is not None:
        return alternative_pip_wheel_path

    return resources.as_file(
        resources.files('ensurepip')
        / '_bundled'
        / f'pip-{_PIP_VERSION}-py3-none-any.whl'
    )


 def _get_pip_version():
    with _get_pip_whl_path_ctx() as bundled_wheel_path:
        wheel_name = bundled_wheel_path.name
        return (
            # Extract '21.2.4' from 'pip-21.2.4-py3-none-any.whl'
            wheel_name.
            removeprefix('pip-').
            partition('-')[0]
        )


 def _run_pip(args, additional_paths=None):
    """
    Returns a string specifying the bundled version of pip.
    """
    return_get_packages()['pip'].version
    return_get_pip_version()


 def _disable_pip_configuration_settings():
    with tempfile.TemporaryDirectory() as tmpdir:
        # Put our bundled wheels into a temporary directory and construct the
        # additional paths that need added to sys.path
        additional_paths = []
        for name, package in _get_packages().items():
            if package.wheel_name:
                # Use bundled wheel package
                wheel_name = package.wheel_name
                wheel_path = resources.files("ensurepip") / "_bundled" / wheel_name
                whl = wheel_path.read_bytes()
            else:
                # Use the wheel package directory
                with open(package.wheel_path, "rb") as fp:
                    whl = fp.read()
                wheel_name = os.path.basename(package.wheel_path)

            filename = os.path.join(tmpdir, wheel_name)
            with open(filename, "wb") as fp:
                fp.write(whl)

            additional_paths.append(filename)
        tmpdir_path = Path(tmpdir)
        with _get_pip_whl_path_ctx() as bundled_wheel_path:
            tmp_wheel_path = tmpdir_path / bundled_wheel_path.name
            copy2(bundled_wheel_path, tmp_wheel_path)

        # Construct the arguments to be passed to the pip command
        args = ["install", "--no-cache-dir", "--no-index", "--find-links", tmpdir]
        if verbosity:
            args += ["-" + "v" * verbosity]

        return _run_pip([*args, *_PACKAGE_NAMES], additional_paths)
        return _run_pip([*args, "pip"], [os.fsdecode(tmp_wheel_path)])


 def _uninstall_helper(*, verbosity=0):
    """Helper to support a clean default uninstall process on Windows
    if verbosity:
        args += ["-" + "v" * verbosity]

    return _run_pip([*args,*reversed(_PACKAGE_NAMES)])
    return _run_pip([*args,"pip"])


 def _main(argv=None):
diff --git a/Lib/test/test_ensurepip.py b/Lib/test/test_ensurepip.py
 import test.support
 import unittest
 import unittest.mock
 from importlib.resources.abc import Traversable
 from pathlib import Path

 import ensurepip
 import ensurepip._uninstall
        # Test version()
        with tempfile.TemporaryDirectory() as tmpdir:
            self.touch(tmpdir, "pip-1.2.3b1-py2.py3-none-any.whl")
            with (unittest.mock.patch.object(ensurepip, '_PACKAGES', None),
                  unittest.mock.patch.object(ensurepip, '_WHEEL_PKG_DIR', tmpdir)):
            with unittest.mock.patch.object(ensurepip, '_WHEEL_PKG_DIR', Path(tmpdir)):
                self.assertEqual(ensurepip.version(), '1.2.3b1')

    def test_get_packages_no_dir(self):
        # Test _get_packages() without a wheel package directory
        with (unittest.mock.patch.object(ensurepip, '_PACKAGES', None),
              unittest.mock.patch.object(ensurepip, '_WHEEL_PKG_DIR', None)):
            packages = ensurepip._get_packages()

            # when bundled wheel packages are used, we get _PIP_VERSION
    def test_version_no_dir(self):
        # Test version() without a wheel package directory
        with unittest.mock.patch.object(ensurepip, '_WHEEL_PKG_DIR', None):
            # when the bundled pip wheel is used, we get _PIP_VERSION
            self.assertEqual(ensurepip._PIP_VERSION, ensurepip.version())

        # use bundled wheel packages
        self.assertIsNotNone(packages['pip'].wheel_name)
    def test_selected_wheel_path_no_dir(self):
        pip_filename = f'pip-{ensurepip._PIP_VERSION}-py3-none-any.whl'
        with unittest.mock.patch.object(ensurepip, '_WHEEL_PKG_DIR', None):
            with ensurepip._get_pip_whl_path_ctx() as bundled_wheel_path:
                self.assertEqual(pip_filename, bundled_wheel_path.name)

    deftest_get_packages_with_dir(self):
        # Test_get_packages() with a wheel package directory
    deftest_selected_wheel_path_with_dir(self):
        # Test_get_pip_whl_path_ctx() with a wheel package directory
        pip_filename = "pip-20.2.2-py2.py3-none-any.whl"

        with tempfile.TemporaryDirectory() as tmpdir:
            self.touch(tmpdir, pip_filename)
            # not used, make sure that it's ignored
            # not used, make sure that they're ignored
            self.touch(tmpdir, "pip-1.2.3-py2.py3-none-any.whl")
            self.touch(tmpdir, "wheel-0.34.2-py2.py3-none-any.whl")
            self.touch(tmpdir, "pip-script.py")

            with (unittest.mock.patch.object(ensurepip, '_PACKAGES', None),
                  unittest.mock.patch.object(ensurepip, '_WHEEL_PKG_DIR', tmpdir)):
                packages = ensurepip._get_packages()

            self.assertEqual(packages['pip'].version, '20.2.2')
            self.assertEqual(packages['pip'].wheel_path,
                             os.path.join(tmpdir, pip_filename))

            # wheel package is ignored
            self.assertEqual(sorted(packages), ['pip'])
            with unittest.mock.patch.object(ensurepip, '_WHEEL_PKG_DIR', Path(tmpdir)):
                with ensurepip._get_pip_whl_path_ctx() as bundled_wheel_path:
                    self.assertEqual(pip_filename, bundled_wheel_path.name)


 class EnsurepipMixin:
        real_devnull = os.devnull
        os_patch = unittest.mock.patch("ensurepip.os")
        patched_os = os_patch.start()
        # But expose os.listdir() used by_find_packages()
        # But expose os.listdir() used by_find_wheel_pkg_dir_pip()
        patched_os.listdir = os.listdir
        self.addCleanup(os_patch.stop)
        patched_os.devnull = real_devnull
diff --git a/Tools/build/verify_ensurepip_wheels.py b/Tools/build/verify_ensurepip_wheels.py
 from pathlib import Path
 from urllib.request import urlopen

 PACKAGE_NAMES = ("pip",)
 ENSURE_PIP_ROOT = Path(__file__).parent.parent.parent / "Lib/ensurepip"
 WHEEL_DIR = ENSURE_PIP_ROOT / "_bundled"
 ENSURE_PIP_INIT_PY_TEXT = (ENSURE_PIP_ROOT / "__init__.py").read_text(encoding="utf-8")


 if __name__ == "__main__":
    exit_status = 0
    for package_name in PACKAGE_NAMES:
        if not verify_wheel(package_name):
            exit_status = 1
    exit_status = int(not verify_wheel("pip"))
    raise SystemExit(exit_status)
Original file line number	Diff line number	Diff line change
		@@ -1,78 +1,64 @@
		import collections
		import os
		import os.path
		import subprocess
		import sys
		import sysconfig
		import tempfile
		from contextlib import nullcontext
		from importlib import resources
		from pathlib import Path
		from shutil import copy2


		__all__ = ["version", "bootstrap"]
		_PACKAGE_NAMES = ('pip',)
		_PIP_VERSION = "23.3.2"
		_PROJECTS = [
		("pip", _PIP_VERSION, "py3"),
		]

		# Packages bundled in ensurepip._bundled have wheel_name set.
		# Packages from WHEEL_PKG_DIR have wheel_path set.
		_Package = collections.namedtuple('Package',
		('version', 'wheel_name', 'wheel_path'))

		# Directory of system wheel packages. Some Linux distribution packaging
		# policies recommend against bundling dependencies. For example, Fedora
		# installs wheel packages in the /usr/share/python-wheels/ directory and don't
		# install the ensurepip._bundled package.
		_WHEEL_PKG_DIR = sysconfig.get_config_var('WHEEL_PKG_DIR')
		if (_pkg_dir := sysconfig.get_config_var('WHEEL_PKG_DIR')) is not None:
		_WHEEL_PKG_DIR = Path(_pkg_dir).resolve()
		else:
		_WHEEL_PKG_DIR = None
pradyunsg marked this conversation as resolved. Show resolvedHide resolved


		def _find_wheel_pkg_dir_pip():
webknjaz marked this conversation as resolved. Show resolvedHide resolved
		if _WHEEL_PKG_DIR is None:
		# NOTE: The compile-time `WHEEL_PKG_DIR` is unset so there is no place
		# NOTE: for looking up the wheels.
		return None

		def _find_packages(path):
		packages = {}
		dist_matching_wheels = _WHEEL_PKG_DIR.glob('pip-*.whl')
		try:
		filenames = os.listdir(path)
		except OSError:
		# Ignore: path doesn't exist or permission error
		filenames = ()
		# Make the code deterministic if a directory contains multiple wheel files
		# of the same package, but don't attempt to implement correct version
		# comparison since this case should not happen.
		filenames = sorted(filenames)
		for filename in filenames:
		# filename is like 'pip-21.2.4-py3-none-any.whl'
		if not filename.endswith(".whl"):
		continue
		for name in _PACKAGE_NAMES:
		prefix = name + '-'
		if filename.startswith(prefix):
		break
		else:
		continue

		# Extract '21.2.4' from 'pip-21.2.4-py3-none-any.whl'
		version = filename.removeprefix(prefix).partition('-')[0]
		wheel_path = os.path.join(path, filename)
		packages[name] = _Package(version, None, wheel_path)
		return packages


		def _get_packages():
		global _PACKAGES, _WHEEL_PKG_DIR
		if _PACKAGES is not None:
		return _PACKAGES

		packages = {}
		for name, version, py_tag in _PROJECTS:
		wheel_name = f"{name}-{version}-{py_tag}-none-any.whl"
		packages[name] = _Package(version, wheel_name, None)
		if _WHEEL_PKG_DIR:
		dir_packages = _find_packages(_WHEEL_PKG_DIR)
		# only used the wheel package directory if all packages are found there
		if all(name in dir_packages for name in _PACKAGE_NAMES):
		packages = dir_packages
		_PACKAGES = packages
		return packages
		_PACKAGES = None
		last_matching_dist_wheel = sorted(dist_matching_wheels)[-1]
		except IndexError:
		# NOTE: `WHEEL_PKG_DIR` does not contain any wheel files for `pip`.
		return None
webknjaz marked this conversation as resolved. Show resolvedHide resolved

		return nullcontext(last_matching_dist_wheel)


		def _get_pip_whl_path_ctx():
		# Prefer pip from the wheel package directory, if present.
		if (alternative_pip_wheel_path := _find_wheel_pkg_dir_pip()) is not None:
		return alternative_pip_wheel_path

		return resources.as_file(
		resources.files('ensurepip')
		/ '_bundled'
		/ f'pip-{_PIP_VERSION}-py3-none-any.whl'
		)


		def _get_pip_version():
pradyunsg marked this conversation as resolved. Show resolvedHide resolved
		with _get_pip_whl_path_ctx() as bundled_wheel_path:
		wheel_name = bundled_wheel_path.name
		return (
		# Extract '21.2.4' from 'pip-21.2.4-py3-none-any.whl'
		wheel_name.
		removeprefix('pip-').
		partition('-')[0]
		)


		def _run_pip(args, additional_paths=None):
Expand DownExpand Up		@@ -105,7 +91,7 @@ def version():
		"""
		Returns a string specifying the bundled version of pip.
		"""
		return_get_packages()['pip'].version
		return_get_pip_version()
pradyunsg marked this conversation as resolved. Show resolvedHide resolved


		def _disable_pip_configuration_settings():
Expand DownExpand Up		@@ -167,24 +153,10 @@ def _bootstrap(*, root=None, upgrade=False, user=False,
		with tempfile.TemporaryDirectory() as tmpdir:
		# Put our bundled wheels into a temporary directory and construct the
		# additional paths that need added to sys.path
		additional_paths = []
		for name, package in _get_packages().items():
		if package.wheel_name:
		# Use bundled wheel package
		wheel_name = package.wheel_name
		wheel_path = resources.files("ensurepip") / "_bundled" / wheel_name
		whl = wheel_path.read_bytes()
		else:
		# Use the wheel package directory
		with open(package.wheel_path, "rb") as fp:
		whl = fp.read()
		wheel_name = os.path.basename(package.wheel_path)

		filename = os.path.join(tmpdir, wheel_name)
		with open(filename, "wb") as fp:
		fp.write(whl)

		additional_paths.append(filename)
		tmpdir_path = Path(tmpdir)
		with _get_pip_whl_path_ctx() as bundled_wheel_path:
		tmp_wheel_path = tmpdir_path / bundled_wheel_path.name
		copy2(bundled_wheel_path, tmp_wheel_path)

		# Construct the arguments to be passed to the pip command
		args = ["install", "--no-cache-dir", "--no-index", "--find-links", tmpdir]
Expand All		@@ -197,7 +169,8 @@ def _bootstrap(*, root=None, upgrade=False, user=False,
		if verbosity:
		args += ["-" + "v" * verbosity]

		return _run_pip([args, _PACKAGE_NAMES], additional_paths)
		return _run_pip([*args, "pip"], [os.fsdecode(tmp_wheel_path)])


		def _uninstall_helper(*, verbosity=0):
		"""Helper to support a clean default uninstall process on Windows
Expand DownExpand Up		@@ -227,7 +200,7 @@ def _uninstall_helper(*, verbosity=0):
		if verbosity:
		args += ["-" + "v" * verbosity]

		return _run_pip([args,reversed(_PACKAGE_NAMES)])
		return _run_pip([*args,"pip"])


		def _main(argv=None):
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,6 +6,8 @@
		import test.support
		import unittest
		import unittest.mock
		from importlib.resources.abc import Traversable
		from pathlib import Path

		import ensurepip
		import ensurepip._uninstall
Expand All		@@ -20,41 +22,35 @@ def test_version(self):
		# Test version()
		with tempfile.TemporaryDirectory() as tmpdir:
		self.touch(tmpdir, "pip-1.2.3b1-py2.py3-none-any.whl")
		with (unittest.mock.patch.object(ensurepip, '_PACKAGES', None),
		unittest.mock.patch.object(ensurepip, '_WHEEL_PKG_DIR', tmpdir)):
		with unittest.mock.patch.object(ensurepip, '_WHEEL_PKG_DIR', Path(tmpdir)):
		self.assertEqual(ensurepip.version(), '1.2.3b1')

		def test_get_packages_no_dir(self):
		# Test _get_packages() without a wheel package directory
		with (unittest.mock.patch.object(ensurepip, '_PACKAGES', None),
		unittest.mock.patch.object(ensurepip, '_WHEEL_PKG_DIR', None)):
		packages = ensurepip._get_packages()

		# when bundled wheel packages are used, we get _PIP_VERSION
		def test_version_no_dir(self):
		# Test version() without a wheel package directory
		with unittest.mock.patch.object(ensurepip, '_WHEEL_PKG_DIR', None):
		# when the bundled pip wheel is used, we get _PIP_VERSION
		self.assertEqual(ensurepip._PIP_VERSION, ensurepip.version())

		# use bundled wheel packages
		self.assertIsNotNone(packages['pip'].wheel_name)
		def test_selected_wheel_path_no_dir(self):
		pip_filename = f'pip-{ensurepip._PIP_VERSION}-py3-none-any.whl'
		with unittest.mock.patch.object(ensurepip, '_WHEEL_PKG_DIR', None):
		with ensurepip._get_pip_whl_path_ctx() as bundled_wheel_path:
		self.assertEqual(pip_filename, bundled_wheel_path.name)

		deftest_get_packages_with_dir(self):
		# Test_get_packages() with a wheel package directory
		deftest_selected_wheel_path_with_dir(self):
		# Test_get_pip_whl_path_ctx() with a wheel package directory
		pip_filename = "pip-20.2.2-py2.py3-none-any.whl"

		with tempfile.TemporaryDirectory() as tmpdir:
		self.touch(tmpdir, pip_filename)
		# not used, make sure that it's ignored
		# not used, make sure that they're ignored
		self.touch(tmpdir, "pip-1.2.3-py2.py3-none-any.whl")
		self.touch(tmpdir, "wheel-0.34.2-py2.py3-none-any.whl")
		self.touch(tmpdir, "pip-script.py")

		with (unittest.mock.patch.object(ensurepip, '_PACKAGES', None),
		unittest.mock.patch.object(ensurepip, '_WHEEL_PKG_DIR', tmpdir)):
		packages = ensurepip._get_packages()

		self.assertEqual(packages['pip'].version, '20.2.2')
		self.assertEqual(packages['pip'].wheel_path,
		os.path.join(tmpdir, pip_filename))

		# wheel package is ignored
		self.assertEqual(sorted(packages), ['pip'])
		with unittest.mock.patch.object(ensurepip, '_WHEEL_PKG_DIR', Path(tmpdir)):
		with ensurepip._get_pip_whl_path_ctx() as bundled_wheel_path:
		self.assertEqual(pip_filename, bundled_wheel_path.name)


		class EnsurepipMixin:
Expand All		@@ -69,7 +65,7 @@ def setUp(self):
		real_devnull = os.devnull
		os_patch = unittest.mock.patch("ensurepip.os")
		patched_os = os_patch.start()
		# But expose os.listdir() used by_find_packages()
		# But expose os.listdir() used by_find_wheel_pkg_dir_pip()
		patched_os.listdir = os.listdir
		self.addCleanup(os_patch.stop)
		patched_os.devnull = real_devnull
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -14,7 +14,6 @@
		from pathlib import Path
		from urllib.request import urlopen

		PACKAGE_NAMES = ("pip",)
		ENSURE_PIP_ROOT = Path(__file__).parent.parent.parent / "Lib/ensurepip"
		WHEEL_DIR = ENSURE_PIP_ROOT / "_bundled"
		ENSURE_PIP_INIT_PY_TEXT = (ENSURE_PIP_ROOT / "__init__.py").read_text(encoding="utf-8")
Expand DownExpand Up		@@ -97,8 +96,5 @@ def verify_wheel(package_name: str) -> bool:


		if __name__ == "__main__":
		exit_status = 0
		for package_name in PACKAGE_NAMES:
		if not verify_wheel(package_name):
		exit_status = 1
		exit_status = int(not verify_wheel("pip"))
		raise SystemExit(exit_status)