summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1998-01-21 04:58:10 (GMT)
committerFred Drake <fdrake@acm.org>1998-01-21 04:58:10 (GMT)
commit1abf0df5b42beeb56062d03abfacb528b1b5e23f (patch)
tree940d8a36b7f6d838cb0f568800752ff6cd8f693d
parentd1cc9c2b925971870bcba26543feca57d5846579 (diff)
downloadcpython-1abf0df5b42beeb56062d03abfacb528b1b5e23f.zip
cpython-1abf0df5b42beeb56062d03abfacb528b1b5e23f.tar.gz
cpython-1abf0df5b42beeb56062d03abfacb528b1b5e23f.tar.bz2
Simple documentation of the copy_reg module.
Guido, you should probably look at this. The pickle documentation is out of date; I don't see anything about the __reduce__() stuff or the __safe_for_unpickling__ attribute.
-rw-r--r--Doc/lib/libcopyreg.tex28
-rw-r--r--Doc/libcopyreg.tex28
2 files changed, 56 insertions, 0 deletions
diff --git a/Doc/lib/libcopyreg.tex b/Doc/lib/libcopyreg.tex
new file mode 100644
index 0000000..dffcf43
--- /dev/null
+++ b/Doc/lib/libcopyreg.tex
@@ -0,0 +1,28 @@
+\section{Standard Module \sectcode{copy_reg}}
+% Note that the label is a little off; the underscore causes LaTeX to
+% yell & scream.
+\label{module-copyreg}
+\stmodindex{copy_reg}
+
+The \code{copy_reg} module provides support for the
+\code{pickle}\refstmodindex{pickle} and
+\code{cPickle}\refbimodindex{cPickle} modules. The
+\code{copy}\refstmodindex{copy} module is likely to use this in the
+future as well. It provides configuration information about object
+constructors which are not classes. Such constructors may be factory
+functions or class instances.
+
+\renewcommand{\indexsubitem}{(in module copy_reg)}
+
+\begin{funcdesc}{constructor}{object}
+ Declares \var{object} to be a valid constructor.
+\end{funcdesc}
+
+\begin{funcdesc}{pickle}{type, function\optional{, constructor}}
+ Declares that \var{function} should be used as a ``reduction''
+ function for objects of type or class \var{type}. \var{function}
+ should return either a string or a tuple. The optional
+ \var{constructor} parameter, if provided, is a callable object which
+ can be used to reconstruct the object when called with the tuple of
+ arguments returned by \var{function} at pickling time.
+\end{funcdesc}
diff --git a/Doc/libcopyreg.tex b/Doc/libcopyreg.tex
new file mode 100644
index 0000000..dffcf43
--- /dev/null
+++ b/Doc/libcopyreg.tex
@@ -0,0 +1,28 @@
+\section{Standard Module \sectcode{copy_reg}}
+% Note that the label is a little off; the underscore causes LaTeX to
+% yell & scream.
+\label{module-copyreg}
+\stmodindex{copy_reg}
+
+The \code{copy_reg} module provides support for the
+\code{pickle}\refstmodindex{pickle} and
+\code{cPickle}\refbimodindex{cPickle} modules. The
+\code{copy}\refstmodindex{copy} module is likely to use this in the
+future as well. It provides configuration information about object
+constructors which are not classes. Such constructors may be factory
+functions or class instances.
+
+\renewcommand{\indexsubitem}{(in module copy_reg)}
+
+\begin{funcdesc}{constructor}{object}
+ Declares \var{object} to be a valid constructor.
+\end{funcdesc}
+
+\begin{funcdesc}{pickle}{type, function\optional{, constructor}}
+ Declares that \var{function} should be used as a ``reduction''
+ function for objects of type or class \var{type}. \var{function}
+ should return either a string or a tuple. The optional
+ \var{constructor} parameter, if provided, is a callable object which
+ can be used to reconstruct the object when called with the tuple of
+ arguments returned by \var{function} at pickling time.
+\end{funcdesc}