Codestin Search App

soapy1 · 2025-10-20T18:44:20Z

Description

Pt. 1 to address #15292

Users should not be able to change their PATH environment variable through their environment config.

This change will ignore these reserved variables (currently just PATH). And, will print a warning to the user if a reserved environment variable is detected.

For example, to test this out:

// create a new env
$ conda create -n myenv

// set the `PATH` variable for the env
$ conda env config vars set PATH="notsogood" -n myenv

// activate the environment - notice 
// 1. no error  - on the main branch of conda this will produce an error 
// 2. warning message
 $ conda activate myenv                               
WARNING: the configured environment variable(s) for prefix '/home/sophia/projects/conda/devenv/Linux/x86_64/envs/devenv-3.10-miniforge/envs/myenv' are reserved and will be ignored: PATH.

Remove the invalid configuration with `conda env config vars unset -p /home/sophia/projects/conda/devenv/Linux/x86_64/envs/devenv-3.10-miniforge/envs/myenv PATH`.


// deactivate the environment - notice
// 1. no error  - on the main branch of conda this will produce an error 
// 2. warning message
$ conda deactivate                             
WARNING: the configured environment variable(s) for prefix '/home/sophia/projects/conda/devenv/Linux/x86_64/envs/devenv-3.10-miniforge/envs/myenv' are reserved and will be ignored: PATH.

Remove the invalid configuration with `conda env config vars unset -p /home/sophia/projects/conda/devenv/Linux/x86_64/envs/devenv-3.10-miniforge/envs/myenv PATH`.

Checklist - did you ...

Add a file to the news directory (using the template) for the next release's release notes?
Add / update necessary tests?
Add / update outdated documentation?

codspeed-hq · 2025-10-20T19:01:31Z

CodSpeed Performance Report

Merging #15342 will not alter performance

_{Comparing soapy1:dont-change-path-var (93ea5af) with main (9b57c59)¹}

Summary

✅ 23 untouched
⏩ 21 skipped²

No successful run was found on main (3f3ee9b) during the generation of this report, so 9b57c59 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩
21 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

soapy1 · 2025-10-20T22:41:56Z

pre-commit.ci autofix

ryanskeith

This looks good to me.

news/15342-ignore-PATH-env-var

conda/activate.py

soapy1 · 2025-10-23T16:10:23Z

pre-commit.ci autofix

ryanskeith

Looks good as far as formatting. I think the warning clause needs to be out of the loop though before this is committed.

conda/activate.py

jezdez

