gh-53189: Document peculiarities of InteractiveConsole in relation to pickle (GH-123069)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
This commit is contained in:
Serhiy Storchaka 2025-05-20 15:08:40 +03:00 committed by GitHub
parent 175ba3639f
commit a31bbc951a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -22,6 +22,12 @@ build applications which provide an interactive interpreter prompt.
it defaults to a newly created dictionary with key ``'__name__'`` set to
``'__console__'`` and key ``'__doc__'`` set to ``None``.
Note that functions and classes objects created under an
:class:`!InteractiveInterpreter` instance will belong to the namespace
specified by *locals*.
They are only pickleable if *locals* is the namespace of an existing
module.
.. class:: InteractiveConsole(locals=None, filename="<console>", local_exit=False)