123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213 |
- import os
- import os.path
- import sys
- import runpy
- import tempfile
- import subprocess
- from importlib import resources
- from . import _bundled
- __all__ = ["version", "bootstrap"]
- _SETUPTOOLS_VERSION = "58.1.0"
- _PIP_VERSION = "22.0.4"
- _PROJECTS = [
- ("setuptools", _SETUPTOOLS_VERSION, "py3"),
- ("pip", _PIP_VERSION, "py3"),
- ]
- def _run_pip(args, additional_paths=None):
- # Run the bootstraping in a subprocess to avoid leaking any state that happens
- # after pip has executed. Particulary, this avoids the case when pip holds onto
- # the files in *additional_paths*, preventing us to remove them at the end of the
- # invocation.
- code = f"""
- import runpy
- import sys
- sys.path = {additional_paths or []} + sys.path
- sys.argv[1:] = {args}
- runpy.run_module("pip", run_name="__main__", alter_sys=True)
- """
- return subprocess.run([sys.executable, "-c", code], check=True).returncode
- def version():
- """
- Returns a string specifying the bundled version of pip.
- """
- return _PIP_VERSION
- def _disable_pip_configuration_settings():
- # We deliberately ignore all pip environment variables
- # when invoking pip
- # See http://bugs.python.org/issue19734 for details
- keys_to_remove = [k for k in os.environ if k.startswith("PIP_")]
- for k in keys_to_remove:
- del os.environ[k]
- # We also ignore the settings in the default pip configuration file
- # See http://bugs.python.org/issue20053 for details
- os.environ['PIP_CONFIG_FILE'] = os.devnull
- def bootstrap(*, root=None, upgrade=False, user=False,
- altinstall=False, default_pip=False,
- verbosity=0):
- """
- Bootstrap pip into the current Python installation (or the given root
- directory).
- Note that calling this function will alter both sys.path and os.environ.
- """
- # Discard the return value
- _bootstrap(root=root, upgrade=upgrade, user=user,
- altinstall=altinstall, default_pip=default_pip,
- verbosity=verbosity)
- def _bootstrap(*, root=None, upgrade=False, user=False,
- altinstall=False, default_pip=False,
- verbosity=0):
- """
- Bootstrap pip into the current Python installation (or the given root
- directory). Returns pip command status code.
- Note that calling this function will alter both sys.path and os.environ.
- """
- if altinstall and default_pip:
- raise ValueError("Cannot use altinstall and default_pip together")
- sys.audit("ensurepip.bootstrap", root)
- _disable_pip_configuration_settings()
- # By default, installing pip and setuptools installs all of the
- # following scripts (X.Y == running Python version):
- #
- # pip, pipX, pipX.Y, easy_install, easy_install-X.Y
- #
- # pip 1.5+ allows ensurepip to request that some of those be left out
- if altinstall:
- # omit pip, pipX and easy_install
- os.environ["ENSUREPIP_OPTIONS"] = "altinstall"
- elif not default_pip:
- # omit pip and easy_install
- os.environ["ENSUREPIP_OPTIONS"] = "install"
- 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 project, version, py_tag in _PROJECTS:
- wheel_name = "{}-{}-{}-none-any.whl".format(project, version, py_tag)
- whl = resources.read_binary(
- _bundled,
- wheel_name,
- )
- with open(os.path.join(tmpdir, wheel_name), "wb") as fp:
- fp.write(whl)
- additional_paths.append(os.path.join(tmpdir, wheel_name))
- # Construct the arguments to be passed to the pip command
- args = ["install", "--no-cache-dir", "--no-index", "--find-links", tmpdir]
- if root:
- args += ["--root", root]
- if upgrade:
- args += ["--upgrade"]
- if user:
- args += ["--user"]
- if verbosity:
- args += ["-" + "v" * verbosity]
- return _run_pip(args + [p[0] for p in _PROJECTS], additional_paths)
- def _uninstall_helper(*, verbosity=0):
- """Helper to support a clean default uninstall process on Windows
- Note that calling this function may alter os.environ.
- """
- # Nothing to do if pip was never installed, or has been removed
- try:
- import pip
- except ImportError:
- return
- # If the pip version doesn't match the bundled one, leave it alone
- if pip.__version__ != _PIP_VERSION:
- msg = ("ensurepip will only uninstall a matching version "
- "({!r} installed, {!r} bundled)")
- print(msg.format(pip.__version__, _PIP_VERSION), file=sys.stderr)
- return
- _disable_pip_configuration_settings()
- # Construct the arguments to be passed to the pip command
- args = ["uninstall", "-y", "--disable-pip-version-check"]
- if verbosity:
- args += ["-" + "v" * verbosity]
- return _run_pip(args + [p[0] for p in reversed(_PROJECTS)])
- def _main(argv=None):
- import argparse
- parser = argparse.ArgumentParser(prog="python -m ensurepip")
- parser.add_argument(
- "--version",
- action="version",
- version="pip {}".format(version()),
- help="Show the version of pip that is bundled with this Python.",
- )
- parser.add_argument(
- "-v", "--verbose",
- action="count",
- default=0,
- dest="verbosity",
- help=("Give more output. Option is additive, and can be used up to 3 "
- "times."),
- )
- parser.add_argument(
- "-U", "--upgrade",
- action="store_true",
- default=False,
- help="Upgrade pip and dependencies, even if already installed.",
- )
- parser.add_argument(
- "--user",
- action="store_true",
- default=False,
- help="Install using the user scheme.",
- )
- parser.add_argument(
- "--root",
- default=None,
- help="Install everything relative to this alternate root directory.",
- )
- parser.add_argument(
- "--altinstall",
- action="store_true",
- default=False,
- help=("Make an alternate install, installing only the X.Y versioned "
- "scripts (Default: pipX, pipX.Y, easy_install-X.Y)."),
- )
- parser.add_argument(
- "--default-pip",
- action="store_true",
- default=False,
- help=("Make a default pip install, installing the unqualified pip "
- "and easy_install in addition to the versioned scripts."),
- )
- args = parser.parse_args(argv)
- return _bootstrap(
- root=args.root,
- upgrade=args.upgrade,
- user=args.user,
- verbosity=args.verbosity,
- altinstall=args.altinstall,
- default_pip=args.default_pip,
- )
|