mirrors
/
cpython
mirror of https://github.com/python/cpython.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

bpo-38388: Document pickle protocol version 5 (GH-16639)

This commit is contained in:
Dima Tisnek 2019-11-03 20:55:33 +09:00 committed by Tal Einat
parent 99b7701978
commit d0e0f5bf0c
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Doc/library/pickle.rst
View File

@ -136,7 +136,7 @@ The module :mod:`pickletools` contains tools for analyzing data streams
generated by :mod:`pickle`. :mod:`pickletools` source code has extensive generated by :mod:`pickle`. :mod:`pickletools` source code has extensive
comments about opcodes used by pickle protocols. 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 The higher the protocol used, the more recent the version of Python needed
to read the pickle produced. to read the pickle produced.
@ -160,6 +160,10 @@ to read the pickle produced.
Refer to :pep:`3154` for information about improvements brought by Refer to :pep:`3154` for information about improvements brought by
protocol 4. 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:: .. note::
Serialization is a more primitive notion than persistence; although Serialization is a more primitive notion than persistence; although
:mod:`pickle` reads and writes file objects, it does not handle the issue of :mod:`pickle` reads and writes file objects, it does not handle the issue of