typing: add initial types #488
Merged
Conversation
This file contains hidden or 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
johnfraney
force-pushed
the
initial-typing
branch
5 times, most recently
from
813a787 to
2e653e3
Compare
sloria
reviewed
Jan 20, 2025
Owner
There was a problem hiding this comment.
thanks! looks good on a quick skim 👍
we should add type checking to tox/CI as well, but this can happen in a follow-up PR. I agree this can be an incremental effort. here's how it's set up in marshmallow (with mypy but easy enough to swap it out with pyright
sloria
reviewed
Jan 20, 2025
johnfraney
force-pushed
the
initial-typing
branch
2 times, most recently
from
edfbb7b to
600f255
Compare
johnfraney
force-pushed
the
initial-typing
branch
from
600f255 to
3117e11
Compare
sloria
approved these changes
Jan 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Adds initial types and type-checking with Pyright. This contributes to #468 but doesn't finish it.
Notes
There's still a lot of typing to do. I didn't want to introduce any friction to other development, so I didn't add a
py.typedfile or type-checking in a pre-commit hook or CI. Those are things we can do once we have solid types.There are times when I'm unsure whether we should be using
strorstr | bytes/AnyStr, and I tried to get that right through how the variables are used. I hope I got them right.There are quite a few missing imports in
src/textblob/en/__init__.py: https://github.com/johnfraney/TextBlob/blob/dev/src/textblob/en/__init__.py#L1, but that seemed a little out-of-scope for this PR.Results
Pyright results before:
After: