Skip to content

bpo-38388 Document pickle protocol version 5 #16639

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 3, 2019
Merged

bpo-38388 Document pickle protocol version 5 #16639

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
faab9af
Document 📓 pickle 🥒 protocol 5 Ƽ
dimaqq Oct 8, 2019
d1ec025
Count up different protocols 😸
dimaqq Oct 12, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion Doc/library/pickle.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ The module :mod:`pickletools` contains tools for analyzing data streams
generated by :mod:`pickle`. :mod:`pickletools` source code has extensive
comments about opcodes used by pickle protocols.

There are currently 5 different protocols which can be used for pickling.
There are currently 6 different protocols which can be used for pickling.
The higher the protocol used, the more recent the version of Python needed
to read the pickle produced.

Expand All @@ -146,6 +146,10 @@ to read the pickle produced.
Refer to :pep:`3154` for information about improvements brought by
protocol 4.

* Protocol version 5 was added in Python 3.8. It adds support for out-of-band
data and speedup for in-band data. Refer to :pep:`574` for information about
improvements brought by protocol 5.

.. note::
Serialization is a more primitive notion than persistence; although
:mod:`pickle` reads and writes file objects, it does not handle the issue of
Expand Down