Skip to content

Commit 0490398

Browse files
authored
[3.7] bpo-40895: Update weakref documentation to remove old warnings (GH-20687) (GH-20793)
The doccumentation at https://docs.python.org/3.10/library/weakref.html cautions that the `WeakKeyDictionary` and `WeakValueDictionary` are susceptible to the problem of dictionary mutation during iteration. These notes present the user with a problem that has no easy solution. I dug into the implementation and found that fortunately, Antoine Pitrou already addressed this challenge (10 years ago!) by introducing an `_IterationGuard` context manager to the implementation, which delays mutation while an iteration is in progress. I asked for confirmation and @pitrou agreed that these notes could be removed: c1baa601e2b558deb690edfdf334fceee3b03327GH-commitcomment-39514438. (cherry picked from commit 1642c0e) Co-authored-by: Daniel Fortunov <[email protected]> Automerge-Triggered-By: @pitrou
1 parent 4b378ac commit 0490398

File tree

1 file changed

+0
-14
lines changed

1 file changed

+0
-14
lines changed

Doc/library/weakref.rst

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -159,13 +159,6 @@ Extension types can easily be made to support weak references; see
159159
application without adding attributes to those objects. This can be especially
160160
useful with objects that override attribute accesses.
161161

162-
.. note::
163-
164-
Caution: Because a :class:`WeakKeyDictionary` is built on top of a Python
165-
dictionary, it must not change size when iterating over it. This can be
166-
difficult to ensure for a :class:`WeakKeyDictionary` because actions
167-
performed by the program during iteration may cause items in the
168-
dictionary to vanish "by magic" (as a side effect of garbage collection).
169162

170163
:class:`WeakKeyDictionary` objects have an additional method that
171164
exposes the internal references directly. The references are not guaranteed to
@@ -185,13 +178,6 @@ than needed.
185178
Mapping class that references values weakly. Entries in the dictionary will be
186179
discarded when no strong reference to the value exists any more.
187180

188-
.. note::
189-
190-
Caution: Because a :class:`WeakValueDictionary` is built on top of a Python
191-
dictionary, it must not change size when iterating over it. This can be
192-
difficult to ensure for a :class:`WeakValueDictionary` because actions performed
193-
by the program during iteration may cause items in the dictionary to vanish "by
194-
magic" (as a side effect of garbage collection).
195181

196182
:class:`WeakValueDictionary` objects have an additional method that has the
197183
same issues as the :meth:`keyrefs` method of :class:`WeakKeyDictionary`

0 commit comments

Comments
 (0)