Indicate that Shelve.sync() is not thread-safe.

python · Dec 2, 2024 · 85bf7c3 · 85bf7c3
1 parent bf21e21
commit 85bf7c3
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/Doc/library/shelve.rst b/Doc/library/shelve.rst
@@ -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