Skip to content

gh-143928: Docs: remove outdated marshal recursion and object sharing claim #144225

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Sanjay-VK07 wants to merge 1 commit into from
+1 −11
Closed

gh-143928: Docs: remove outdated marshal recursion and object sharing claim #144225

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 1 addition & 11 deletions Doc/library/pickle.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,18 +56,8 @@

The :mod:`pickle` module differs from :mod:`marshal` in several significant ways:

* The :mod:`pickle` module keeps track of the objects it has already serialized,
* * The :mod:`pickle` module keeps track of the objects it has already serialized,
so that later references to the same object won't be serialized again.

Check warning on line 60 in Doc/library/pickle.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs 

Bullet list ends without a blank line; unexpected unindent. [docutils]
:mod:`marshal` doesn't do this.

This has implications both for recursive objects and object sharing. Recursive
objects are objects that contain references to themselves. These are not
handled by marshal, and in fact, attempting to marshal recursive objects will
crash your Python interpreter. Object sharing happens when there are multiple
references to the same object in different places in the object hierarchy being
serialized. :mod:`pickle` stores such objects only once, and ensures that all
other references point to the master copy. Shared objects remain shared, which
can be very important for mutable objects.

* :mod:`marshal` cannot be used to serialize user-defined classes and their
instances. :mod:`pickle` can save and restore class instances transparently,
Expand Down
Loading