add typing information #277
Merged
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
BYK
approved these changes
Nov 16, 2024
src/hpack/hpack.py
Outdated
| @@ -143,11 +138,11 @@ def _dict_to_iterable(header_dict): | |||
| yield key, header_dict[key] | |||
|
|
|||
|
|
|||
| def _to_bytes(string): | |||
| def _to_bytes(string: Union[bytes, str, Any]) -> bytes: | |||
There was a problem hiding this comment.
Just Any probably covers all but I like you calling out the "expected" types. Maybe add a comment about this to avoid confusion in future readers?
| @@ -575,7 +572,7 @@ def _decode_literal(self, data, should_index): | |||
| high_byte = data[0] | |||
| indexed_name = high_byte & 0x0F | |||
| name_len = 4 | |||
| not_indexable = high_byte & 0x10 | |||
| not_indexable = bool(high_byte & 0x10) | |||
|
|
||
| from .exceptions import InvalidTableIndex | ||
|
|
||
| log = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| def table_entry_size(name, value): | ||
| def table_entry_size(name: Union[bytes, str], value: Union[bytes, str]) -> int: |
There was a problem hiding this comment.
Maybe we can abstract this Union[bytes, str] and tuple[bytes, bytes] into type definitions as they are used in a bunch of places. Something like RawHeaderPiece and UntypedHeaderTuple respectively?
There was a problem hiding this comment.
Yes! It was on my ToDo list, but didn't make it for this first PR - happy to be refactored in a future PR!
I'm working on a similar PR for the h2 library as well, so we might want to hold off on type aliases until we have a full picture.
Kriechi
force-pushed
the
typing
branch
2 times, most recently
from
04b0c41
to
1534dfe
Compare
Kriechi
force-pushed
the
typing
branch
2 times, most recently
from
4d840ab
to
55e1e7e
Compare
BYK
reviewed
Nov 19, 2024
Kriechi
force-pushed
the
typing
branch
2 times, most recently
from
fc455ed
to
1702e21
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.
also closes #274