diff -r 89821243621b Doc/library/pickle.rst
--- a/Doc/library/pickle.rst Thu Jul 14 07:45:24 2016 +0300
+++ b/Doc/library/pickle.rst Thu Jul 14 14:35:06 2016 +0300
@@ -422,9 +422,8 @@ The following types can be pickled:
* classes that are defined at the top level of a module
-* instances of such classes whose :attr:`~object.__dict__` or the result of
- calling :meth:`__getstate__` is picklable (see section :ref:`pickle-inst` for
- details).
+* instances of such classes whose the result of calling :meth:`__getstate__`
+ is picklable (see section :ref:`pickle-inst` for details).
Attempts to pickle unpicklable objects will raise the :exc:`PicklingError`
exception; when this happens, an unspecified number of bytes may have already
@@ -524,11 +523,30 @@ methods:
.. method:: object.__getstate__()
- Classes can further influence how their instances are pickled; if the class
- defines the method :meth:`__getstate__`, it is called and the returned object
- is pickled as the contents for the instance, instead of the contents of the
- instance's dictionary. If the :meth:`__getstate__` method is absent, the
- instance's :attr:`~object.__dict__` is pickled as usual.
+ Classes can further influence how their instances are pickled by overriding
+ the method :meth:`__getstate__`. It is called and the returned object
+ is pickled as the contents for the instance, instead of a default state.
+ There are several cases:
+
+ * For a class that has no instance :attr:`~object.__dict__` and no
+ :attr:`~object.__slots__`, the default state is ``None``.
+
+ * For a class that has an instance :attr:`~object.__dict__` and no
+ :attr:`~object.__slots__`, the default state is ``self.__dict__``.
+
+ * For a class that has an instance :attr:`~object.__dict__` and
+ :attr:`~object.__slots__`, the default state is a tuple consisting of two
+ dictionaries: ``self.__dict__``, and a dictionary mapping slot
+ names to slot values. Only slots that have a value are
+ included in the latter.
+
+ * For a class that has :attr:`~object.__slots__` and no instance
+ :attr:`~object.__dict__`, the default state is a tuple whose first item
+ is ``None`` and whose second item is a dictionary mapping slot names
+ to slot values described in the previous bullet.
+
+ .. versionchanged:: 3.6
+ Provided the default implementation of :meth:`object.__getstate__`.
.. method:: object.__setstate__(state)
diff -r 89821243621b Include/object.h
--- a/Include/object.h Thu Jul 14 07:45:24 2016 +0300
+++ b/Include/object.h Thu Jul 14 14:35:06 2016 +0300
@@ -578,6 +578,11 @@ PyAPI_FUNC(PyObject *)
*/
PyAPI_FUNC(PyObject *) PyObject_Dir(PyObject *);
+/* Pickle support. */
+#ifndef Py_LIMITED_API
+PyAPI_FUNC(PyObject *) _PyObject_GetState(PyObject *);
+#endif
+
/* Helpers for printing recursive container types */
PyAPI_FUNC(int) Py_ReprEnter(PyObject *);
diff -r 89821243621b Lib/_weakrefset.py
--- a/Lib/_weakrefset.py Thu Jul 14 07:45:24 2016 +0300
+++ b/Lib/_weakrefset.py Thu Jul 14 14:35:06 2016 +0300
@@ -75,8 +75,7 @@ class WeakSet:
return wr in self.data
def __reduce__(self):
- return (self.__class__, (list(self),),
- getattr(self, '__dict__', None))
+ return self.__class__, (list(self),), self.__getstate__()
def add(self, item):
if self._pending_removals:
diff -r 89821243621b Lib/collections/__init__.py
--- a/Lib/collections/__init__.py Thu Jul 14 07:45:24 2016 +0300
+++ b/Lib/collections/__init__.py Thu Jul 14 14:35:06 2016 +0300
@@ -260,10 +260,22 @@ class OrderedDict(dict):
def __reduce__(self):
'Return state information for pickling'
- inst_dict = vars(self).copy()
- for k in vars(OrderedDict()):
- inst_dict.pop(k, None)
- return self.__class__, (), inst_dict or None, None, iter(self.items())
+ state = self.__getstate__()
+ if state:
+ if isinstance(state, tuple):
+ state, slots = state
+ else:
+ slots = {}
+ state = state.copy()
+ slots = slots.copy()
+ for k in vars(OrderedDict()):
+ state.pop(k, None)
+ slots.pop(k, None)
+ if slots:
+ state = state, slots
+ else:
+ state = state or None
+ return self.__class__, (), state, None, iter(self.items())
def copy(self):
'od.copy() -> a shallow copy of od'
diff -r 89821243621b Lib/datetime.py
--- a/Lib/datetime.py Thu Jul 14 07:45:24 2016 +0300
+++ b/Lib/datetime.py Thu Jul 14 14:35:06 2016 +0300
@@ -1005,15 +1005,7 @@ class tzinfo:
args = getinitargs()
else:
args = ()
- getstate = getattr(self, "__getstate__", None)
- if getstate:
- state = getstate()
- else:
- state = getattr(self, "__dict__", None) or None
- if state is None:
- return (self.__class__, args)
- else:
- return (self.__class__, args, state)
+ return (self.__class__, args, self.__getstate__())
_tzinfo_class = tzinfo
diff -r 89821243621b Lib/email/headerregistry.py
--- a/Lib/email/headerregistry.py Thu Jul 14 07:45:24 2016 +0300
+++ b/Lib/email/headerregistry.py Thu Jul 14 14:35:06 2016 +0300
@@ -223,7 +223,7 @@ class BaseHeader(str):
self.__class__.__bases__,
str(self),
),
- self.__dict__)
+ self.__getstate__())
@classmethod
def _reconstruct(cls, value):
diff -r 89821243621b Lib/test/datetimetester.py
--- a/Lib/test/datetimetester.py Thu Jul 14 07:45:24 2016 +0300
+++ b/Lib/test/datetimetester.py Thu Jul 14 14:35:06 2016 +0300
@@ -117,8 +117,8 @@ class PicklableFixedOffset(FixedOffset):
def __init__(self, offset=None, name=None, dstoffset=None):
FixedOffset.__init__(self, offset, name, dstoffset)
- def __getstate__(self):
- return self.__dict__
+class PicklableFixedOffsetWithSlots(PicklableFixedOffset):
+ __slots__ = '_FixedOffset__offset', '_FixedOffset__name', 'spam'
class _TZInfo(tzinfo):
def utcoffset(self, datetime_module):
@@ -180,6 +180,7 @@ class TestTZInfo(unittest.TestCase):
offset = timedelta(minutes=-300)
for otype, args in [
(PicklableFixedOffset, (offset, 'cookie')),
+ (PicklableFixedOffsetWithSlots, (offset, 'cookie')),
(timezone, (offset,)),
(timezone, (offset, "EST"))]:
orig = otype(*args)
@@ -195,6 +196,7 @@ class TestTZInfo(unittest.TestCase):
self.assertIs(type(derived), otype)
self.assertEqual(derived.utcoffset(None), offset)
self.assertEqual(derived.tzname(None), oname)
+ self.assertFalse(hasattr(derived, 'spam'))
def test_issue23600(self):
DSTDIFF = DSTOFFSET = timedelta(hours=1)
diff -r 89821243621b Lib/test/test_bytes.py
--- a/Lib/test/test_bytes.py Thu Jul 14 07:45:24 2016 +0300
+++ b/Lib/test/test_bytes.py Thu Jul 14 14:35:06 2016 +0300
@@ -1577,28 +1577,30 @@ class SubclassTest:
def test_pickle(self):
a = self.type2test(b"abcd")
a.x = 10
- a.y = self.type2test(b"efgh")
+ a.z = self.type2test(b"efgh")
for proto in range(pickle.HIGHEST_PROTOCOL + 1):
b = pickle.loads(pickle.dumps(a, proto))
self.assertNotEqual(id(a), id(b))
self.assertEqual(a, b)
self.assertEqual(a.x, b.x)
- self.assertEqual(a.y, b.y)
+ self.assertEqual(a.z, b.z)
self.assertEqual(type(a), type(b))
- self.assertEqual(type(a.y), type(b.y))
+ self.assertEqual(type(a.z), type(b.z))
+ self.assertFalse(hasattr(b, 'y'))
def test_copy(self):
a = self.type2test(b"abcd")
a.x = 10
- a.y = self.type2test(b"efgh")
+ a.z = self.type2test(b"efgh")
for copy_method in (copy.copy, copy.deepcopy):
b = copy_method(a)
self.assertNotEqual(id(a), id(b))
self.assertEqual(a, b)
self.assertEqual(a.x, b.x)
- self.assertEqual(a.y, b.y)
+ self.assertEqual(a.z, b.z)
self.assertEqual(type(a), type(b))
- self.assertEqual(type(a.y), type(b.y))
+ self.assertEqual(type(a.z), type(b.z))
+ self.assertFalse(hasattr(b, 'y'))
def test_fromhex(self):
b = self.type2test.fromhex('1a2B30')
@@ -1631,6 +1633,9 @@ class SubclassTest:
class ByteArraySubclass(bytearray):
pass
+class ByteArraySubclassWithSlots(bytearray):
+ __slots__ = ('x', 'z', '__dict__')
+
class BytesSubclass(bytes):
pass
@@ -1651,6 +1656,9 @@ class ByteArraySubclassTest(SubclassTest
x = subclass(newarg=4, source=b"abcd")
self.assertEqual(x, b"abcd")
+class ByteArraySubclassWithSlotsTest(SubclassTest, unittest.TestCase):
+ basetype = bytearray
+ type2test = ByteArraySubclassWithSlots
class BytesSubclassTest(SubclassTest, unittest.TestCase):
basetype = bytes
diff -r 89821243621b Lib/test/test_deque.py
--- a/Lib/test/test_deque.py Thu Jul 14 07:45:24 2016 +0300
+++ b/Lib/test/test_deque.py Thu Jul 14 14:35:06 2016 +0300
@@ -792,6 +792,9 @@ class TestVariousIteratorArgs(unittest.T
class Deque(deque):
pass
+class DequeWithSlots(deque):
+ __slots__ = ('x', 'y', '__dict__')
+
class DequeWithBadIter(deque):
def __iter__(self):
raise TypeError
@@ -821,40 +824,28 @@ class TestSubclass(unittest.TestCase):
self.assertEqual(len(d), 0)
def test_copy_pickle(self):
+ for cls in Deque, DequeWithSlots:
+ for d in cls('abc'), cls('abcde', maxlen=4):
+ d.x = ['x']
+ d.z = ['z']
- d = Deque('abc')
+ e = d.__copy__()
+ self.assertEqual(type(d), type(e))
+ self.assertEqual(list(d), list(e))
- e = d.__copy__()
- self.assertEqual(type(d), type(e))
- self.assertEqual(list(d), list(e))
+ e = cls(d)
+ self.assertEqual(type(d), type(e))
+ self.assertEqual(list(d), list(e))
- e = Deque(d)
- self.assertEqual(type(d), type(e))
- self.assertEqual(list(d), list(e))
-
- for proto in range(pickle.HIGHEST_PROTOCOL + 1):
- s = pickle.dumps(d, proto)
- e = pickle.loads(s)
- self.assertNotEqual(id(d), id(e))
- self.assertEqual(type(d), type(e))
- self.assertEqual(list(d), list(e))
-
- d = Deque('abcde', maxlen=4)
-
- e = d.__copy__()
- self.assertEqual(type(d), type(e))
- self.assertEqual(list(d), list(e))
-
- e = Deque(d)
- self.assertEqual(type(d), type(e))
- self.assertEqual(list(d), list(e))
-
- for proto in range(pickle.HIGHEST_PROTOCOL + 1):
- s = pickle.dumps(d, proto)
- e = pickle.loads(s)
- self.assertNotEqual(id(d), id(e))
- self.assertEqual(type(d), type(e))
- self.assertEqual(list(d), list(e))
+ for proto in range(pickle.HIGHEST_PROTOCOL + 1):
+ s = pickle.dumps(d, proto)
+ e = pickle.loads(s)
+ self.assertNotEqual(id(d), id(e))
+ self.assertEqual(type(d), type(e))
+ self.assertEqual(list(d), list(e))
+ self.assertEqual(e.x, d.x)
+ self.assertEqual(e.z, d.z)
+ self.assertFalse(hasattr(e, 'y'))
def test_pickle_recursive(self):
for proto in range(pickle.HIGHEST_PROTOCOL + 1):
diff -r 89821243621b Lib/test/test_ordered_dict.py
--- a/Lib/test/test_ordered_dict.py Thu Jul 14 07:45:24 2016 +0300
+++ b/Lib/test/test_ordered_dict.py Thu Jul 14 14:35:06 2016 +0300
@@ -262,6 +262,8 @@ class OrderedDictTests:
# and have a repr/eval round-trip
pairs = [('c', 1), ('b', 2), ('a', 3), ('d', 4), ('e', 5), ('f', 6)]
od = OrderedDict(pairs)
+ od.x = ['x']
+ od.z = ['z']
def check(dup):
msg = "\ncopy: %s\nod: %s" % (dup, od)
self.assertIsNot(dup, od, msg)
@@ -270,13 +272,27 @@ class OrderedDictTests:
self.assertEqual(len(dup), len(od))
self.assertEqual(type(dup), type(od))
check(od.copy())
- check(copy.copy(od))
- check(copy.deepcopy(od))
+ dup = copy.copy(od)
+ check(dup)
+ self.assertIs(dup.x, od.x)
+ self.assertIs(dup.z, od.z)
+ self.assertFalse(hasattr(dup, 'y'))
+ dup = copy.deepcopy(od)
+ check(dup)
+ self.assertEqual(dup.x, od.x)
+ self.assertIsNot(dup.x, od.x)
+ self.assertEqual(dup.z, od.z)
+ self.assertIsNot(dup.z, od.z)
+ self.assertFalse(hasattr(dup, 'y'))
# pickle directly pulls the module, so we have to fake it
with replaced_module('collections', self.module):
for proto in range(pickle.HIGHEST_PROTOCOL + 1):
with self.subTest(proto=proto):
- check(pickle.loads(pickle.dumps(od, proto)))
+ dup = pickle.loads(pickle.dumps(od, proto))
+ check(dup)
+ self.assertEqual(dup.x, od.x)
+ self.assertEqual(dup.z, od.z)
+ self.assertFalse(hasattr(dup, 'y'))
check(eval(repr(od)))
update_test = OrderedDict()
update_test.update(od)
@@ -690,6 +706,23 @@ class CPythonOrderedDictSubclassTests(CP
pass
+class PurePythonOrderedDictWithSlotsCopyingTests(unittest.TestCase):
+
+ module = py_coll
+ class OrderedDict(py_coll.OrderedDict):
+ __slots__ = ('x', 'y')
+ test_copying = OrderedDictTests.test_copying
+
+
+@unittest.skipUnless(c_coll, 'requires the C version of the collections module')
+class CPythonOrderedDictWithSlotsCopyingTests(unittest.TestCase):
+
+ module = c_coll
+ class OrderedDict(c_coll.OrderedDict):
+ __slots__ = ('x', 'y')
+ test_copying = OrderedDictTests.test_copying
+
+
class PurePythonGeneralMappingTests(mapping_tests.BasicTestMappingProtocol):
@classmethod
diff -r 89821243621b Lib/test/test_set.py
--- a/Lib/test/test_set.py Thu Jul 14 07:45:24 2016 +0300
+++ b/Lib/test/test_set.py Thu Jul 14 14:35:06 2016 +0300
@@ -227,14 +227,17 @@ class TestJointOps:
def test_pickling(self):
for i in range(pickle.HIGHEST_PROTOCOL + 1):
+ if type(self.s) not in (set, frozenset):
+ self.s.x = ['x']
+ self.s.z = ['z']
p = pickle.dumps(self.s, i)
dup = pickle.loads(p)
self.assertEqual(self.s, dup, "%s != %s" % (self.s, dup))
if type(self.s) not in (set, frozenset):
- self.s.x = 10
- p = pickle.dumps(self.s, i)
- dup = pickle.loads(p)
self.assertEqual(self.s.x, dup.x)
+ self.assertEqual(self.s.z, dup.z)
+ self.assertFalse(hasattr(self.s, 'y'))
+ del self.s.x, self.s.z
def test_iterator_pickling(self):
for proto in range(pickle.HIGHEST_PROTOCOL + 1):
@@ -769,6 +772,21 @@ class TestFrozenSetSubclass(TestFrozenSe
# All empty frozenset subclass instances should have different ids
self.assertEqual(len(set(map(id, efs))), len(efs))
+
+class SetSubclassWithSlots(set):
+ __slots__ = ('x', 'y', '__dict__')
+
+class TestSetSubclassWithSlots(unittest.TestCase):
+ thetype = SetSubclassWithSlots
+ setUp = TestJointOps.setUp
+ test_pickling = TestJointOps.test_pickling
+
+class FrozenSetSubclassWithSlots(frozenset):
+ __slots__ = ('x', 'y', '__dict__')
+
+class TestFrozenSetSubclassWithSlots(TestSetSubclassWithSlots):
+ thetype = FrozenSetSubclassWithSlots
+
# Tests taken from test_sets.py =============================================
empty_set = set()
diff -r 89821243621b Lib/test/test_weakset.py
--- a/Lib/test/test_weakset.py Thu Jul 14 07:45:24 2016 +0300
+++ b/Lib/test/test_weakset.py Thu Jul 14 14:35:06 2016 +0300
@@ -1,5 +1,6 @@
import unittest
from weakref import WeakSet
+import copy
import string
from collections import UserString as ustr
import gc
@@ -13,6 +14,12 @@ class RefCycle:
def __init__(self):
self.cycle = self
+class WeakSetSubclass(WeakSet):
+ pass
+
+class WeakSetWithSlots(WeakSet):
+ __slots__ = ('x', 'y')
+
class TestWeakSet(unittest.TestCase):
@@ -434,6 +441,30 @@ class TestWeakSet(unittest.TestCase):
self.assertGreaterEqual(n2, 0)
self.assertLessEqual(n2, n1)
+ def test_copying(self):
+ for cls in WeakSet, WeakSetWithSlots:
+ s = cls(self.items)
+ s.x = ['x']
+ s.z = ['z']
+
+ dup = copy.copy(s)
+ self.assertIsInstance(dup, cls)
+ self.assertEqual(dup, s)
+ self.assertIsNot(dup, s)
+ self.assertIs(dup.x, s.x)
+ self.assertIs(dup.z, s.z)
+ self.assertFalse(hasattr(dup, 'y'))
+
+ dup = copy.deepcopy(s)
+ self.assertIsInstance(dup, cls)
+ self.assertEqual(dup, s)
+ self.assertIsNot(dup, s)
+ self.assertEqual(dup.x, s.x)
+ self.assertIsNot(dup.x, s.x)
+ self.assertEqual(dup.z, s.z)
+ self.assertIsNot(dup.z, s.z)
+ self.assertFalse(hasattr(dup, 'y'))
+
if __name__ == "__main__":
unittest.main()
diff -r 89821243621b Lib/test/test_xml_etree.py
--- a/Lib/test/test_xml_etree.py Thu Jul 14 07:45:24 2016 +0300
+++ b/Lib/test/test_xml_etree.py Thu Jul 14 14:35:06 2016 +0300
@@ -1804,8 +1804,7 @@ class BasicElementTest(ElementTestCase,