mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-26 18:29:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

Fix method name in documentation (__setstate__ --> __getstate__)

Browse source
This commit is contained in:
Eli Bendersky 2013-01-02 05:53:59 -08:00
parent ba1edf2f58
commit 78f3ce577f
1 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

9
Doc/library/pickle.rst
View file

@ -367,8 +367,9 @@ The following types can be pickled:
* classes that are defined at the top level of a module * classes that are defined at the top level of a module
* instances of such classes whose :attr:`__dict__` or :meth:`__setstate__` is * instances of such classes whose :attr:`__dict__` or the result of calling
picklable (see section :ref:`pickle-inst` for details) :meth:`__getstate__` is picklable (see section :ref:`pickle-inst` for
details).
Attempts to pickle unpicklable objects will raise the :exc:`PicklingError` Attempts to pickle unpicklable objects will raise the :exc:`PicklingError`
exception; when this happens, an unspecified number of bytes may have already exception; when this happens, an unspecified number of bytes may have already
@ -379,8 +380,8 @@ raised in this case. You can carefully raise this limit with
Note that functions (built-in and user-defined) are pickled by "fully qualified" Note that functions (built-in and user-defined) are pickled by "fully qualified"
name reference, not by value. This means that only the function name is name reference, not by value. This means that only the function name is
pickled, along with the name of the module the function is defined in. Neither the pickled, along with the name of the module the function is defined in. Neither
function's code, nor any of its function attributes are pickled. Thus the the function's code, nor any of its function attributes are pickled. Thus the
defining module must be importable in the unpickling environment, and the module defining module must be importable in the unpickling environment, and the module
must contain the named object, otherwise an exception will be raised. [#]_ must contain the named object, otherwise an exception will be raised. [#]_