gh-135648: Document that shutil.copyfileobj doesn't flush
#135737
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
freakboy3742
added
docs
Comment on lines
1
to
2
| The documentation for :func:`shutil.copyfileobj` now warns the user of the | ||
| need to close or flush the destination stream on completion. |
There was a problem hiding this comment.
The Documentation blurb section is usually used for meta changes, e.g. tags or theme, and not entries about changes in the docs?
There was a problem hiding this comment.
I don't think that a NEWS entry is needed.
hoodmane
reviewed
Jun 20, 2025
|
Thanks @freakboy3742! |
|
Thanks @freakboy3742 for the PR 🌮🎉.. I'm working now to backport this PR to: 3.14. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jun 24, 2025
…thonGH-135737) Adds a note about flush/close on copyfileobj, and updates the Emscripten build script to follow documented advice. (cherry picked from commit 34393cbdd46fd965de86f1e7bc89ab111f506723) Co-authored-by: Russell Keith-Magee <russell@keith-magee.com>
|
GH-135873 is a backport of this pull request to the 3.14 branch. |
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.
Document that
shutil.copyfileobj()doesn't flush the destination stream on completion, so file content may not be reliably available.Modifies the Emscripten build script to avoid the problem that the documentation is warning about.
shutil.copyfileobj()doesn't flush at end of copy #135648📚 Documentation preview 📚: https://cpython-previews--135737.org.readthedocs.build/