Add pyi type hints for Macaroon, Caveat #64
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
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.
Hey, I've added some initial type hints for the Macaroon and Caveat classes. I've tested them locally and these improve autocomplete hints as per the VS Code screenshots below.
They even combine the docstrings with the .pyi typehints.
I've also added some references to these type stubs in the setup files, per https://mypy.readthedocs.io/en/stable/installed_packages.html#creating-pep-561-compatible-packages, but I'm quite unsure how to test that even locally. I wasn't sure how to make type hint tests that don't hinder this package's compatibility matrix.