From e9cfcef71eec755ad38a0764336920ecebb76344 Mon Sep 17 00:00:00 2001 From: Fred Drake Date: Wed, 27 Nov 2002 05:26:46 +0000 Subject: [PATCH] Clarify the interpretation of the __getstate__() return value for new-style classes. Closes SF bug #637941. --- Doc/lib/libpickle.tex | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/Doc/lib/libpickle.tex b/Doc/lib/libpickle.tex index 959225db4c5..f72dcb0c4bd 100644 --- a/Doc/lib/libpickle.tex +++ b/Doc/lib/libpickle.tex @@ -412,13 +412,19 @@ Upon unpickling, if the class also defines the method \method{__setstate__()}, it is called with the unpickled state\footnote{These methods can also be used to implement copying class instances.}. If there is no \method{__setstate__()} method, the -pickled object must be a dictionary and its items are assigned to the +pickled state must be a dictionary and its items are assigned to the new instance's dictionary. If a class defines both \method{__getstate__()} and \method{__setstate__()}, the state object needn't be a dictionary and these methods can do what they -want\footnote{This protocol is also used by the shallow and deep +want.\footnote{This protocol is also used by the shallow and deep copying operations defined in the -\refmodule{copy} module.}. +\refmodule{copy} module.} + +\begin{notice}[warning] + For new-style classes, if \method{__getstate__()} returns a false + value, the \method{__setstate__()} method will not be called. +\end{notice} + \subsubsection{Pickling and unpickling extension types}