Skip to content
Snippets Groups Projects
Unverified Commit 54b5e4da authored by Miss Islington (bot)'s avatar Miss Islington (bot) Committed by GitHub
Browse files

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



Fixes GH-91362
(cherry picked from commit f9d6c599)

Co-authored-by: default avatarShantanu <12621235+hauntsaninja@users.noreply.github.com>
parent 3c2a1e7f
Branches
Tags
No related merge requests found
......@@ -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 :attr:`~object.__dict__` or the result of
calling :meth:`__getstate__` is picklable (see section :ref:`pickle-inst` for
......@@ -518,9 +518,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. [#]_
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment