Type-check noxfile.py #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
cjolowicz
force-pushed
the
typecheck-noxfile
branch
from
08911df
to
5550934
Compare
|
It would be better to point |
Use the --python-executable option to mypy to point the type checker to the Python installation running Nox, rather than the virtual environment of the Nox session, when type-checking noxfile.py itself. This allows mypy to find the type information for Nox, without having to install Nox into the session. Nox distributes type information inline and declares this fact using the py.typed file specified in PEP 561. Note that this check is somewhat indeterministic in local testing. The Nox version is only pinned in CI. For users with a pre-2020.5.24 version of Nox, the session will fail due to missing type hints. The session may also conceivably fail in the future if users install a newer version of Nox with breaking changes. (In the latter case, the failure serves as a useful reminder that noxfile.py needs to be adapted to the API changes.)
cjolowicz
force-pushed
the
typecheck-noxfile
branch
from
5550934
to
3e50219
Compare
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.
Use the --python-executable option to mypy to point the type checker to the Python installation running Nox, rather than the virtual environment of the Nox session, when type-checking
noxfile.pyitself. This allows mypy to find the type information for Nox, without having to install Nox into the session. Nox distributes type information inline and declares this fact using the py.typed file specified in PEP 561.Note that this check is somewhat indeterministic in local testing. The Nox version is only pinned in CI. For users with a pre-2020.5.24 version of Nox, the session will fail due to missing type hints. The session may also conceivably fail in the future if users install a newer version of Nox with breaking changes. (In the latter case, the failure serves as a useful reminder that noxfile.py needs to be adapted to the API changes.)
Closes #337