Skip to content

bpo-41052: Fix pickling heap types implemented in C with protocols 0 and 1 #22870

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.

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

Merged
merged 1 commit into from
Oct 24, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions Lib/copyreg.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ def _reconstructor(cls, base, state):
return obj

_HEAPTYPE = 1<<9
_new_type = type(int.__new__)

# Python code for object.__reduce_ex__ for protocols 0 and 1

Expand All @@ -57,6 +58,9 @@ def _reduce_ex(self, proto):
for base in cls.__mro__:
if hasattr(base, '__flags__') and not base.__flags__ & _HEAPTYPE:
break
new = base.__new__
if isinstance(new, _new_type) and new.__self__ is base:
break
else:
base = object # not really reachable
if base is object:
Expand Down
18 changes: 18 additions & 0 deletions Lib/test/pickletester.py
Original file line number Diff line number Diff line change
Expand Up @@ -1969,6 +1969,17 @@ def test_newobj_proxies(self):
self.assertEqual(B(x), B(y), detail)
self.assertEqual(x.__dict__, y.__dict__, detail)

def test_newobj_overridden_new(self):
# Test that Python class with C implemented __new__ is pickleable
for proto in protocols:
x = MyIntWithNew2(1)
x.foo = 42
s = self.dumps(x, proto)
y = self.loads(s)
self.assertIs(type(y), MyIntWithNew2)
self.assertEqual(int(y), 1)
self.assertEqual(y.foo, 42)

def test_newobj_not_class(self):
# Issue 24552
global SimpleNewObj
Expand Down Expand Up @@ -3089,6 +3100,13 @@ class MyFrozenSet(frozenset):
MyStr, MyUnicode,
MyTuple, MyList, MyDict, MySet, MyFrozenSet]

class MyIntWithNew(int):
def __new__(cls, value):
raise AssertionError

class MyIntWithNew2(MyIntWithNew):
__new__ = int.__new__


class SlotList(MyList):
__slots__ = ["foo"]
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Pickling heap types implemented in C with protocols 0 and 1 raises now an
error instead of producing incorrect data.
32 changes: 0 additions & 32 deletions Modules/_bz2module.c
Original file line number Diff line number Diff line change
Expand Up @@ -272,21 +272,6 @@ _bz2_BZ2Compressor_flush_impl(BZ2Compressor *self)
return result;
}

/*[clinic input]
_bz2.BZ2Compressor.__reduce__

[clinic start generated code]*/

static PyObject *
_bz2_BZ2Compressor___reduce___impl(BZ2Compressor *self)
/*[clinic end generated code: output=d13db66ae043e141 input=e09bccef0e6731b2]*/
{
PyErr_Format(PyExc_TypeError,
"cannot pickle %s object",
Py_TYPE(self)->tp_name);
return NULL;
}

static void*
BZ2_Malloc(void* ctx, int items, int size)
{
Expand Down Expand Up @@ -399,7 +384,6 @@ BZ2Compressor_traverse(BZ2Compressor *self, visitproc visit, void *arg)
static PyMethodDef BZ2Compressor_methods[] = {
_BZ2_BZ2COMPRESSOR_COMPRESS_METHODDEF
_BZ2_BZ2COMPRESSOR_FLUSH_METHODDEF
_BZ2_BZ2COMPRESSOR___REDUCE___METHODDEF
{NULL}
};

Expand Down Expand Up @@ -642,21 +626,6 @@ _bz2_BZ2Decompressor_decompress_impl(BZ2Decompressor *self, Py_buffer *data,
return result;
}

/*[clinic input]
_bz2.BZ2Decompressor.__reduce__

[clinic start generated code]*/

static PyObject *
_bz2_BZ2Decompressor___reduce___impl(BZ2Decompressor *self)
/*[clinic end generated code: output=f6a40650813f482e input=8db9175a609fdd43]*/
{
PyErr_Format(PyExc_TypeError,
"cannot pickle %s object",
Py_TYPE(self)->tp_name);
return NULL;
}

/* Argument Clinic is not used since the Argument Clinic always want to
check the type which would be wrong here */
static int
Expand Down Expand Up @@ -746,7 +715,6 @@ BZ2Decompressor_traverse(BZ2Decompressor *self, visitproc visit, void *arg)

static PyMethodDef BZ2Decompressor_methods[] = {
_BZ2_BZ2DECOMPRESSOR_DECOMPRESS_METHODDEF
_BZ2_BZ2DECOMPRESSOR___REDUCE___METHODDEF
{NULL}
};

Expand Down
30 changes: 0 additions & 30 deletions Modules/_lzmamodule.c
Original file line number Diff line number Diff line change
Expand Up @@ -825,24 +825,9 @@ Compressor_dealloc(Compressor *self)
Py_DECREF(tp);
}

