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

Consider type-checking Python code #25

Open
benpankow opened this issue Sep 27, 2019 · 0 comments
Open

Consider type-checking Python code #25

benpankow opened this issue Sep 27, 2019 · 0 comments

Comments

@benpankow
Copy link
Contributor

We should consider using a static type checker and PEP 484 type hints in our codebase.

There are a few benefits to using type annotations for function signatures - they help self-document the codebase as it grows, and they help catch type errors which may introduce bugs into our code.

While type hints are a built-in part of the Python language, Python doesn't validate the correctness of these types. This is where a static type checker would be useful, which could be run during development and by CI at PR time. The de-facto standard is mypy, but pyre is also an option.

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