[Python-checkins] gh-99370: Calculate zip path from prefix when in a venv (GH-99371)
miss-islington
webhook-mailer at python.org
Mon Nov 14 10:31:52 EST 2022
https://github.com/python/cpython/commit/5971a65d077739e5f3412a662511a240976ccd99
commit: 5971a65d077739e5f3412a662511a240976ccd99
branch: 3.11
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022-11-14T07:31:46-08:00
summary:
gh-99370: Calculate zip path from prefix when in a venv (GH-99371)
Before python3.11, when in a venv the zip path is calculated
from prefix on POSIX platforms. In python3.11 the behavior is
accidentally changed to calculating from default prefix. This
change will break venv created from a non-installed python
with a stdlib zip file. This commit restores the behavior back
to before python3.11.
(cherry picked from commit e3d4fed07429670af631e5662086b76c1ec098c4)
Co-authored-by: Kai Zhang <kylerzhang11 at gmail.com>
files:
A Misc/NEWS.d/next/Core and Builtins/2022-11-12-01-39-57.gh-issue-99370._cu32j.rst
M Lib/test/test_getpath.py
M Lib/test/test_venv.py
M Modules/getpath.py
diff --git a/Lib/test/test_getpath.py b/Lib/test/test_getpath.py
index b4466ce3eeee..87932b891f80 100644
--- a/Lib/test/test_getpath.py
+++ b/Lib/test/test_getpath.py
@@ -383,6 +383,39 @@ def test_venv_changed_name_posix(self):
actual = getpath(ns, expected)
self.assertEqual(expected, actual)
+ def test_venv_non_installed_zip_path_posix(self):
+ "Test a venv created from non-installed python has correct zip path."""
+ ns = MockPosixNamespace(
+ argv0="/venv/bin/python",
+ PREFIX="/usr",
+ ENV_PATH="/venv/bin:/usr/bin",
+ )
+ ns.add_known_xfile("/path/to/non-installed/bin/python")
+ ns.add_known_xfile("/venv/bin/python")
+ ns.add_known_link("/venv/bin/python",
+ "/path/to/non-installed/bin/python")
+ ns.add_known_file("/path/to/non-installed/lib/python9.8/os.py")
+ ns.add_known_dir("/path/to/non-installed/lib/python9.8/lib-dynload")
+ ns.add_known_file("/venv/pyvenv.cfg", [
+ r"home = /path/to/non-installed"
+ ])
+ expected = dict(
+ executable="/venv/bin/python",
+ prefix="/path/to/non-installed",
+ exec_prefix="/path/to/non-installed",
+ base_executable="/path/to/non-installed/bin/python",
+ base_prefix="/path/to/non-installed",
+ base_exec_prefix="/path/to/non-installed",
+ module_search_paths_set=1,
+ module_search_paths=[
+ "/path/to/non-installed/lib/python98.zip",
+ "/path/to/non-installed/lib/python9.8",
+ "/path/to/non-installed/lib/python9.8/lib-dynload",
+ ],
+ )
+ actual = getpath(ns, expected)
+ self.assertEqual(expected, actual)
+
def test_venv_changed_name_copy_posix(self):
"Test a venv --copies layout on *nix that lacks a distributed 'python'"
ns = MockPosixNamespace(
diff --git a/Lib/test/test_venv.py b/Lib/test/test_venv.py
index c88df1795fda..3dbb6ebaf7d3 100644
--- a/Lib/test/test_venv.py
+++ b/Lib/test/test_venv.py
@@ -537,6 +537,69 @@ def test_pathsep_error(self):
self.assertRaises(ValueError, venv.create, bad_itempath)
self.assertRaises(ValueError, venv.create, pathlib.Path(bad_itempath))
+ @unittest.skipIf(os.name == 'nt', 'not relevant on Windows')
+ @requireVenvCreate
+ def test_zippath_from_non_installed_posix(self):
+ """
+ Test that when create venv from non-installed python, the zip path
+ value is as expected.
+ """
+ rmtree(self.env_dir)
+ # First try to create a non-installed python. It's not a real full
+ # functional non-installed python, but enough for this test.
+ non_installed_dir = os.path.realpath(tempfile.mkdtemp())
+ try:
+ bindir = os.path.join(non_installed_dir, self.bindir)
+ os.mkdir(bindir)
+ shutil.copy2(sys.executable, bindir)
+ libdir = os.path.join(non_installed_dir, *self.lib)
+ os.makedirs(libdir)
+ landmark = os.path.join(libdir, "os.py")
+ stdlib_zip = "python%d%d.zip" % sys.version_info[:2]
+ zip_landmark = os.path.join(non_installed_dir,
+ self.lib[0],
+ stdlib_zip)
+ additional_pythonpath_for_non_installed = []
+ # Copy stdlib files to the non-installed python so venv can
+ # correctly calculate the prefix.
+ for eachpath in sys.path:
+ if eachpath.endswith(".zip"):
+ if os.path.isfile(eachpath):
+ shutil.copyfile(
+ eachpath,
+ os.path.join(non_installed_dir, self.lib[0]))
+ elif os.path.isfile(os.path.join(eachpath, "os.py")):
+ for name in os.listdir(eachpath):
+ if name == "site-packages":
+ continue
+ fn = os.path.join(eachpath, name)
+ if os.path.isfile(fn):
+ shutil.copy(fn, libdir)
+ elif os.path.isdir(fn):
+ shutil.copytree(fn, os.path.join(libdir, name))
+ else:
+ additional_pythonpath_for_non_installed.append(
+ eachpath)
+ cmd = [os.path.join(non_installed_dir, self.bindir, self.exe),
+ "-m",
+ "venv",
+ "--without-pip",
+ self.env_dir]
+ # Our fake non-installed python is not fully functional because
+ # it cannot find the extensions. Set PYTHONPATH so it can run the
+ # venv module correctly.
+ pythonpath = os.pathsep.join(
+ additional_pythonpath_for_non_installed)
+ subprocess.check_call(cmd, env={"PYTHONPATH": pythonpath})
+ envpy = os.path.join(self.env_dir, self.bindir, self.exe)
+ # Now check the venv created from the non-installed python has
+ # correct zip path in pythonpath.
+ cmd = [envpy, '-S', '-c', 'import sys; print(sys.path)']
+ out, err = check_output(cmd)
+ self.assertTrue(zip_landmark.encode() in out)
+ finally:
+ rmtree(non_installed_dir)
+
@requireVenvCreate
class EnsurePipTest(BaseTest):
"""Test venv module installation of pip."""
diff --git a/Misc/NEWS.d/next/Core and Builtins/2022-11-12-01-39-57.gh-issue-99370._cu32j.rst b/Misc/NEWS.d/next/Core and Builtins/2022-11-12-01-39-57.gh-issue-99370._cu32j.rst
new file mode 100644
index 000000000000..142f91ccd92e
--- /dev/null
+++ b/Misc/NEWS.d/next/Core and Builtins/2022-11-12-01-39-57.gh-issue-99370._cu32j.rst
@@ -0,0 +1,2 @@
+Fix zip path for venv created from a non-installed python on POSIX
+platforms.
diff --git a/Modules/getpath.py b/Modules/getpath.py
index b8ad53eacf6b..fc533a8f5f5e 100644
--- a/Modules/getpath.py
+++ b/Modules/getpath.py
@@ -679,9 +679,8 @@ def search_up(prefix, *landmarks, test=isfile):
else:
library_dir = executable_dir
pythonpath.append(joinpath(library_dir, ZIP_LANDMARK))
- elif build_prefix or venv_prefix:
+ elif build_prefix:
# QUIRK: POSIX uses the default prefix when in the build directory
- # or a venv
pythonpath.append(joinpath(PREFIX, ZIP_LANDMARK))
else:
pythonpath.append(joinpath(prefix, ZIP_LANDMARK))
More information about the Python-checkins
mailing list