Resolve symlinks when determining if module is builtin #419
Conversation
This file contains 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
To determine whether a module is builtin, Dill compares `mod.__file__` against `sys.base_prefix`. The former will have symlinks resolved, while the latter will not. This causes builtin module detection to fail in Python installations where `sys.base_prefix` involves symlinks, like Homebrew-managed Python on macOS. This commit resolves the issue by resolving symlinks in `sys.base_prefix` before comparing module paths against it. Fix uqfoundation#417.
|
LGTM |
|
Thanks again for all your help tracking this down! |
|
Thx for the patch |
| @@ -1360,7 +1360,7 @@ def save_module(pickler, obj): | |||
| if hasattr(obj, "__file__"): | |||
| names = ["base_prefix", "base_exec_prefix", "exec_prefix", | |||
| "prefix", "real_prefix"] | |||
| builtin_mod = any(obj.__file__.startswith(os.path.normpath(getattr(sys, name))) | |||
| builtin_mod = any(obj.__file__.startswith(os.path.realpath(getattr(sys, name))) | |||
There was a problem hiding this comment.
Hi, I just came across this PR because I ran into a similar issue. I tried to run with master but unfortunately, the problem doesn't go away fully. I tested a minor adjustment to the code. Is there any way you would consider putting in another minor fix for this, please? Use realpath on obj.__file__, too:
builtin_mod = any(os.path.realpath(obj.__file__).startswith(os.path.realpath(getattr(sys, name)))
There was a problem hiding this comment.
Sure. why don't you submit a PR?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
To determine whether a module is builtin, Dill compares
mod.__file__against
sys.base_prefix. The former will have symlinks resolved, whilethe latter will not. This causes builtin module detection to fail in
Python installations where
sys.base_prefixinvolves symlinks, likeHomebrew-managed Python on macOS.
This commit resolves the issue by resolving symlinks in
sys.base_prefixbefore comparing module paths against it.Fix #417.