GeezerVison is showing github.com — gh-161803: Document that pickle's file.write() receives bytes-like objects by eachimei · Pull Request #161804 · python/cpython
Conversation
eachimei
commented
Nov 11, 2026
•
edited
Loading
Uh oh!
There was an error while loading. Please reload this page.
The Pickler file contract says write() "accepts a single bytes argument". With protocols 4 and 5 that is inaccurate: both the C and the pure-Python picklers can pass bytearray, memoryview or PickleBuffer objects, and custom file objects that call len(data) then fail. See gh-161803; gh-88605 is the same problem in bz2/lzma.
This PR:
- changes the wording to "bytes-like object" in
Doc/library/pickle.rst, Lib/pickle.py and the two Modules/_pickle.c docstrings, and regenerates the clinic output;
- adds a short note recommending
memoryview(data).nbytes for byte counts.
Docs only; no behaviour change.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
…ike objects
The Pickler file contract said write() accepts a single bytes argument,
but with protocols 4 and 5 both picklers may pass bytearray, memoryview
or PickleBuffer objects.
Co-authored-by: Copilot <[email protected]>
|
All commit authors signed the Contributor License Agreement.

|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.
If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Assignees
No one assigned
Milestone
No milestone
Development
Successfully merging this pull request may close these issues.
Uh oh!
There was an error while loading. Please reload this page.
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.