Repository navigation
Add py.typed file to officialy declare that the module is typed - #113
Merged
Merged
Conversation
Owner
|
Arghhh now this is embarrassing! π€¦ββοΈ I'll wait a moment if anything else comes up and cut 21.3.0 later this week. Thanks! |
hynek
added a commit
that referenced
this pull request
Dec 9, 2021
This file contains hidden or 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
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.
Typing was added in the module in #112.
But according to PEP 561, to officially declare that type checking is supported, libraries are expected to distribute a
py.typedfile in the built package:Without this file, the module is not considered as typed, and type checkers like
mypywill raise errors like:even if the module is fully typed.
This PR simply adds a
py.typedfile to officially declare that the module is typed.To ensure that it is correctly distributed in the built package, I ran: