GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GH-80789: Get rid of the ``ensurepip`` infra for many wheels by webknjaz · Pull Request #109245 · python/cpython

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
pradyunsg merged 15 commits into python:main from webknjaz:maintenance/ensurepip-single-wheel
Jan 30, 2024

Uh oh!

There was an error while loading. Please reload this page.

Merged

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

Show file tree
Hide file tree
Changes from all commits
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
da1ae79
Merge branch 'main' into maintenance/ensurepip-single-wheel
pradyunsg Jan 29, 2024
File filter
Filter by extension

Clear filters
Conversations
Failed to load comments.
Loading

Uh oh!

There was an error while loading. Please reload this page.

Jump to
Jump to file
Failed to load files.
Loading

Uh oh!

There was an error while loading. Please reload this page.

Diff view
Diff view

There are no files selected for viewing

129 changes: 51 additions & 78 deletions 129 Lib/ensurepip/__init__.py
Show comments
View file
Open in desktop
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
Comment thread
pradyunsg marked this conversation as resolved.
Resolved

Uh oh!

There was an error while loading. Please reload this page.



def _find_wheel_pkg_dir_pip():
Comment thread
webknjaz marked this conversation as resolved.
Resolved

Uh oh!

There was an error while loading. Please reload this page.

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
Comment thread
webknjaz marked this conversation as resolved.
Resolved

Uh oh!

There was an error while loading. Please reload this page.


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():
Comment thread
pradyunsg marked this conversation as resolved.
Resolved

Uh oh!

There was an error while loading. Please reload this page.

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 Down Expand 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()
Comment thread
pradyunsg marked this conversation as resolved.
Resolved

Uh oh!

There was an error while loading. Please reload this page.



def _disable_pip_configuration_settings():
Expand Down Expand 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 Down Expand 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
46 changes: 21 additions & 25 deletions 46 Lib/test/test_ensurepip.py
Show comments
View file
Open in desktop
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)

def test_get_packages_with_dir(self):
# Test _get_packages() with a wheel package directory
def test_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
6 changes: 1 addition & 5 deletions 6 Tools/build/verify_ensurepip_wheels.py
Show comments
View file
Open in desktop
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 Down Expand 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)
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.