Skip to content

gh-79805: Indicate that Shelve.sync() is not thread-safe #127507

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+7 −1
Open

gh-79805: Indicate that Shelve.sync() is not thread-safe #127507

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
85bf7c3
Indicate that `Shelve.sync()` is not thread-safe.
picnixz Dec 2, 2024
9a352ae
Merge branch 'main' into doc/shelve/sync-thread-unsafe-79805
furkanonder Aug 19, 2025
4d9f843
amend merge commit
picnixz Aug 24, 2025
a99d745
refine warning
picnixz Aug 24, 2025
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
7 changes: 7 additions & 0 deletions Doc/library/shelve.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,13 @@ Two additional methods are supported:
dictionary on disk, if feasible. This is called automatically when the shelf
is closed with :meth:`close`.

.. warning::

During the call to :meth:`!sync`, the *writeback* attribute is set to
:const:`False` and other threads will stop updating the cache. As such,
this method is **not** thread-safe.


.. method:: Shelf.close()

Synchronize and close the persistent *dict* object. Operations on a closed
Expand Down
Loading