Type stubs?

[vergenzt]

Would you be open to type stubs being merged into this repo?

[vsajip]

I would prefer separate stubs, at least for now, as the package still supports Python 2.x.

[vergenzt]

What if it were proposed in a separate .pyi file, leaving the existing Python-2.x-compatible code unannotated?

[vsajip]

That seems more reasonable - by all means propose a .pyi file with typing information, and I'll aim to keep that updated with any API changes. I'm not too familiar with Python typing tools - what would be a reasonable test that the typing information is complete for all APIs?

[lovetox]

https://github.com/microsoft/pyright/

and here a github action you can use https://github.com/jakebailey/pyright-action

[lovetox]

#248

I dont think there is a way to test if the API is typed. All typing tools test the whole code of the project for missing types or type errors, to my knowledge there is no way to tell it "test only public API"

[vergenzt]

@lovetox yeah pyright doesn't validate that type stubs are consistent with the base untyped Python code.

There's a mypy tool that targets this use case: Automatic stub testing (stubtest) - mypy 1.14.1 documentation

And more discussion here: python/mypy#5028

I've never attempted this though, so am not yet familiar with the rough edges.

[vergenzt]

https://github.com/instagram/MonkeyType looks like a tool that might also be useful!

MonkeyType uses the sys.setprofile hook provided by Python to interpose on function calls, function returns, and generator yields, and record the types of arguments / return values / yield values.

[lovetox]

I contribute the stubs to typeshed, as after discussion the maintainer dont want to ship the stubs.

See python/typeshed#13465