building: do not attempt to expand env. vars in paths #8441
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
Remove the `compat.expand_path` helper, and stop attempting to expand environment variables in paths given via `--workpath`, `--distpath`, `--specpath`, and `--additional-hooks-dir`. The Windows implementation of `expandvars` found in `ntpath` translates `$$` and `%%` into `$` and `%`, respectively, which mangles the paths that contain such sequences (as literal characters, without using environment variables at all). While the above issue could be worked around by duplicating characters in the problematic character sequences, the whole environment variable expansion in paths seems rather unnecessary. It was introduced in response to pyinstaller#696, which was caused by the fact that shell does not expand the tilde when using `--argname=~/path/abc` argument syntax instead of `--argname ~/path/abc` (or when the path argument is quoted). As that seems like legitimate shortcoming, keep the tilde expansion part (`os.path.expanduser`) around, but remove the general environment variable expansion attempts (`os.path.expandvars`), which should be left to the shell.
bwoodsend
approved these changes
Apr 29, 2024
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.
Remove the
compat.expand_pathhelper, and stop attempting to expand environment variables in paths given via--workpath,--distpath,--specpath, and--additional-hooks-dir.The Windows implementation of
expandvarsfound inntpathtranslates$$and%%into$and%, respectively, which mangles the paths that contain such sequences (as literal characters, without using environment variables at all).While the above issue could be worked around by duplicating characters in the problematic character sequences, the whole environment variable expansion in paths seems rather unnecessary. It was introduced in response to #696, which was caused by the fact that shell does not expand the tilde when using
--argname=~/path/abcargument syntax instead of--argname ~/path/abc(or when the path argument is quoted).As that seems like legitimate shortcoming, keep the tilde expansion part (
os.path.expanduser) around, but remove the general environment variable expansion attempts (os.path.expandvars), which should be left to the shell.