Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add pyi stubs for better static analysis #490

Open
chadrik opened this issue Aug 18, 2019 · 1 comment
Open

Add pyi stubs for better static analysis #490

chadrik opened this issue Aug 18, 2019 · 1 comment

Comments

@chadrik
Copy link
Contributor

chadrik commented Aug 18, 2019

Hi,
I've written pyi stub files for this project that I'd like to submit to the python typeshed, which is a collection of type data about the stdlib and third party packages that is used by static type analyzers like mypy and PyCharm. As per their instructions, I need written sign off from the author in order to contribute these.

As an alternative to adding the stubs to the typeshed, they can be added to the project and released through the normal distutils mechanism: https://www.python.org/dev/peps/pep-0561/

Related to #257

Thanks!

@jmadler
Copy link
Contributor

jmadler commented Oct 17, 2019

Thanks for doing this! All else being equal, I would prefer the type hints are colocated with the code itself. Could you submit a patch to include this information in the project?

I'll include it in a release in the next few days.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants