enable type hints when importing nox #274
Merged
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.
Because nox is not marked as containing type hints, any libraries that imports nox will get a mypy error saying the library is untyped. To fix this, users have had to do
to avoid errors such as
This PR implements instructions in the mypy documentation to tell mypy that nox does indeed have inline types (https://mypy.readthedocs.io/en/latest/installed_packages.html#making-pep-561-compatible-packages). Though rather strange and arbitrary, this is the standard way to do this. GvR himself committed a py.typed to mypy here.
If this code is merged, the
# type: ignore
comment will no longer be necessary for users of nox, and they can be confident their code doesn't have type errors.