diff --git a/Doc/library/ensurepip.rst b/Doc/library/ensurepip.rst
index de3b93f5e61073..7f643731130671 100644
--- a/Doc/library/ensurepip.rst
+++ b/Doc/library/ensurepip.rst
@@ -59,8 +59,9 @@ is at least as recent as the one available in ``ensurepip``, pass the
By default, ``pip`` is installed into the current virtual environment
(if one is active) or into the system site packages (if there is no
active virtual environment). The installation location can be controlled
-through two additional command line options:
+through some additional command line options:
+* :samp:`--prefix {dir}`: Installs ``pip`` using the given directory prefix.
* :samp:`--root {dir}`: Installs ``pip`` relative to the given root directory
rather than the root of the currently active virtual environment (if any)
or the default root for the current Python installation.
@@ -94,7 +95,7 @@ Module API
.. function:: bootstrap(root=None, upgrade=False, user=False, \
altinstall=False, default_pip=False, \
- verbosity=0)
+ verbosity=0, prefix=None)
Bootstraps ``pip`` into the current or designated environment.
@@ -122,6 +123,12 @@ Module API
*verbosity* controls the level of output to :data:`sys.stdout` from the
bootstrapping operation.
+ *prefix* specifies the directory prefix to use when installing.
+
+ .. versionadded:: 3.13
+
+ The *prefix* parameter.
+
.. audit-event:: ensurepip.bootstrap root ensurepip.bootstrap
.. note::
diff --git a/Lib/ensurepip/__init__.py b/Lib/ensurepip/__init__.py
index a09bf3201e1fb7..3f9c87bc7baaa3 100644
--- a/Lib/ensurepip/__init__.py
+++ b/Lib/ensurepip/__init__.py
@@ -122,28 +122,30 @@ def _disable_pip_configuration_settings():
def bootstrap(*, root=None, upgrade=False, user=False,
altinstall=False, default_pip=False,
- verbosity=0):
+ verbosity=0, prefix=None):
"""
Bootstrap pip into the current Python installation (or the given root
- directory).
+ and directory prefix).
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)
+ verbosity=verbosity, prefix=prefix)
def _bootstrap(*, root=None, upgrade=False, user=False,
altinstall=False, default_pip=False,
- verbosity=0):
+ verbosity=0, prefix=None):
"""
Bootstrap pip into the current Python installation (or the given root
- directory). Returns pip command status code.
+ and directory prefix). Returns pip command status code.
Note that calling this function will alter both sys.path and os.environ.
"""
+ if root is not None and prefix is not None:
+ raise ValueError("Cannot use 'root' and 'prefix' together")
if altinstall and default_pip:
raise ValueError("Cannot use altinstall and default_pip together")
@@ -190,6 +192,8 @@ def _bootstrap(*, root=None, upgrade=False, user=False,
args = ["install", "--no-cache-dir", "--no-index", "--find-links", tmpdir]
if root:
args += ["--root", root]
+ if prefix:
+ args += ["--prefix", prefix]
if upgrade:
args += ["--upgrade"]
if user:
@@ -264,6 +268,11 @@ def _main(argv=None):
default=None,
help="Install everything relative to this alternate root directory.",
)
+ parser.add_argument(
+ "--prefix",
+ default=None,
+ help="Install everything using this prefix.",
+ )
parser.add_argument(
"--altinstall",
action="store_true",
@@ -283,6 +292,7 @@ def _main(argv=None):
return _bootstrap(
root=args.root,
+ prefix=args.prefix,
upgrade=args.upgrade,
user=args.user,
verbosity=args.verbosity,
diff --git a/Lib/test/test_ensurepip.py b/Lib/test/test_ensurepip.py
index 69ab2a4feaa938..5e8ad0681eb116 100644
--- a/Lib/test/test_ensurepip.py
+++ b/Lib/test/test_ensurepip.py
@@ -105,6 +105,21 @@ def test_bootstrapping_with_root(self):
unittest.mock.ANY,
)
+ def test_bootstrapping_with_prefix(self):
+ ensurepip.bootstrap(prefix="/foo/bar/")
+ self.run_pip.assert_called_once_with(
+ [
+ "install", "--no-cache-dir", "--no-index", "--find-links",
+ unittest.mock.ANY, "--prefix", "/foo/bar/", "pip",
+ ],
+ unittest.mock.ANY,
+ )
+
+ def test_root_and_prefix_mutual_exclusive(self):
+ with self.assertRaises(ValueError):
+ ensurepip.bootstrap(root="", prefix="")
+ self.assertFalse(self.run_pip.called)
+
def test_bootstrapping_with_user(self):
ensurepip.bootstrap(user=True)
diff --git a/Makefile.pre.in b/Makefile.pre.in
index 6a64547e97d266..efdc1dd938e961 100644
--- a/Makefile.pre.in
+++ b/Makefile.pre.in
@@ -1981,7 +1981,7 @@ install: @FRAMEWORKINSTALLFIRST@ commoninstall bininstall maninstall @FRAMEWORKI
install|*) ensurepip="" ;; \
esac; \
$(RUNSHARED) $(PYTHON_FOR_BUILD) -m ensurepip \
- $$ensurepip --root=$(DESTDIR)/ ; \
+ $$ensurepip --prefix=$(prefix) ; \
fi
.PHONY: altinstall
@@ -1992,7 +1992,7 @@ altinstall: commoninstall
install|*) ensurepip="--altinstall" ;; \
esac; \
$(RUNSHARED) $(PYTHON_FOR_BUILD) -m ensurepip \
- $$ensurepip --root=$(DESTDIR)/ ; \
+ $$ensurepip --prefix=$(prefix) ; \
fi
.PHONY: commoninstall
diff --git a/Misc/NEWS.d/next/Library/2019-12-16-17-50-42.bpo-31046.XA-Qfr.rst b/Misc/NEWS.d/next/Library/2019-12-16-17-50-42.bpo-31046.XA-Qfr.rst
new file mode 100644
index 00000000000000..07eb89d4d23e50
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2019-12-16-17-50-42.bpo-31046.XA-Qfr.rst
@@ -0,0 +1 @@
+A directory prefix can now be specified when using :mod:`ensurepip`.
pFad - Phonifier reborn
Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies:
Alternative Proxy
pFad Proxy
pFad v3 Proxy
pFad v4 Proxy