diff options
author | Barry Warsaw <barry@python.org> | 2001-11-15 23:37:26 (GMT) |
---|---|---|
committer | Barry Warsaw <barry@python.org> | 2001-11-15 23:37:26 (GMT) |
commit | d44e7ad7029752720f1bdef7de7779394be98956 (patch) | |
tree | 4db14ae91a362922270061ed717b86d77f3b165c /Doc/lib/libcopyreg.tex | |
parent | fd4f069b123f627844d452ac4993f489a7a7c576 (diff) | |
download | cpython-d44e7ad7029752720f1bdef7de7779394be98956.zip cpython-d44e7ad7029752720f1bdef7de7779394be98956.tar.gz cpython-d44e7ad7029752720f1bdef7de7779394be98956.tar.bz2 |
Minor updates to add more pointers to the pickle documentation, and to
clarify some of the interface.
Diffstat (limited to 'Doc/lib/libcopyreg.tex')
-rw-r--r-- | Doc/lib/libcopyreg.tex | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/Doc/lib/libcopyreg.tex b/Doc/lib/libcopyreg.tex index bdeca88..25cc505 100644 --- a/Doc/lib/libcopyreg.tex +++ b/Doc/lib/libcopyreg.tex @@ -24,9 +24,15 @@ functions or class instances. Declares that \var{function} should be used as a ``reduction'' function for objects of type \var{type}; \var{type} should not a class object. \var{function} should return either a string or a - tuple. The optional \var{constructor} parameter, if provided, is 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} |