Add type annotations #37
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is based on #31, #32, #34, #35, and #36. Review those first. It adds type annotations to the source code. Type annotations allow us to catch errors before we get to runtime and also serve as documentation.
Although this is a big PR, this PR changes almost nothing about the behavior, except adding some
assertandimportstatements; the bulk of the changes (type signatures) do not affect runtime behavior at all.Now that type annotations have been added, we can catch errors before running the code with
MYPYPATH=src mypy --strict src tests, which has been added to the GitHub CI.