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

Add type hints to the library API #90

Open
3 tasks
oleg-nenashev opened this issue Aug 30, 2023 · 0 comments
Open
3 tasks

Add type hints to the library API #90

oleg-nenashev opened this issue Aug 30, 2023 · 0 comments

Comments

@oleg-nenashev
Copy link
Member

Proposal

The Python runtime does not enforce function and variable type annotations, but they can be used by third party tools such as type checkers, IDEs, linters, etc. PEP-484 and 483 introduced a standard for typing annotations that are supported in modern Python IDEs, and mentioned as a part of the minimum quality bar for adoption

Scope

  • Annotate the existing API with Types - likely a breaking change for 3.0
  • Document the expectations in the contributing guide
  • Enable the necessary linters in the project itself

References

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

No branches or pull requests

1 participant