Implement asynchronous unpacking API #2
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2 +/- ##
==========================================
Coverage 100.00% 100.00%
==========================================
Files 28 28
Lines 1843 2136 +293
==========================================
+ Hits 1843 2136 +293 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
… and improve the testing utilities
|
Tests will be converted to the new testing APIs for |
…acket's async API
|
I'm being a little sloppier than I normally would be with commit hygiene and whatnot, but only because I expect this PR to be merged soon and want to focus on that |
…to align with Python 3.13 behavior
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.
There are certain protocols which do not know how much data their packets take up before unpacking them, which poses a problem when attempting to parse such packets from an
asyncio.StreamReader. Therefore after much deliberation, I have decided to implement an asynchronous API adjacent to the pre-existing synchronous one.It will be up to each
Typeto implement one API or the other or both, and I aim for pre-existing user code to be largely, if not totally, unaffected.All types in Pak will support both APIs, and testing will need to be adjusted accordingly. Towards that, the
pak.testAPIs will also be updated to ease that testing.I don't envision these changes to be so invasive towards the codebase, but it will result in largely duplicate codepaths for synchronous and asynchronous unpacking. Unfortunately, it seems to me the best option.