[Python-checkins] bpo-38388: Document pickle protocol version 5 (GH-16639)

Miss Skeleton (bot) webhook-mailer at python.org
Sun Nov 3 07:03:23 EST 2019


https://github.com/python/cpython/commit/87af51847b2fc911f2c1e82be58a7aa3bb5bd2ca
commit: 87af51847b2fc911f2c1e82be58a7aa3bb5bd2ca
branch: 3.8
author: Miss Skeleton (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2019-11-03T04:03:16-08:00
summary:

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

(cherry picked from commit d0e0f5bf0c07ca025f54df21fd1df55ee430d9fc)

Co-authored-by: Dima Tisnek <dimaqq at gmail.com>

files:
M Doc/library/pickle.rst

diff --git a/Doc/library/pickle.rst b/Doc/library/pickle.rst
index eb58178e0e928..779b60ed4da00 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



More information about the Python-checkins mailing list