8000 GH-80789: Get rid of the ``ensurepip`` infra for many wheels by webknjaz · Pull Request #109245 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

GH-80789: Get rid of the ensurepip infra for many wheels #109245

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Jan 30, 2024
Merged

GH-80789: Get rid of the ensurepip infra for many wheels #109245

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
c32777f
Get rid of the ``ensurepip`` infra for many wheels
webknjaz Sep 10, 2023
d6e51b2
Rename `_find_packages` to `_get_replacement_pip_package`
webknjaz Sep 15, 2023
5c3bd26
Remove changelog entry
AA-Turner Sep 16, 2023
96b8b9e
Simplify WHEEL_PKG_DIR search
AA-Turner Sep 16, 2023
7b04736
Simplify the pip wheel info
AA-Turner Sep 16, 2023
f3a49c2
Use `pathlib` in `ensurepip` internally
webknjaz Oct 11, 2023
3d7ee78
Drop `os.fsencode` from wheel path preprocessing
webknjaz Oct 11, 2023
72b8ebe
Update replaced `_get_pip_whl_path_ctx` references
webknjaz Oct 11, 2023
0d94ec9
Drop looping from the wheel verification script
webknjaz Oct 12, 2023
5c97cda
Multiline complex wheel path conditional
webknjaz Oct 15, 2023
bce6e3a
Drag the wheel path object through `os.fsdecode`
webknjaz Oct 15, 2023
50efc2a
Use `None`-sentinel for missing alternative wheel
webknjaz Oct 15, 2023
865c41f
Un-f-string alternative wheel path glob
webknjaz Oct 15, 2023
2472d87
Melt the second wheel lookup error into sentinel
webknjaz Oct 15, 2023 8000
da1ae79
Merge branch 'main' into maintenance/ensurepip-single-wheel
pradyunsg Jan 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Simplify the pip wheel info 
- Return a dict with consistent fields
- Remove caching
- Remove type annotations
- Leverage the known wheel package dir value to calculate full paths
  • Loading branch information
@AA-Turner @webknjaz
AA-Turner authored and webknjaz committed Jan 25, 2024
commit 7b04736c1a0e7caf17aa1d146c3547817e99fec6
39 changes: 13 additions & 26 deletions Lib/ensurepip/__init__.py
View file
Open in desktop
8000
Original file line number Diff line number Diff line change
@@ -1,23 +1,15 @@
import collections
import os
import os.path
import subprocess
import sys
import sysconfig
import tempfile
from contextlib import suppress
from functools import cache
from importlib import resources


__all__ = ["version", "bootstrap"]
_PIP_VERSION = "23.3.2"

# 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
Expand All @@ -44,22 +36,17 @@ def _find_wheel_pkg_dir_pip():

# Extract '21.2.4' from 'pip-21.2.4-py3-none-any.whl'
version = filename.removeprefix("pip-").partition("-")[0]
wheel_path = os.path.join(_WHEEL_PKG_DIR, filename)
return _Package(version, None, wheel_path)
return {"version": version, "filename": filename, "bundled": False}

return None


@cache
def _get_usable_pip_package() -> _Package:
wheel_name = f"pip-{_PIP_VERSION}-py3-none-any.whl"
pip_pkg = _Package(_PIP_VERSION, wheel_name, None)

with suppress(LookupError):
# only use the wheel package directory if pip wheel is found there
pip_pkg = _find_wheel_pkg_dir_pip(_WHEEL_PKG_DIR)

return pip_pkg
def _get_pip_info():
# Prefer pip from the wheel package directory, if present.
if (pip_info := _find_wheel_pkg_dir_pip()) is not None:
return pip_info
filename = f"pip-{_PIP_VERSION}-py3-none-any.whl"
return {"version": _PIP_VERSION, "filename": filename, "bundled": True}


def _run_pip(args, additional_paths=None):
Expand Down Expand Up @@ -92,7 +79,7 @@ def version():
"""
Returns a string specifying the bundled version of pip.
"""
return _get_usable_pip_package().version
return _get_pip_info()["version"]


