arrow-py / arrow

🏹 Better dates & times for Python
https://arrow.readthedocs.io
Apache License 2.0
8.64k stars 667 forks source link

PEP 484 no .pyi file present #1111

Open reagle opened 2 years ago

reagle commented 2 years ago

Hi, I've been trying to make use of type hints and just used this library for the first time. Your documentation says "Full support for PEP 484-style type hints" but I don't see what types I can use via a pyi file or documentation.

krisfremen commented 2 years ago

We don't have stub files(pyi) as the type hints are in the code itself.

The docs at https://arrow.readthedocs.io/en/latest/#api-guide also have the return types for each function/method.

reagle commented 2 years ago

Again, I apologize for my newb, but I looked briefly at the code and wasn’t sure what the annotations would be that I could use with mypy for instance. I looked at the tests in particular for annotations on function signatures.