Commit 69774c21 authored by Georg Brandl's avatar Georg Brandl

Bug #1102649: add a note to pickle docs that pickle files should be

opened in binary mode.
parent 9b743f51
......@@ -163,8 +163,17 @@ as a \var{protocol} value.
\versionadded{2.3}
\end{datadesc}
\note{Be sure to always open pickle files created with protocols >= 1 in
binary mode. For the old ASCII-based pickle protocol 0 you can use
either text mode or binary mode as long as you stay consistent.
A pickle file written with protocol 0 in binary mode will contain
lone linefeeds as line terminators and therefore will look ``funny''
when viewed in Notepad or other editors which do not support this
format.}
The \module{pickle} module provides the
following functions to make this process more convenient:
following functions to make the pickling process more convenient:
\begin{funcdesc}{dump}{obj, file\optional{, protocol}}
Write a pickled representation of \var{obj} to the open file object
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment