avoid breaking Python environment by prepending CIME paths to PYTHONPATH #4683
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
lexming
added a commit
to vub-hpc/cesm-config
that referenced
this pull request
Sep 20, 2024
wpoely86
added a commit
to vub-hpc/cesm-config
that referenced
this pull request
Sep 20, 2024
add patch from PR ESMCI/cime#4683
jgfouca
approved these changes
Sep 20, 2024
|
Thanks for the quick merge! |
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.
CIME currently carries out a full reset of the
PYTHONPATHenvironment variable. This is bad practice as other software in the user's session might rely on their paths being present inPYTHONPATHto be usable.For instance, in HPC clusters it's very common to use modules to load software packages on-demand and those modules will add the paths of the loaded Python software to
PYTHONPATH. In our case, we providelxmlas a module, which is one of the dependencies of CIME. Therefore, CIME is breaking itself by resettingPYTHONPATH.This PR changes how CIME handles
PYTHONPATHby prependingcime_rootandtools_pathtoPYTHONPATHinstead of fully replacing it. This achieves the same goal of ensuring that external python can correctly import the CIME module, without breaking the rest of the Python ecosystem in the user's session.Test suite: n/a
Test baseline: n/a
Test namelist changes: n/a
Test status: n/a
Fixes: no open issue, but I can make a new one if you wish
User interface changes?: N
Update gh-pages html (Y/N)?: N