Some changes to spack_root_to_path
#342
Merged
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
* Add comments to improve clarity of all the conditions considered * There were unnecessary `else` branches * Cater for the dramatic case where both `SPACK_ROOT` and `PATH` are not set * Fix the case where `PATH` isn't set but `SPACK_ROOT` is (we were returning the function `dir` before, fun) * Fix the case where `spack_bindir` isn't in `PATH` (we were using `*` for non-commutative concatenation of strings, it turns out in Python one should use `+` instead for this operation)
giordano
force-pushed
the
mg/fix-spack-root-to-path
branch
from
88bb71a to
ffe5a9d
Compare
tkoskela
reviewed
Sep 10, 2024
Comment on lines
+21
to
+33
| # Somehow we don't know what's the Spack root, then return PATH as is, | ||
| # but if also PATH is not set (what a dramatic case) then return an | ||
| # empty string. | ||
| return "" if path is None else path | ||
|
|
||
| spack_bindir = os.path.join(spack_root, 'bin') | ||
| if path is None: | ||
| # Somehow PATH isn't set, only return `spack_bindir` | ||
| return spack_bindir | ||
|
|
||
| if spack_bindir in path.split(os.path.pathsep): | ||
| # `spack_bindir` is already in PATH, return the environment | ||
| # variable as is. |
There was a problem hiding this comment.
To make this more readable, could you start with the most likely cases and leave the corner cases to the end?
There was a problem hiding this comment.
I first need to check spack_bindir and path aren't None though, which is what the two ifs above are doing.
There was a problem hiding this comment.
Right, I didn't realise all the if branches return and thought they'd all get checked regardless. It's fine then
tkoskela
approved these changes
Sep 11, 2024
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.
elsebranchesSPACK_ROOTandPATHare not setPATHisn't set butSPACK_ROOTis (we were returning the functiondirbefore, fun)spack_bindirisn't inPATH(we were using*for non-commutative concatenation of strings, it turns out in Python one should use+instead for this operation)