summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDima Tisnek <dimaqq@gmail.com>2019-11-03 11:55:33 (GMT)
committerTal Einat <taleinat+github@gmail.com>2019-11-03 11:55:33 (GMT)
commitd0e0f5bf0c07ca025f54df21fd1df55ee430d9fc (patch)
tree58872f6a2df1125a2c5ef23485aa994625d90cff
parent99b7701978d1fdc81e10c31d1ad8cce2c0c2d848 (diff)
downloadcpython-d0e0f5bf0c07ca025f54df21fd1df55ee430d9fc.zip
cpython-d0e0f5bf0c07ca025f54df21fd1df55ee430d9fc.tar.gz
cpython-d0e0f5bf0c07ca025f54df21fd1df55ee430d9fc.tar.bz2
bpo-38388: Document pickle protocol version 5 (GH-16639)
-rw-r--r--Doc/library/pickle.rst6
1 files changed, 5 insertions, 1 deletions
diff --git a/Doc/library/pickle.rst b/Doc/library/pickle.rst
index eb58178..779b60e 100644
--- a/Doc/library/pickle.rst
+++ b/Doc/library/pickle.rst
@@ -136,7 +136,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.
@@ -160,6 +160,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