Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2026-01-06 07:22:09 +00:00
Code Issues Projects Releases Packages Wiki Activity

gh-91362: reword pickle docs to account for nested classes (GH-92429)

Browse source 
Fixes GH-91362
(cherry picked from commit f9d6c59917)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
This commit is contained in:
Miss Islington (bot) 2022-05-21 08:08:59 -07:00 • committed by GitHub
parent 76b6ed17ea
commit 09c3dff3ba
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
Doc/library/pickle.rst
View file

@ -502,10 +502,10 @@ The following types can be pickled:
* tuples, lists, sets, and dictionaries containing only picklable objects;
* functions (built-in and user-defined) defined at the top level of a module
(using :keyword:`def`, not :keyword:`lambda`);
* functions (built-in and user-defined) accessible from the top level of a
module (using :keyword:`def`, not :keyword:`lambda`);
* classes defined at the top level of a module;
* classes accessible from the top level of a module;
* instances of such classes whose the result of calling :meth:`__getstate__`
is picklable (see section :ref:`pickle-inst` for details).
@ -517,9 +517,9 @@ structure may exceed the maximum recursion depth, a :exc:`RecursionError` will b
raised in this case. You can carefully raise this limit with
:func:`sys.setrecursionlimit`.
Note that functions (built-in and user-defined) are pickled by fully qualified
name, 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
Note that functions (built-in and user-defined) are pickled by fully
:term:`qualified name`, not by value. [#]_ This means that only the function name is
pickled, along with the name of the containing module and classes. Neither
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
must contain the named object, otherwise an exception will be raised. [#]_