Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Request: Add stubs file and type checking #31

Open
parker-research opened this issue Nov 19, 2024 · 5 comments
Open

Request: Add stubs file and type checking #31

parker-research opened this issue Nov 19, 2024 · 5 comments

Comments

@parker-research
Copy link

It would be awesome if you added a stubs file (and type hints within the exposed parts of the API) so that static type checkers (e.g., pyright) can properly type check with this library.

Given the very minimal exposed API, I bet it would be a very straight-forward job to add them!

Thanks!

@vb64
Copy link
Owner

vb64 commented Nov 19, 2024

Python type hints was added in latest version (1.3.1), please update your installation.

@vb64
Copy link
Owner

vb64 commented Nov 19, 2024

About pyright type stub files.

I don't use pyright. If you wants extended support for this third-party tool, you can create pull request with these files, located at suitable place into module distribution.

@parker-research
Copy link
Author

Okay, I may get around to that.

Thanks for adding type hinting though!

@vb64 vb64 closed this as completed Dec 22, 2024
@parker-research
Copy link
Author

Would you please consider leaving this open until I get to it as a reminder, and as a place to centralize discussion?

@vb64 vb64 reopened this Dec 23, 2024
@vb64
Copy link
Owner

vb64 commented Dec 23, 2024

Would you please consider leaving this open until I get to it as a reminder, and as a place to centralize discussion?

of course yes

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

No branches or pull requests

2 participants