Skip to content

gh-74876: Fix copying and pickling weakref.WeakSet #93732

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+53 −2
Open

gh-74876: Fix copying and pickling weakref.WeakSet #93732

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e9b6872
gh-74876: Fix copying and pickling weakref.WeakSet
serhiy-storchaka Jun 11, 2022
c7dc51b
More compact state.
serhiy-storchaka Jun 26, 2022
0d6beb9
Merge branch 'main' into weakset-copy-pickle
serhiy-storchaka Jun 26, 2022
0232775
Merge branch 'main' into weakset-copy-pickle
iritkatriel Nov 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion Lib/_weakrefset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ def __exit__(self, e, t, b):


class WeakSet:
__slots__ = ('__dict__', '__weakref__', 'data',
'_remove', '_pending_removals', '_iterating')
def __init__(self, data=None):
self.data = set()
def _remove(item, selfref=ref(self)):
Expand Down Expand Up @@ -80,7 +82,11 @@ def __contains__(self, item):
return wr in self.data

def __reduce__(self):
return self.__class__, (list(self),), self.__getstate__()
dict, slots = self.__getstate__()
for name in WeakSet.__slots__:
slots.pop(name, None)
state = (dict, slots) if slots else (dict or None)
return self.__class__, (list(self),), state

def add(self, item):
if self._pending_removals:
Expand Down
46 changes: 45 additions & 1 deletion Lib/test/test_weakset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import unittest
from weakref import WeakSet
import copy
import pickle
import string
from collections import UserString as ustr
from collections.abc import Set, MutableSet
Expand Down Expand Up @@ -463,12 +464,16 @@ def test_copying(self):
dup = copy.copy(s)
self.assertIsInstance(dup, cls)
self.assertEqual(dup, s)
self.assertEqual(sorted(dup), sorted(s))
self.assertIsNot(dup, s)
self.assertIs(dup.x, s.x)
self.assertIs(dup.z, s.z)
self.assertFalse(hasattr(dup, 'y'))
dup.remove(self.items[0])
self.assertEqual(sorted(dup), sorted(self.items[1:]))
self.assertEqual(sorted(s), sorted(self.items))

dup = copy.deepcopy(s)
dup, dupitems = copy.deepcopy([s, self.items])
self.assertIsInstance(dup, cls)
self.assertEqual(dup, s)
self.assertIsNot(dup, s)
Expand All @@ -477,6 +482,45 @@ def test_copying(self):
self.assertEqual(dup.z, s.z)
self.assertIsNot(dup.z, s.z)
self.assertFalse(hasattr(dup, 'y'))
dup.remove(self.items[0])
self.assertEqual(sorted(dup), sorted(self.items[1:]))
self.assertEqual(sorted(s), sorted(self.items))
del dupitems
support.gc_collect() # For PyPy or other GCs.
self.assertEqual(list(dup), [])
self.assertEqual(sorted(s), sorted(self.items))

def test_copying_2(self):
for copyfunc in copy.copy, :#copy.deepcopy:
s = WeakSet()
dup = copyfunc(s)
x = ustr('x')
dup.add(x)
self.assertEqual(len(dup), 1)
self.assertEqual(len(s), 0)
del x
support.gc_collect() # For PyPy or other GCs.
self.assertEqual(len(dup), 0)

def test_pickle(self):
for cls in WeakSet, WeakSetWithSlots:
s = cls(self.items)
s.x = ['x']
s.z = ['z']
for proto in range(pickle.HIGHEST_PROTOCOL + 1):
with self.subTest(proto=proto, csl=cls):
pickled = pickle.dumps([s, self.items], protocol=proto)
dup, dupitems = pickle.loads(pickled)
self.assertIsInstance(dup, cls)
self.assertEqual(dup, s)
self.assertEqual(dup.x, s.x)
self.assertEqual(dup.z, s.z)
del dupitems[0]
support.gc_collect() # For PyPy or other GCs.
self.assertEqual(sorted(dup), sorted(self.items[1:]))
del dupitems
support.gc_collect() # For PyPy or other GCs.
self.assertEqual(list(dup), [])


if __name__ == "__main__":
Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Library/2022-06-11-20-02-38.gh-issue-74876.-t00bF.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix copying and pickling :class:`weakref.WeakSet`.
Loading