Re-export symbols to match PEP 484 standard. #8
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
Python type checker libraries such as Pyright have built a consensus around PEP 484 for how to export symbols from a py.typed library. This requires redundantly re-exporting symbols to make them publicly visible. Without re-exporting the symbol type checkers will complain that the symbol (e.g., from aws_error_utils.errors) is not exported, but a direct import will work as expected (e.g., from aws_error_utils.aws_error_utils import errors). Based on official Python guidance to type checkers: https://github.com/python/typing/blob/master/docs/source/libraries.rst#library-interface-public-and-private-symbols For more detail from author of Pyright (for a similar issue in PyTorch): microsoft/pylance-release#2953 (comment)
holocronweaver
force-pushed
the
master
branch
from
11d8690 to
134ccc8
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Python type checker libraries such as Pyright have built a consensus around PEP 484 for how to export symbols from a py.typed library. This requires redundantly re-exporting symbols to make them publicly visible.
Without re-exporting the symbol type checkers will complain that the symbol (e.g., from aws_error_utils.errors) is not exported, but a direct import will work as expected (e.g., from aws_error_utils.aws_error_utils import errors).
Based on official Python guidance to type checkers: https://github.com/python/typing/blob/master/docs/source/libraries.rst#library-interface-public-and-private-symbols
For more detail from author of Pyright (for a similar issue in PyTorch): microsoft/pylance-release#2953 (comment)
This should resolve #9.