fix(typing): Explicitly declare public API #3
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
Pyright flags our `orjsonl.append` because PEP 484’s stub-file export rules (import-as-alias or __all__) are applied to all py.typed libraries (PEP 561). We therefore need to re-export append explicitly, e.g. append as append or via __all__, so type checkers recognise it as part of the public API. This is fixed by reexporting as done in this PR.
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.
Pyright flags our
orjsonl.appendbecause PEP 484’s stub-file export rules (import-as-alias or all) are applied to all py.typed libraries (PEP 561).We therefore need to re-export append explicitly, e.g. append as append or via all, so type checkers recognise it as part of the public API.
This is fixed by reexporting as done in this PR.