]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
[3.7] bpo-40895: Update weakref documentation to remove old warnings (GH-20687) ...
authorAntoine Pitrou <antoine@python.org>
Wed, 10 Jun 2020 20:37:21 +0000 (22:37 +0200)
committerGitHub <noreply@github.com>
Wed, 10 Jun 2020 20:37:21 +0000 (13:37 -0700)
commit049039832da3d02592d680cebf71ab8a665a6564
treef766b7c8910179b68f139abd12f358f1f489c71a
parent4b378acb97a575892c0e372a6bb0c17da1ccdf3e
[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:
https://github.com/python/cpython/commit/c1baa601e2b558deb690edfdf334fceee3b03327GH-commitcomment-39514438.
(cherry picked from commit 1642c0ef750f96664a98cadb09301d492098d2fb)

Co-authored-by: Daniel Fortunov <asqui@users.noreply.github.com>
Automerge-Triggered-By: @pitrou
Doc/library/weakref.rst