◐ Shell
clean mode source ↗

[3.8] bpo-40895: Update weakref documentation to remove old warnings (GH-20687) by pitrou · Pull Request #20792 · python/cpython

…ythonGH-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:
python@c1baa601e2b558deb690edfdf334fceee3b03327GH-commitcomment-39514438.
(cherry picked from commit 1642c0e)

Co-authored-by: Daniel Fortunov <asqui@users.noreply.github.com>

@pitrou pitrou deleted the backport-1642c0e-3.8 branch

June 10, 2020 20:38