Switch event classes to dataclasses#124
Merged
pgjones merged 1 commit intopython-hyper:masterfrom May 16, 2021
Merged
Conversation
Closed
efa2dd2 to
906cffe
Compare
bluetech
reviewed
Dec 28, 2020
Contributor
bluetech
left a comment
There was a problem hiding this comment.
I am personally not a big fun of using dataclasses or attrs in a public library API, because
- They add some startup overhead (probably negligible in this case though).
- They add "hidden" APIs to the classes, like
dataclasses.asdict,dataclasses.replaceetc. which users will eventually rely on, making it part of the public API. - They somewhat reduce (or add friction to) the library's control should it ever need it.
- They tend to do some funky stuff, for example in pytest we had some trouble with what dataclasses does here.
That said, if you're OK with this, the code LGTM except one comment.
The _EventBundle used previously dynamically creates the Event classes, which makes typing hard. As the Event classes are now stable the dynamic creation isn't required, and as h11 supports Python3.6+ dataclasses can be used instead. This now makes the Events frozen (and almost imutable) which better matches the intended API. In turn it requires the `object.__setattr__` usage and the alteration to the `_clean_up_response_headers_for_sending` method. This change also improves the performance a little, using the benchmark, Before: 6.7k requests/sec After: 6.9k requests/sec Notes: The test response-header changes are required as the previous version would mutate the response object. The init for the Data event is required as slots and defaults aren't possible with dataclasses.
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
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.
The _EventBundle used previously dynamically creates the Event
classes, which makes typing hard. As the Event classes are now stable
the dynamic creation isn't required, and as h11 supports Python3.6+
dataclasses can be used instead.
This now makes the Events frozen (and almost imutable) which better
matches the intended API. In turn it requires the
object.__setattr__usage and the alteration to the
_clean_up_response_headers_for_sendingmethod.This change also improves the performance a little, using the
benchmark,
Before: 6.7k requests/sec
After: 6.9k requests/sec
Notes:
The test response-header changes are required as the previous version
would mutate the response object.
The init for the Data event is required as slots and defaults aren't
possible with dataclasses.