Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32k
gh-118234: Document Python subprocess requirement onSystemRoot env, add RuntimeWarning#134435
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
Conversation
Uh oh!
There was an error while loading.Please reload this page.
Apparently some regression tests trigger this:https://github.com/python/cpython/actions/runs/15171090613/job/42661034135 Even though Does the Windows CI runner not set SystemRoot? |
You can check "Display build info" which says: |
Uh oh!
There was an error while loading.Please reload this page.
I'd be suspicious of |
| @@ -1545,6 +1545,10 @@ def _execute_child(self, args, executable, preexec_fn, close_fds, | |||
| if cwd is not None: | |||
| cwd = os.fsdecode(cwd) | |||
| if env is not None and not any( | |||
| k.upper() == 'SYSTEMROOT' and v for k, v in env.items()): | |||
| warnings.warn("env lacks a valid 'SystemRoot'.", RuntimeWarning) | |||
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 dislike this RuntimeWarning. It's ok to run programs withoutSystemRoot env var, or even in an empty environment. It just works fine currently for some programs. Example:
importsubprocess,syscmd= [sys.executable,'-c','print("Hello World")']subprocess.run(cmd,env={})
This program just works, it displays "Hello World" as expected.
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'm not sure how to synthesize this feedback with#134363 (comment).
How do we prevent the problem, if not warning about it, and not setting it in the subprocess? Should we implicitly override the caller's choices and clone SystemRoot into the subprocess env?
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 that wehave to prevent the problem. We can document it and explain how to avoid it.
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.
Well, it works since Windows decided that usingPATH to locate runtime dependencies (like anLD_LIBRARY_PATH equivalent) was such a terrible idea that it bypasses it for most OS stuff, but that "fix" upsets people as well.
I'm not particularly strong either way on this fix. It bites people all the time, and it's practically always a pointless thing to do (pass an insufficient environment). At the same time, there are 5-6 other variables that also ought to be included or things will break weirdly (e.g.TEMP), and this change doesn't check for those. But I don't think we have any good way to only warn when things break.
Is there a silent-by-default-enabled-with-X-dev warning that could be used instead? Would that be okay,@vstinner?
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.
If we add a warning, it may be better to emit the warning in the socket module, no?
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.
Is there a silent-by-default-enabled-with-X-dev warning that could be used instead? Would that be okay,@vstinner?
A warning only emitted in the Python Developer Mode (-X dev) sounds more acceptable to me, yes.
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.
it may be better to emit the warning in the socket module, no?
The user's system could be configured to avoid that error, even without the environment variable, while plenty of other parts could also break if they are reconfigured.
Launching an application with an empty environment is the bad idea, so that's where the warning should be. I've diagnosed that as the root cause of a lot of issues.
Do we have an existing warning? Or do we need to invent a new one? This isn't a deprecation, and that's the only warning I'm aware of.
Uh oh!
There was an error while loading.Please reload this page.
Document that
SystemRootis also required for a Python subprocess that usessocketorasyncioon Windows, and add aRuntimeWarningif anenv supplied tosubprocess.Popenlacks it.Resolves#118234.
📚 Documentation preview 📚:https://cpython-previews--134435.org.readthedocs.build/