Flush AsyncBytesProvider on close by default #338
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
JordonPhillips
force-pushed
the
provide-until-empty
branch
from
68684f3
to
19ae8f2
Compare
This updates the default behavior of close on AsyncBytesProvider to flush already-written data. This should be the less surprising outcome, particularly when the class is used as a context manager.
JordonPhillips
force-pushed
the
provide-until-empty
branch
from
19ae8f2
to
d015a58
Compare
JordonPhillips
changed the title
nateprewitt
reviewed
Nov 25, 2024
Comment on lines
+465
to
+467
| # The draining task should be able to complete without errors. When next it | ||
| # tries to get a chunk, the provider's iterator will exit. | ||
| await drain_task |
There was a problem hiding this comment.
Is there anything we can assert about the final state here or is this only to validate nothing is raised?
There was a problem hiding this comment.
This is only to validate that it closes successfully and nothing is raised. The function doesn't return anything directly, so there's nothing else to check.
nateprewitt
approved these changes
Nov 25, 2024
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 updates the default behavior of close on AsyncBytesProvider to flush already-written data. This should be the less surprising outcome, particularly when the class is used as a context manager.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.