gh-129011: Update docs for Raw I/O read, readinto, and write#135328
Open
cmaloney wants to merge 2 commits into
Open
gh-129011: Update docs for Raw I/O read, readinto, and write#135328cmaloney wants to merge 2 commits into
cmaloney wants to merge 2 commits into
Conversation
Update `RawIOBase` and `FileIO` documentation to match implementation behavior around `.read`, `.readinto`, `.readall` and `.write`. In particular: - They may make more than one system call (PEP-475) - Add warnings if `.write()` requires a wrapping retry loop (see: pythongh-126606) - "Raw I/O" `.write`` may not write all bytes - `buffering=0` example results in a "Raw I/O"
bedevere-app
Bot
added
awaiting review
docs
|
This PR is stale because it has been open for 30 days with no activity. |
serhiy-storchaka
approved these changes
Jun 2, 2026
Member
serhiy-storchaka
left a comment
serhiy-storchaka
left a comment
There was a problem hiding this comment.
LGTM. 👍
@vstinner, could you please look at this as the author of retry-on-interrupt logic?
serhiy-storchaka
added
needs backport to 3.13
Documentation build overview
|
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
2 participants
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.
Update
RawIOBaseandFileIOdocumentation to match implementation behavior around.read,.readinto,.readalland.write..write()requires a wrapping retry loop (see: Corrupt .pyc files stay on disk after failed writes #126606).writemay not write all bytesbuffering=0example results in a "Raw I/O"see also: gh-80050 / GH-130653 (similar work on Buffered I/O read docs)
📚 Documentation preview 📚: https://cpython-previews--135328.org.readthedocs.build/