ecordell / pymacaroons

A Python Macaroon Library
pymacaroons.readthedocs.org
MIT License
79 stars 23 forks source link

Add pyi type hints for Macaroon, Caveat #64

Open redmer opened 8 months ago

redmer commented 8 months ago

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. image

They even combine the docstrings with the .pyi typehints. image

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.