]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
bpo-40895: Update weakref documentation to remove old warnings (GH-20687)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Wed, 10 Jun 2020 20:33:59 +0000 (13:33 -0700)
committerGitHub <noreply@github.com>
Wed, 10 Jun 2020 20:33:59 +0000 (13:33 -0700)
commit18e07ba931c68eb5ab5262d4e57fe58c302686de
tree8024070b583069950f3b6311ac248d250fddee30
parentaf6932575391bca10f4f2145b56e3edbe9765343
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:
https://github.com/python/cpython/commit/c1baa601e2b558deb690edfdf334fceee3b03327GH-commitcomment-39514438
(cherry picked from commit 1642c0ef750f96664a98cadb09301d492098d2fb)

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