1998-08-10 19:42:37 +00:00
|
|
|
\section{\module{copy_reg} ---
|
1999-04-22 21:23:22 +00:00
|
|
|
Register \module{pickle} support functions}
|
1998-01-21 04:58:10 +00:00
|
|
|
|
1999-04-22 21:23:22 +00:00
|
|
|
\declaremodule[copyreg]{standard}{copy_reg}
|
1998-07-23 17:59:49 +00:00
|
|
|
\modulesynopsis{Register \module{pickle} support functions.}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The \module{copy_reg} module provides support for the
|
1999-04-22 21:23:22 +00:00
|
|
|
\refmodule{pickle}\refstmodindex{pickle} and
|
|
|
|
|
\refmodule{cPickle}\refbimodindex{cPickle} modules. The
|
|
|
|
|
\refmodule{copy}\refstmodindex{copy} module is likely to use this in the
|
1998-01-21 04:58:10 +00:00
|
|
|
future as well. It provides configuration information about object
|
|
|
|
|
constructors which are not classes. Such constructors may be factory
|
|
|
|
|
functions or class instances.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
\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}
|
