LocalDispatcher, SystemCommand, gaffer env : Preserve env-var case on Windows
#6376
Conversation
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
|
I'm a little bit in two minds about including this in 1.5. It's a pretty central change, so if we were being conservative it might be more suitable for 1.6. |
4 tasks
johnhaddon
force-pushed
the
envVarCaseFix
branch
2 times, most recently
from
bed35a1 to
c3bcd37
Compare
ericmehl
approved these changes
Apr 22, 2025
…on Windows On Windows, environment variable names are case-preserving but case-insensitive. Python's `os.environ` mapping has a botched emulation for this which implements the case-insensitive part by trashing the case and making everything upper-case. See https://bugs.python.org/issue28824. This caused us problems where we were using `os.environ.copy()` as the source for a child environment we constructed for use with `subprocess`. The child environment now had all-upper-case environment variables instead of the originals. And that caused problems with `Context.substitute( "${var}" )` in the child process, because context variable lookups are case-sensitive. In the absence of a fix to Python itself, for now we add a `Gaffer.environment()` function that builds a dictionary from the ground truth of the process' environment table. Fixes GafferHQ#6371.
Although the case-preservation fixed by `Gaffer.environment()` on Windows isn't needed here, it still makes sense to have the test code be an example of best practice.
johnhaddon
force-pushed
the
envVarCaseFix
branch
from
c3bcd37 to
337203c
Compare
github-project-automation
bot
moved this from Pending Review
to Pending release
in Work in Progress
|
Thanks Eric - I've rebased and merged to |
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.
On Windows, environment variable names are case-preserving but case-insensitive. Python's
os.environmapping has a botched emulation for this which implements the case-insensitive part by trashing the case and making everything upper-case. See https://bugs.python.org/issue28824.This caused us problems where we were using
os.environ.copy()as the source for a child environment we constructed for use withsubprocess. The child environment now had all-upper-case environment variables instead of the originals. And that caused problems withContext.substitute( "${var}" )in the child process, because context variable lookups are case-sensitive.In the absence of a fix to Python itself, for now we add a
Gaffer.environment()function that builds a dictionary from the ground truth of the process' environment table. And use that everywhere we're running subprocesses on behalf of the user.Fixes #6371.