mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-02 03:01:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 15

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

Browse source 
opened in binary mode.
This commit is contained in:
Georg Brandl 2006-02-20 13:12:02 +00:00
parent 9b743f514c
commit 69774c212a
1 changed files with 10 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

11
Doc/lib/libpickle.tex
View file

@ -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