summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGuido van Rossum <guido@python.org>1998-06-30 16:54:33 (GMT)
committerGuido van Rossum <guido@python.org>1998-06-30 16:54:33 (GMT)
commitcf51dacfb8e7ad9739af6f9af045cc9b31c9b504 (patch)
tree6656d0dab96d2f3dffabd0370a4e356c55789de0
parent5b68362a3a069416f7cb6622a140ece8fd035b67 (diff)
downloadcpython-cf51dacfb8e7ad9739af6f9af045cc9b31c9b504.zip
cpython-cf51dacfb8e7ad9739af6f9af045cc9b31c9b504.tar.gz
cpython-cf51dacfb8e7ad9739af6f9af045cc9b31c9b504.tar.bz2
Document __copy__() and __deepcopy__() methods.
-rw-r--r--Doc/lib/libcopy.tex15
1 files changed, 14 insertions, 1 deletions
diff --git a/Doc/lib/libcopy.tex b/Doc/lib/libcopy.tex
index 4e43585..c106eca 100644
--- a/Doc/lib/libcopy.tex
+++ b/Doc/lib/libcopy.tex
@@ -57,7 +57,7 @@ Python's \code{deepcopy()} operation avoids these problems by:
\begin{itemize}
\item
-keeping a table of objects already copied during the current
+keeping a ``memo'' dictionary of objects already copied during the current
copying pass; and
\item
@@ -75,8 +75,21 @@ to control pickling: they can define methods called
\code{__getinitargs__()}, \code{__getstate__()} and
\code{__setstate__()}. See the description of module \code{pickle}
for information on these methods.
+The copy module does not use the \module{copy_reg} registration
+module.
\refstmodindex{pickle}
\setindexsubitem{(copy protocol)}
\ttindex{__getinitargs__}
\ttindex{__getstate__}
\ttindex{__setstate__}
+
+In order for a class to define its own copy implementation, it can
+define special methods \method{__copy__()}\ttindex{__copy__} and
+\method{__deepcopy__()}\ttindex{__deepcopy__}. The former is called to
+implement the shallow copy operation; no additional arguments are
+passed. The latter is called to implement the deep copy operation; it
+is passed one argument, the memo dictionary. If the
+\method{__deepcopy__()} implementation needs to make a deep copy of a
+component, it should call the \function{deepcopy()} function with the
+component as first argument and the memo dictionary as second
+argument.