-
-
Notifications
You must be signed in to change notification settings - Fork 247
Use the symlink-resolved location of Python in getpath on 3.14+ #896
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.
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
+217
−0
Merged
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
52917c5
Use the symlink-resolved location of Python in getpath on 3.14+
geofft e1daa30
Add test cases for invoking Python via getpath
geofft 10e1330
Disable tests on arm64 pending more adventures with pointers
geofft 3e4d886
patch to allow venv creation from symlinks
jjhelmus b114efc
split patches for python version
jjhelmus d0e2e16
Jonathan's patch works as far back as 3.11
geofft 735385c
ruff ruff!
geofft File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
14 changes: 14 additions & 0 deletions
14
cpython-unix/patch-getpath-use-base_executable-for-executable_dir-314.patch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| diff --git a/Modules/getpath.py b/Modules/getpath.py | ||
| index ceb605a75c8..164d708ffca 100644 | ||
| --- a/Modules/getpath.py | ||
| +++ b/Modules/getpath.py | ||
| @@ -411,6 +411,9 @@ def search_up(prefix, *landmarks, test=isfile): | ||
| if isfile(candidate): | ||
| base_executable = candidate | ||
| break | ||
| + if base_executable and isfile(base_executable): | ||
| + # Update the executable directory to be based on the resolved base executable | ||
| + executable_dir = real_executable_dir = dirname(base_executable) | ||
| # home key found; stop iterating over lines | ||
| break | ||
|
|
15 changes: 15 additions & 0 deletions
15
cpython-unix/patch-getpath-use-base_executable-for-executable_dir.patch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| diff --git a/Modules/getpath.py b/Modules/getpath.py | ||
| index 1f1bfcb4f64..ff5b18cc385 100644 | ||
| --- a/Modules/getpath.py | ||
| +++ b/Modules/getpath.py | ||
| @@ -398,6 +398,9 @@ def search_up(prefix, *landmarks, test=isfile): | ||
| if isfile(candidate): | ||
| base_executable = candidate | ||
| break | ||
| + if base_executable and isfile(base_executable): | ||
| + # Update the executable directory to be based on the resolved base executable | ||
| + executable_dir = real_executable_dir = dirname(base_executable) | ||
| break | ||
| else: | ||
| venv_prefix = None | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| From 4fb328cb883504dde04dfdd0b4d182a0130a0909 Mon Sep 17 00:00:00 2001 | ||
| From: Geoffrey Thomas <[email protected]> | ||
| Date: Mon, 1 Dec 2025 14:11:43 -0500 | ||
| Subject: [PATCH 1/1] getpath: Fix library detection and canonicalize paths on | ||
| Linux | ||
| Forwarded: no | ||
|
|
||
| The code in getpath.py to look for the stdlib relative to the Python | ||
| library did not work in the common layout where libpython itself is in | ||
| the lib/ directory; it added an extra lib/ segment. It is also equally | ||
| applicable and useful when statically linking libpython into bin/python; | ||
| in both cases, we want to go up a directory and then look into | ||
| lib/python3.x/. Add an extra dirname() call in getpath.py, and | ||
| unconditionally attempt to fill in the "library" variable in getpath.c, | ||
| even on builds that are statically linking libpython. | ||
|
|
||
| Also, we want to use the realpath'd version of the library's path to | ||
| locate the standard library, particularly in the case where the library | ||
| is a symlink to an executable statically linking libpython. On macOS | ||
| dyld, this is done automatically. On glibc and musl, we often get | ||
| relative paths and they are not canonicalized, so instead, use | ||
| /proc/self/maps to find the file where libpython is coming from. | ||
|
|
||
| (We could instead use the origin, which is canonicalized, but there is | ||
| no safe API on glibc to read it and no API at all on musl. Note that and | ||
| glibc also uses procfs to do so; see discussion at | ||
| https://sourceware.org/bugzilla/show_bug.cgi?id=25263) | ||
| --- | ||
| Modules/getpath.c | 52 ++++++++++++++++++++++++++++++++++++++++------ | ||
| Modules/getpath.py | 4 ++-- | ||
| 2 files changed, 48 insertions(+), 8 deletions(-) | ||
|
|
||
| diff --git a/Modules/getpath.c b/Modules/getpath.c | ||
| index 1e75993480a..72860807133 100644 | ||
| --- a/Modules/getpath.c | ||
| +++ b/Modules/getpath.c | ||
| @@ -802,14 +802,19 @@ progname_to_dict(PyObject *dict, const char *key) | ||
| } | ||
|
|
||
|
|
||
| +static void | ||
| +fclose_cleanup(FILE **pf) { | ||
| + if (*pf) { | ||
| + fclose(*pf); | ||
| + *pf = NULL; | ||
| + } | ||
| +} | ||
| + | ||
| + | ||
| /* Add the runtime library's path to the dict */ | ||
| static int | ||
| library_to_dict(PyObject *dict, const char *key) | ||
| { | ||
| -/* macOS framework builds do not link against a libpython dynamic library, but | ||
| - instead link against a macOS Framework. */ | ||
| -#if defined(Py_ENABLE_SHARED) || defined(WITH_NEXT_FRAMEWORK) | ||
| - | ||
| #ifdef MS_WINDOWS | ||
| extern HMODULE PyWin_DLLhModule; | ||
| if (PyWin_DLLhModule) { | ||
| @@ -817,12 +822,47 @@ library_to_dict(PyObject *dict, const char *key) | ||
| } | ||
| #endif | ||
|
|
||
| + const void *target = (void *)Py_Initialize; | ||
| + | ||
| +#ifdef __linux__ | ||
| + /* Linux libcs do not reliably report the realpath in dladdr dli_fname and | ||
| + * sometimes return relative paths, especially if the returned object is | ||
| + * the main program itself. However, /proc/self/maps will give absolute | ||
| + * realpaths (from the kernel, for the same reason that /proc/self/exe is | ||
| + * canonical), so try to parse and look it up there. (dyld seems to | ||
| + * reliably report the canonical path, so doing this matches the behavior | ||
| + * on macOS.) */ | ||
| + | ||
| + __attribute__((cleanup(fclose_cleanup))) | ||
| + FILE *maps = fopen("/proc/self/maps", "r"); | ||
| + if (maps != NULL) { | ||
| + /* See implementation in fs/proc/task_mmu.c for spacing. The pathname | ||
| + * is the last field and has any \n characters escaped, so we can read | ||
| + * until \n. Note that the filename may have " (deleted)" appended; | ||
| + * we don't bother to handle that specially as the only user of this | ||
| + * value calls dirname() anyway. | ||
| + * TODO(geofft): Consider using PROCMAP_QUERY if supported. | ||
| + */ | ||
| + uintptr_t low, high; | ||
| + char filename[PATH_MAX]; | ||
| + while (fscanf(maps, | ||
| + "%lx-%lx %*s %*s %*s %*s %[^\n]", | ||
| + &low, &high, filename) == 3) { | ||
| + if (low <= (uintptr_t)target && (uintptr_t)target < high) { | ||
| + if (filename[0] == '/') { | ||
| + return decode_to_dict(dict, key, filename); | ||
| + } | ||
| + break; | ||
| + } | ||
| + } | ||
| + } | ||
| +#endif | ||
| + | ||
| #if HAVE_DLADDR | ||
| Dl_info libpython_info; | ||
| - if (dladdr(&Py_Initialize, &libpython_info) && libpython_info.dli_fname) { | ||
| + if (dladdr(target, &libpython_info) && libpython_info.dli_fname) { | ||
| return decode_to_dict(dict, key, libpython_info.dli_fname); | ||
| } | ||
| -#endif | ||
| #endif | ||
|
|
||
| return PyDict_SetItemString(dict, key, Py_None) == 0; | ||
| diff --git a/Modules/getpath.py b/Modules/getpath.py | ||
| index b89d7427e3f..8c431e53be2 100644 | ||
| --- a/Modules/getpath.py | ||
| +++ b/Modules/getpath.py | ||
| @@ -436,7 +436,7 @@ def search_up(prefix, *landmarks, test=isfile): | ||
|
|
||
| if not executable_dir and os_name == 'darwin' and library: | ||
| # QUIRK: macOS checks adjacent to its library early | ||
| - library_dir = dirname(library) | ||
| + library_dir = dirname(dirname(library)) | ||
| if any(isfile(joinpath(library_dir, p)) for p in STDLIB_LANDMARKS): | ||
| # Exceptions here should abort the whole process (to match | ||
| # previous behavior) | ||
| @@ -570,7 +570,7 @@ def search_up(prefix, *landmarks, test=isfile): | ||
|
|
||
| # First try to detect prefix by looking alongside our runtime library, if known | ||
| if library and not prefix: | ||
| - library_dir = dirname(library) | ||
| + library_dir = dirname(dirname(library)) | ||
| if ZIP_LANDMARK: | ||
| if os_name == 'nt': | ||
| # QUIRK: Windows does not search up for ZIP file | ||
| -- | ||
| 2.50.1 (Apple Git-155) | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can this be a part of the skipif?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think you can skipIf a single subTest. You can call
self.skipTest("doesn't yet work on arm64"). I probably could have structured this one as a separate test case, though....