[PR #11139/3dafd4c7 backport][3.12] Fix IOBasePayload reading entire files into memory instead of chunking #11141
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 is a backport of PR #11139 as merged into master (3dafd4c).
What do these changes do?
This PR fixes a memory consumption issue where
IOBasePayload
andTextIOPayload
would read entire files into memory when streaming large files. The bug was introduced in #10915 and caused the payload classes to readremaining_content_length
bytes at once instead of chunking the reads.The fix ensures that both payload classes never read more than
READ_SIZE
(64KB) at a time, regardless of the file size or content length. This prevents out-of-memory errors when uploading large files using file-like objects with the aiohttp client.Are there changes in behavior for the user?
No behavioral changes for users. The fix is transparent and only affects memory usage during file streaming. Files are still uploaded correctly, but now they're read in 64KB chunks instead of potentially reading gigabytes into memory at once.
Is it a substantial burden for the maintainers to support this?
No, this is a minimal fix that restores the original intended behavior. The changes are:
READ_SIZE
as the first parameter tomin()
in_read_and_available_len()
for bothIOBasePayload
andTextIOPayload
_read()
method is called with appropriate chunk sizesThe fix is straightforward and maintains backward compatibility while fixing a critical memory issue.
Related issue number
Fixes #11138
Checklist
CONTRIBUTORS.txt
CHANGES/
foldername it
<issue_or_pr_num>.<type>.rst
(e.g.588.bugfix.rst
)if you don't have an issue number, change it to the pull request
number after creating the PR
.bugfix
: A bug fix for something the maintainers deemed animproper undesired behavior that got corrected to match
pre-agreed expectations.
.feature
: A new behavior, public APIs. That sort of stuff..deprecation
: A declaration of future API removals and breakingchanges in behavior.
.breaking
: When something public is removed in a breaking way.Could be deprecated in an earlier release.
.doc
: Notable updates to the documentation structure or buildprocess.
.packaging
: Notes for downstreams about unobvious side effectsand tooling. Changes in the test invocation considerations and
runtime assumptions.
.contrib
: Stuff that affects the contributor experience. e.g.Running tests, building the docs, setting up the development
environment.
.misc
: Changes that are hard to assign to any of the abovecategories.
Make sure to use full sentences with correct case and punctuation,
for example:
Use the past tense or the present tense a non-imperative mood,
referring to what's changed compared to the last released version
of this project.