Skip to content

Commit d0e0f5b

Browse files
dimaqqtaleinat
authored andcommitted
bpo-38388: Document pickle protocol version 5 (GH-16639)
1 parent 99b7701 commit d0e0f5b

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

Doc/library/pickle.rst

+5-1
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ The module :mod:`pickletools` contains tools for analyzing data streams
136136
generated by :mod:`pickle`. :mod:`pickletools` source code has extensive
137137
comments about opcodes used by pickle protocols.
138138

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

@@ -160,6 +160,10 @@ to read the pickle produced.
160160
Refer to :pep:`3154` for information about improvements brought by
161161
protocol 4.
162162

163+
* Protocol version 5 was added in Python 3.8. It adds support for out-of-band
164+
data and speedup for in-band data. Refer to :pep:`574` for information about
165+
improvements brought by protocol 5.
166+
163167
.. note::
164168
Serialization is a more primitive notion than persistence; although
165169
:mod:`pickle` reads and writes file objects, it does not handle the issue of

0 commit comments

Comments
 (0)