Request: Add Type Annotation

[yangdanny97]

Question

Hi, I'm following up from this post in the Python Typing forum, where this project was mentioned as a potential area that could benefit from typing investments.

I see that type annotations is mentioned on the roadmap here: #1028 but I'm not sure if there has been any experiments or progress in that direction.

I'd like to learn more about the current state and future plans for type annotations, and any pain points you've encountered in that area. Is there any tooling/automation that you wish you had, that could make the process of annotating this package easier?

Thanks!

[jmcnamara]

@yangdanny97 Thanks for the interest.

I'd like to learn more about the current state and future plans for type annotations, and any pain points you've encountered in that area.

I have completed the general refactoring that was a precursor to the v2 work. I had also started on the Image type (with Color, Url and Formula to follow). My idea was to add annotations to these new classes/types as a first step and then add them to the rest of the library.

Is there any tooling/automation that you wish you had, that could make the process of annotating this package easier?

Is there tooling available? Do you have any suggestions?

[yangdanny97]

Is there tooling available? Do you have any suggestions?

I think a good first step would be to get a typechecker running locally & in CI, to make sure that the newly-added types are consistent with each other.

In terms of automation that can help fill in types, autotyping can help fill out simple/trivial stuff, and monkeytype can help with more complex stuff if you have an extensive test suite.

[jmcnamara]

I have started this work, module by module, on the type_annotations branch. I will keep track of any pain points and let you know at the end.