summaryrefslogtreecommitdiff
path: root/sys/src/cmd/python/Doc/lib/libcopyreg.tex
diff options
context:
space:
mode:
authorcinap_lenrek <cinap_lenrek@localhost>2011-05-03 11:25:13 +0000
committercinap_lenrek <cinap_lenrek@localhost>2011-05-03 11:25:13 +0000
commit458120dd40db6b4df55a4e96b650e16798ef06a0 (patch)
tree8f82685be24fef97e715c6f5ca4c68d34d5074ee /sys/src/cmd/python/Doc/lib/libcopyreg.tex
parent3a742c699f6806c1145aea5149bf15de15a0afd7 (diff)
add hg and python
Diffstat (limited to 'sys/src/cmd/python/Doc/lib/libcopyreg.tex')
-rw-r--r--sys/src/cmd/python/Doc/lib/libcopyreg.tex40
1 files changed, 40 insertions, 0 deletions
diff --git a/sys/src/cmd/python/Doc/lib/libcopyreg.tex b/sys/src/cmd/python/Doc/lib/libcopyreg.tex
new file mode 100644
index 000000000..594978cdf
--- /dev/null
+++ b/sys/src/cmd/python/Doc/lib/libcopyreg.tex
@@ -0,0 +1,40 @@
+\section{\module{copy_reg} ---
+ Register \module{pickle} support functions}
+
+\declaremodule[copyreg]{standard}{copy_reg}
+\modulesynopsis{Register \module{pickle} support functions.}
+
+
+The \module{copy_reg} module provides support for the
+\refmodule{pickle}\refstmodindex{pickle}\ and
+\refmodule{cPickle}\refbimodindex{cPickle}\ modules. The
+\refmodule{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.
+
+
+\begin{funcdesc}{constructor}{object}
+ Declares \var{object} to be a valid constructor. If \var{object} is
+ not callable (and hence not valid as a constructor), raises
+ \exception{TypeError}.
+\end{funcdesc}
+
+\begin{funcdesc}{pickle}{type, function\optional{, constructor}}
+ Declares that \var{function} should be used as a ``reduction''
+ function for objects of type \var{type}; \var{type} must not be a
+ ``classic'' class object. (Classic classes are handled differently;
+ see the documentation for the \refmodule{pickle} module for
+ details.) \var{function} should return either a string or a tuple
+ containing two or three elements.
+
+ 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. \exception{TypeError} will be raised if
+ \var{object} is a class or \var{constructor} is not callable.
+
+ See the \refmodule{pickle} module for more
+ details on the interface expected of \var{function} and
+ \var{constructor}.
+\end{funcdesc}