/*[clinic input]
_lzma.LZMACompressor.__reduce__
[clinic start generated code]*/

static PyObject *
_lzma_LZMACompressor___reduce___impl(Compressor *self)
/*[clinic end generated code: output=b49a0538d1cad752 input=6be52aba16b513c1]*/
{
PyErr_Format(PyExc_TypeError,
"cannot pickle %s object",
Py_TYPE(self)->tp_name);
return NULL;
}

static PyMethodDef Compressor_methods[] = {
_LZMA_LZMACOMPRESSOR_COMPRESS_METHODDEF
_LZMA_LZMACOMPRESSOR_FLUSH_METHODDEF
_LZMA_LZMACOMPRESSOR___REDUCE___METHODDEF
{NULL}
};

Expand Down Expand Up @@ -1309,23 +1294,8 @@ Decompressor_traverse(Decompressor *self, visitproc visit, void *arg)
return 0;
}

/*[clinic input]
_lzma.LZMADecompressor.__reduce__
[clinic start generated code]*/

static PyObject *
_lzma_LZMADecompressor___reduce___impl(Decompressor *self)
/*[clinic end generated code: output=2611fff0104a9c30 input=b9882e030aecd9a5]*/
{
PyErr_Format(PyExc_TypeError,
"cannot pickle %s object",
Py_TYPE(self)->tp_name);
return NULL;
}

static PyMethodDef Decompressor_methods[] = {
_LZMA_LZMADECOMPRESSOR_DECOMPRESS_METHODDEF
_LZMA_LZMADECOMPRESSOR___REDUCE___METHODDEF
{NULL}
};

Expand Down
17 changes: 0 additions & 17 deletions Modules/_randommodule.c
Original file line number Diff line number Diff line change
Expand Up @@ -536,29 +536,12 @@ random_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
}


/*[clinic input]

_random.Random.__reduce__

[clinic start generated code]*/

static PyObject *
_random_Random___reduce___impl(RandomObject *self)
/*[clinic end generated code: output=ddea0dcdb60ffd6d input=bd38ec35fd157e0f]*/
{
PyErr_Format(PyExc_TypeError,
"cannot pickle %s object",
Py_TYPE(self)->tp_name);
return NULL;
}

static PyMethodDef random_methods[] = {
_RANDOM_RANDOM_RANDOM_METHODDEF
_RANDOM_RANDOM_SEED_METHODDEF
_RANDOM_RANDOM_GETSTATE_METHODDEF
_RANDOM_RANDOM_SETSTATE_METHODDEF
_RANDOM_RANDOM_GETRANDBITS_METHODDEF
_RANDOM_RANDOM___REDUCE___METHODDEF
{NULL, NULL} /* sentinel */
};

Expand Down
36 changes: 1 addition & 35 deletions Modules/clinic/_bz2module.c.h

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

36 changes: 1 addition & 35 deletions Modules/clinic/_lzmamodule.c.h

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 1 addition & 18 deletions Modules/clinic/_randommodule.c.h

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.