def _disable_pip_configuration_settings():
Expand Down Expand Up @@ -154,17 +141,16 @@ 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
package = _get_usable_pip_package()
if package.wheel_name:
package = _get_pip_info()
wheel_name = package["filename"]
if package["bundled"]:
# 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:
with open(os.path.join(_WHEEL_PKG_DIR, wheel_name), "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:
Expand All @@ -183,6 +169,7 @@ def _bootstrap(*, root=None, upgrade=False, user=False,

return _run_pip([*args, "pip"], [filename])


def _uninstall_helper(*, verbosity=0):
"""Helper to support a clean default uninstall process on Windows

Expand Down
73 changes: 19 additions & 54 deletions Lib/test/test_ensurepip.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,12 @@
import test.support
import unittest
import unittest.mock
from pathlib import Path

import ensurepip
import ensurepip._uninstall


class TestPackages(unittest.TestCase):
def setUp(self):
ensurepip._get_usable_pip_package.cache_clear()

def tearDown(self):
ensurepip._get_usable_pip_package.cache_clear()

def touch(self, directory, filename):
fullname = os.path.join(directory, filename)
open(fullname, "wb").close()
Expand All @@ -27,43 +20,39 @@ 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, '_WHEEL_PKG_DIR', tmpdir,
):
with unittest.mock.patch.object(ensurepip, '_WHEEL_PKG_DIR', tmpdir):
self.assertEqual(ensurepip.version(), '1.2.3b1')

def test_get_packages_no_dir(self):
# Test _get_packages() without a wheel package directory
def test_get_pip_info_no_dir(self):
# Test _get_pip_info() without a wheel package directory
with unittest.mock.patch.object(ensurepip, '_WHEEL_PKG_DIR', None):
pip_pkg = ensurepip._get_usable_pip_package()
pip_info = ensurepip._get_pip_info()

# when bundled pip wheel package is used, we get _PIP_VERSION
# when the bundled pip wheel is used, we get _PIP_VERSION
self.assertEqual(ensurepip._PIP_VERSION, ensurepip.version())

# use bundled pip wheel package
self.assertIsNotNone(pip_pkg.wheel_name)
# use the bundled pip wheel
pip_filename = f'pip-{ensurepip._PIP_VERSION}-py3-none-any.whl'
expected = {"version": ensurepip._PIP_VERSION, "filename": pip_filename,
"bundled": True}
self.assertDictEqual(pip_info, expected)

def test_get_packages_with_dir(self):
# Test _get_packages() with a wheel package directory
older_pip_filename = "pip-1.2.3-py2.py3-none-any.whl"
def test_get_pip_info_with_dir(self):
# Test _get_pip_info() with a wheel package directory
pip_filename = "pip-20.2.2-py2.py3-none-any.whl"

with tempfile.TemporaryDirectory() as tmpdir:
self.touch(tmpdir, older_pip_filename)
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")
# not used, make sure that it's ignored
self.touch(tmpdir, "non-whl")
self.touch(tmpdir, "pip-script.py")

with unittest.mock.patch.object(
ensurepip, '_WHEEL_PKG_DIR', tmpdir,
):
pip_pkg = ensurepip._get_usable_pip_package()
with unittest.mock.patch.object(ensurepip, '_WHEEL_PKG_DIR', tmpdir):
pip_info = ensurepip._get_pip_info()

self.assertEqual(pip_pkg.version, '20.2.2')
self.assertEqual(pip_pkg.wheel_path,
os.path.join(tmpdir, pip_filename))
expected = {"version": '20.2.2', "filename": pip_filename, "bundled": False}
self.assertDictEqual(pip_info, expected)


class EnsurepipMixin:
Expand Down Expand Up @@ -102,30 +91,6 @@ def test_basic_bootstrapping(self):
additional_paths = self.run_pip.call_args[0][1]
self.assertEqual(len(additional_paths), 1)


def test_replacement_wheel_bootstrapping(self):
ensurepip._get_usable_pip_package.cache_clear()

pip_wheel_name = (
f'pip-{ensurepip._PIP_VERSION !s}-'
'py3-none-any.whl'
)

with tempfile.TemporaryDirectory() as tmpdir:
tmp_path = Path(tmpdir)
tmp_wheel_path = tmp_path / pip_wheel_name
tmp_wheel_path.touch()

with unittest.mock.patch.object(
ensurepip, '_WHEEL_PKG_DIR', tmpdir,
):
ensurepip.bootstrap()

ensurepip._get_usable_pip_package.cache_clear()

additional_paths = self.run_pip.call_args[0][1]
self.assertEqual(Path(additional_paths[-1]).name, pip_wheel_name)

def test_bootstrapping_with_root(self):
ensurepip.bootstrap(root="/foo/bar/")

Expand Down
0