]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-38388: Document pickle protocol version 5 (GH-16639)
authorDima Tisnek <dimaqq@gmail.com>
Sun, 3 Nov 2019 11:55:33 +0000 (20:55 +0900)
committerTal Einat <taleinat+github@gmail.com>
Sun, 3 Nov 2019 11:55:33 +0000 (13:55 +0200)
Doc/library/pickle.rst

index eb58178e0e928b37158684af57c0a6675943ba39..779b60ed4da00e3831f80ab275a6dd0810878b29 100644 (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
 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