Skip to content

Commit 1642c0e

Browse files
authored
bpo-40895: Update weakref documentation to remove old warnings (GH-20687)
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: c1baa60#commitcomment-39514438
1 parent 1bcc32f commit 1642c0e

File tree

1 file changed

+0
-16
lines changed

1 file changed

+0
-16
lines changed

Doc/library/weakref.rst

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

166-
.. note::
167-
168-
Caution: Because a :class:`WeakKeyDictionary` is built on top of a Python
169-
dictionary, it must not change size when iterating over it. This can be
170-
difficult to ensure for a :class:`WeakKeyDictionary` because actions
171-
performed by the program during iteration may cause items in the
172-
dictionary to vanish "by magic" (as a side effect of garbage collection).
173-
174166
.. versionchanged:: 3.9
175167
Added support for ``|`` and ``|=`` operators, specified in :pep:`584`.
176168

@@ -192,14 +184,6 @@ than needed.
192184
Mapping class that references values weakly. Entries in the dictionary will be
193185
discarded when no strong reference to the value exists any more.
194186

195-
.. note::
196-
197-
Caution: Because a :class:`WeakValueDictionary` is built on top of a Python
198-
dictionary, it must not change size when iterating over it. This can be
199-
difficult to ensure for a :class:`WeakValueDictionary` because actions performed
200-
by the program during iteration may cause items in the dictionary to vanish "by
201-
magic" (as a side effect of garbage collection).
202-
203187
.. versionchanged:: 3.9
204188
Added support for ``|`` and ``|=`` operators, as specified in :pep:`584`.
205189

0 commit comments

Comments
 (0)