Type Stubs Maintenance/Tooling

[yangdanny97]

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'm curious to learn about what your current workflow is for developing these stubs and keeping it up to date, and what the major pain points are.

Since this is a stubs package, I'm wondering if any of the tooling/infra from the typeshed project could help you maintain these stubs, for example:

1. stubsabot: whenever the main package is released, it opens a PR that contains some information about what changed since the last release ([stubsabot] Bump Authlib to 1.5.* python/typeshed#13536)
2. stubtest (https://mypy.readthedocs.io/en/stable/stubtest.html): check stub types against runtime values, flag parts of the API that aren't covered by stubs
3. running various linters and typecheckers in CI to make sure the stubs work for other major typecheckers besides mypy (I see you run mypy locally, but I don't see a CI workflow setup)

We're exploring the possibility of making a generic setup of some of these tools, so that it can be easily used in other stubs projects outside of typeshed - do you think that would be useful for your project?

Are there other areas that you see potential for automation in, or tools that you wish you had?

[zen-xu]

I created this project simply because there were no relevant type annotations at the time, and I happened to be stuck at home due to COVID-19, so I started it out of boredom.

However, I don’t have enough time to maintain it now. If the typeshed team is interested, I’m willing to donate it.

[yangdanny97]

Thanks for the details!

What's the current state of the stubs w.r.t completeness and consistency with the implementation?

Edit:

Have you spoken to the arrow maintainers about potentially merging the stubs into the implementation as inline types or bundled stubs?

That would be preferable to moving things into typeshed, since typeshed maintainers are also stretched pretty thin. But if merging the stubs into the main package is not an option, I can file an issue on typeshed.

[zen-xu]

Currently meets most requirements, but there may be some corner case issues

[dangotbanned]

#186 (comment)

Have you spoken to the arrow maintainers about potentially merging the stubs into the implementation as inline types or bundled stubs?

@yangdanny97 these might be relevant

• [Python] Type checking support apache/arrow#32609 (comment)
• [Python] Type stubs apache/arrow#30426 (comment)

[yangdanny97]

Edit: I misunderstood, the comment I linked to wasn't made by a maintainer.

@dangotbanned thanks for the info!

from the second issue it seems like the arrow maintainers are open to merging the stubs in. I'll follow up with them

apache/arrow#30426 (comment)