@soapy1 I took the liberty to push a change that I think improves this PR for vars that are unset with conda env config vars unset .. (yep, that's a real command!). If you're okay with my changes, I'd be happy to approve it, but we can work on it more if you'd like.

jezdez · 2025-10-28T08:52:10Z

pre-commit.ci autofix

soapy1 · 2025-10-28T17:12:14Z

One more change to add here. When I was testing this out and flipping beteween environments with valid and invalid configured env vars, it was confusing to know which environment the warning is coming from. Adding the prefix name to the warning to clarify this.

soapy1 · 2025-10-28T17:34:19Z

One more change to add here. When I was testing this out and flipping beteween environments with valid and invalid configured env vars, it was confusing to know which environment the warning is coming from. Adding the prefix name to the warning to clarify this.

pushed this change. Now when a user activates/deactivates an environment with reserved environment variables configured, they get a warning like:

WARNING: the configured environment variable(s) for prefix '/tmp/vars' are reserved and will be ignored: PATH.

Remove the invalid configuration with `conda env config vars unset -p /tmp/vars PATH`.

For example, users should not be able to change their PATH environment variable thru their environment config. This change will ignore these reserved variables and print a warning to the user.

for more information, see https://pre-commit.ci

Co-authored-by: Jannis Leidel <[email protected]>

for more information, see https://pre-commit.ci

soapy1 · 2025-11-03T19:19:49Z

If you're okay with my changes, I'd be happy to approve it, but we can work on it more if you'd like.

@jezdez I'm good with these changes. Do you want to give it a once thru before merging?

conda-bot added this to 🔎 Review Oct 20, 2025

github-project-automation bot moved this to 🆕 New in 🔎 Review Oct 20, 2025

conda-bot added the cla-signed [bot] added once the contributor has signed the CLA label Oct 20, 2025

soapy1 marked this pull request as ready for review October 21, 2025 04:33

soapy1 requested a review from a team as a code owner October 21, 2025 04:33

ryanskeith previously approved these changes Oct 22, 2025

View reviewed changes

github-project-automation bot moved this from 🆕 New to ✅ Approved in 🔎 Review Oct 22, 2025

jezdez requested changes Oct 23, 2025

View reviewed changes

news/15342-ignore-PATH-env-var Outdated Show resolved Hide resolved

conda/activate.py Outdated Show resolved Hide resolved

github-project-automation bot moved this from ✅ Approved to 🏗️ In Progress in 🔎 Review Oct 23, 2025

soapy1 dismissed ryanskeith’s stale review via c5f71ef October 23, 2025 16:00

soapy1 added this to conda Roadmap and Sprint Planning Oct 23, 2025

github-project-automation bot moved this to Sorting ⚙️ in conda Roadmap and Sprint Planning Oct 23, 2025

soapy1 moved this from Sorting ⚙️ to In review 🔍 in conda Roadmap and Sprint Planning Oct 23, 2025

ryanskeith reviewed Oct 23, 2025

View reviewed changes

conda/activate.py Outdated Show resolved Hide resolved

soapy1 force-pushed the dont-change-path-var branch from f4f34cb to d2a96b1 Compare October 23, 2025 22:33

soapy1 self-assigned this Oct 27, 2025

jezdez reviewed Oct 28, 2025

View reviewed changes

conda/activate.py Outdated Show resolved Hide resolved

jezdez reviewed Oct 28, 2025

View reviewed changes

conda/activate.py Show resolved Hide resolved

jezdez reviewed Oct 28, 2025

View reviewed changes

soapy1 and others added 5 commits October 28, 2025 10:34

Don't modify reserved environment variables when (de)/activating

6b0978d

For example, users should not be able to change their PATH environment variable thru their environment config. This change will ignore these reserved variables and print a warning to the user.

[pre-commit.ci] auto fixes from pre-commit.com hooks

e3a9746

for more information, see https://pre-commit.ci

Add news

ff5bf81

Update news/15342-ignore-PATH-env-var

c6cc940

Co-authored-by: Jannis Leidel <[email protected]>

Collect all reserved env vars into one warning message

0252c32

pre-commit-ci bot and others added 5 commits October 28, 2025 10:34

[pre-commit.ci] auto fixes from pre-commit.com hooks

4b2ffff

for more information, see https://pre-commit.ci

Only print warning once

9541131

Improve warning for reserved environment variables in activation logic

1b70180

[pre-commit.ci] auto fixes from pre-commit.com hooks

f71fa43

for more information, see https://pre-commit.ci

Include prefix name in invalid env var config warning

93ea5af

soapy1 mentioned this pull request Oct 28, 2025

Warn when a user is setting a reserved environment variable #15354

Merged

3 tasks

soapy1 force-pushed the dont-change-path-var branch from 4ed9851 to 93ea5af Compare October 28, 2025 17:39

soapy1 requested review from jezdez and ryanskeith October 30, 2025 21:47

jezdez approved these changes Nov 4, 2025

View reviewed changes

github-project-automation bot moved this from 🏗️ In Progress to ✅ Approved in 🔎 Review Nov 4, 2025

jezdez merged commit 3ba3d38 into conda:main Nov 4, 2025
76 checks passed

github-project-automation bot moved this from ✅ Approved to 🏁 Done in 🔎 Review Nov 4, 2025

github-project-automation bot moved this from In review 🔍 to Done 💪🏾 in conda Roadmap and Sprint Planning Nov 4, 2025

soapy1 deleted the dont-change-path-var branch November 4, 2025 17:05

soapy1 mentioned this pull request Nov 20, 2025

TypeError: conda.activate._Activator.get_export_unset_vars() got multiple values for keyword argument 'PATH' #15292

Closed

2 tasks

Conversation

soapy1 commented Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist - did you ...

Uh oh!

codspeed-hq bot commented Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #15342 will not alter performance

Summary

Footnotes

Uh oh!

soapy1 commented Oct 20, 2025

Uh oh!

ryanskeith left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

soapy1 commented Oct 23, 2025

Uh oh!

ryanskeith left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jezdez left a comment

Choose a reason for hiding this comment

Uh oh!

jezdez commented Oct 28, 2025

Uh oh!

soapy1 commented Oct 28, 2025

Uh oh!

soapy1 commented Oct 28, 2025

Uh oh!

soapy1 commented Nov 3, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

soapy1 commented Oct 20, 2025 •

edited

Loading

codspeed-hq bot commented Oct 20, 2025 •

edited

Loading