PEP 561 compatibility (py.typed) and explicit re-exports #125
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
This is necessary to avoid errors from the no-implicit-reexport rule both in the library and in projects using the library. It's also cleaner to have explicit exports.
binaryDiv
added
enhancement
l1f
approved these changes
Aug 7, 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.
This PR is another small step towards full mypy support (#116).
It adds the
py.typedfile to make the package PEP 561 compatible (if this file is present, type checkers know that the library is properly typed and can rely on its type annotations).It also introduces explicit re-exports in
__init__.pyfiles using the__all__variable. This is necessary to enable theno-implicit-reexportmypy rule, not just for running mypy on the library itself, but also for projects that use validataclass. It's also just cleaner to explicitly re-export everything.I also had to add a rule exception to one of the unit test files because mypy reported errors for it. I'm not sure why these errors only popped up now, though.