summaryrefslogtreecommitdiffstats
path: root/Doc/libpickle.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1998-04-11 20:05:43 (GMT)
committerFred Drake <fdrake@acm.org>1998-04-11 20:05:43 (GMT)
commit9463de209293ebaec89f9a1fadde4bd036580d73 (patch)
treee91104f739e5c7a67468f9bcb1c3c24fcb7a6862 /Doc/libpickle.tex
parent10032ebb48b4e9b8b2eb7c378d3a579da36204d6 (diff)
downloadcpython-9463de209293ebaec89f9a1fadde4bd036580d73.zip
cpython-9463de209293ebaec89f9a1fadde4bd036580d73.tar.gz
cpython-9463de209293ebaec89f9a1fadde4bd036580d73.tar.bz2
Document cPickle and cStringIO.
Diffstat (limited to 'Doc/libpickle.tex')
-rw-r--r--Doc/libpickle.tex18
1 files changed, 18 insertions, 0 deletions
diff --git a/Doc/libpickle.tex b/Doc/libpickle.tex
index 038b763..65075b9 100644
--- a/Doc/libpickle.tex
+++ b/Doc/libpickle.tex
@@ -270,3 +270,21 @@ registration}
\seemodule{shelve}{indexed databases of objects; uses \module{pickle}}
\end{seealso}
+
+
+\section{Built-in Module \module{cPickle}}
+\bimodindex{cPickle}
+\label{module-cPickle}
+
+% This section was written by Fred L. Drake, Jr. <fdrake@acm.org>
+
+The \module{cPickle} module provides a similar interface and identical
+functionality as the \module{pickle} module, but can be up to 1000
+times faster since it is implemented in \C{}. The only other
+important difference to note is that \function{Pickler()} and
+\function{Unpickler()} are functions and not classes, and so cannot be
+subclassed. This should not be an issue in most cases.
+
+The format of the pickle data is identical to that produced using the
+\module{pickle} module, so it is possible to use \module{pickle} and
+\module{cPickle} interchangably with existing pickles.