Skip to content
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

Document which environment variables are passed through by default #2753

Closed
jugmac00 opened this issue Dec 19, 2022 · 3 comments · Fixed by #3291
Closed

Document which environment variables are passed through by default #2753

jugmac00 opened this issue Dec 19, 2022 · 3 comments · Fixed by #3291
Labels
area:documentation help:wanted Issues that have been acknowledged, a solution determined and a PR might likely be accepted. level:easy rought estimate that this might be quite easy to implement

Comments

@jugmac00
Copy link
Member

Documentation for tox3 had https://tox.wiki/en/3.27.0/config.html#conf-passenv

Documentation for tox4 does not show the list any more

Also see

tox/src/tox/tox_env/api.py

Lines 179 to 204 in 6b1cc14

def _default_pass_env(self) -> list[str]:
env = [
"https_proxy", # HTTP proxy configuration
"http_proxy", # HTTP proxy configuration
"no_proxy", # HTTP proxy configuration
"LANG", # localization
"LANGUAGE", # localization
"CURL_CA_BUNDLE", # curl certificates
"SSL_CERT_FILE", # https certificates
"LD_LIBRARY_PATH", # location of libs
]
if sys.stdout.isatty(): # if we're on a interactive shell pass on the TERM
env.append("TERM")
if sys.platform == "win32": # pragma: win32 cover
env.extend(
[
"TEMP", # temporary file location
"TMP", # temporary file location
"USERPROFILE", # needed for `os.path.expanduser()`
"PATHEXT", # needed for discovering executables
"MSYSTEM", # controls paths printed format
],
)
else: # pragma: win32 no cover
env.append("TMPDIR") # temporary file location
return env

@jugmac00 jugmac00 added area:documentation level:easy rought estimate that this might be quite easy to implement help:wanted Issues that have been acknowledged, a solution determined and a PR might likely be accepted. labels Dec 19, 2022
@gaborbernat gaborbernat added this to the 4.0.x milestone Dec 19, 2022
@gaborbernat
Copy link
Member

gaborbernat commented Dec 19, 2022

For what's the best documentation is:

tox c -e py -k pass_env 

🤷 rather than some hard-coded list in a webpage that's quickly stale or can be overwritten by your config.

@gaborbernat gaborbernat removed this from the P-0 milestone Jun 17, 2023
@gaborbernat
Copy link
Member

@seyidaniels will try to tackle this :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:documentation help:wanted Issues that have been acknowledged, a solution determined and a PR might likely be accepted. level:easy rought estimate that this might be quite easy to implement
Projects
None yet
2 participants