Add py.typed to export types
#21
Merged
Conversation
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
Turns out the typechecker will ignore the type hints declared in dependencies unless those dependencies contain an empty `py.typed` file. See [this article][article] and [PEP 561][pepsi] for more information. [article]: https://blog.whtsky.me/tech/2021/dont-forget-py.typed-for-your-typed-python-package/ [pepsi]: https://peps.python.org/pep-0561/#packaging-type-information
|
✔️ All good! |
tombruijn
approved these changes
Apr 26, 2023
|
Now that I think about it, I think this might actually break things for users that make use of typing, since we use incomplete features that need to be enabled in mypy's command line for what's pretty much the only public interface at the moment 🙃 Maybe let's enable it anyway and see if it's actually a problem in practice? EDIT: according to this issue comment it wouldn't be a problem at call point, just at the declaration point -- not sure if it means users wouldn't be affected. |
10616f1 to
a635171
Compare
|
Merging -- we can always revisit later. Test failure is Lintje because I rebased out a commit from the branch. |
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.
Turns out the typechecker will ignore the type hints declared in dependencies unless those dependencies contain an empty
py.typedfile. So users who use our library will not be able to make use of our type hints unless we add this file.See this article and PEP 561 for more information.
[skip changeset]