Add py.typed for type checkers following PEP 561 #41
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
|
Hi, thanks for the PR, looks good to me |
|
May be we can add a test with mypy to somehow test this behavior? |
dhvcc
approved these changes
Jul 15, 2023
I‘ve checked but did not find a way to test it with a simple command line parameter. Maybe they would implement one if asked? Otherwise, one could setup a test project importing this one and check if mypy raises an issue that it cannot find type hintings for the imported project. However, sadly currently I have no time to look into this myself. Thanks for merging ❤️ |
|
Creating a code with import is how I tested it, we could do that, but with no changes to this in near future I don't see a need |
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.
While the
py.typedfile is missing, type checkers like mypy will treat the library as untyped when included into other projects. This behavior is defined in PEP 561 Adding this file to the package (and ensure it gets packaged) does make the library accessible for type checkers.To add it, I followed this short guide.
To test it, I force-installed your package into a venv, wrote test code which uses this library, and verified that mypy now can type check everything (aka. following error is now missing:
Skipping analyzing "rss_parser": module is installed, but missing library stubs or py.typed marker [import])