Advertize type annotations with py.typed #1677
Merged
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
Existence of py.typed in the top-level package tells users of the packages that the packages are annotated. This should fix mypy errors like this in downstream projects: error: Skipping analyzing "tuf.api.metadata": found module but no type hints or library stubs Fixes theupdateframework#1633 Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
Pull Request Test Coverage Report for Build 1462084136
💛 - Coveralls |
|
The one issue here might be upstream projects that
I'm not sure if any such projects like this exist but for them py.typed would be misleading and they will have to add some mypy config to skip tuf packages... Not optimal but maybe something we can live with until we remove legacy code? |
joshuagl
approved these changes
Nov 15, 2021
Closed
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.
Existence of py.typed in the top-level package tells users of the
packages that all packages are annotated.
This should fix mypy errors like this in downstream projects:
Fixes #1633
Signed-off-by: Jussi Kukkonen jkukkonen@vmware.com