Add type hints #148
Open
Add type hints #148
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
salty-horse
force-pushed
the
type_hinting
branch
from
1857914
to
c26a744
Compare
salty-horse
force-pushed
the
type_hinting
branch
from
c26a744
to
9c6b0c3
Compare
salty-horse
force-pushed
the
type_hinting
branch
from
7935a66
to
f4dcd50
Compare
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 adds type hints to the library, so tools such as mypy will be able to check usage (and won't complain about missing types when importing it).
Tested with Python 3.8
Notes:
__init__.py.stream_compressandstream_decompressI defined generic inputs / outputs since the provided de/compressor class can convert between bytes and str. I tested such a class and it passed type checking. I'm sure the typing of that section can be improved, perhaps by using Reader and Writer protocols instead of IO, but this is beyond my very limited proficiency.