verdi run: Do not add pathlib.Path instance to sys.path
#5810
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
sphuber
force-pushed
the
fix/5809/verdi-run-sys-path
branch
from
ad43e1b
to
ab54cfc
Compare
chrisjsewell
suggested changes
Dec 6, 2022
There was a problem hiding this comment.
You can also remove aiida/cmdline/commands/cmd_run.py from the mypy exclude list,
since the only error is:
mypy.....................................................................Failed
- hook id: mypy
- exit code: 1
aiida/cmdline/commands/cmd_run.py:31: error: Argument 1 to "append" of "list" has incompatible type "Path"; expected "str" [arg-type]
A very good example of why to use type checking 😄
The `verdi run` command updates `sys.path` to include the current working directory such that modules in it can be imported by the script being run. However, it was using `pathlib` to get the CWD and was adding a `Path` instance to the path, which should only contain `str` instances. This was uncovered by trying to import `tensorflow` which also manipulates the `sys.path` and was raising an error since it was trying to iterate over all elements and `pathlib.Path` is not iterable, unlike `str`.
sphuber
force-pushed
the
fix/5809/verdi-run-sys-path
branch
from
ab54cfc
to
75b7e20
Compare
chrisjsewell
approved these changes
Dec 6, 2022
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.
Fixes #5809
The
verdi runcommand updatessys.pathto include the current working directory such that modules in it can be imported by the script being run. However, it was usingpathlibto get the CWD and was adding aPathinstance to the path, which should only containstrinstances. This was uncovered by trying to importtensorflowwhich also manipulates thesys.pathand was raising an error since it was trying to iterate over all elements andpathlib.Pathis not iterable, unlikestr.