Skip to content

bpo-29914: Fix default implementations of __reduce__ and __reduce_ex__. #843

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
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
15 changes: 14 additions & 1 deletion Lib/test/test_descr.py
Original file line number Diff line number Diff line change
Expand Up @@ -5236,7 +5236,20 @@ def __getattr__(self, attr):

import copyreg
expected = (copyreg.__newobj__, (A,), (None, {'spam': 42}), None, None)
self.assertEqual(A().__reduce__(2), expected) # Shouldn't crash
self.assertEqual(A().__reduce_ex__(2), expected) # Shouldn't crash

def test_object_reduce(self):
# Issue #29914
# __reduce__() takes no arguments
object().__reduce__()
with self.assertRaises(TypeError):
object().__reduce__(0)
# __reduce_ex__() takes one integer argument
object().__reduce_ex__(0)
with self.assertRaises(TypeError):
object().__reduce_ex__()
with self.assertRaises(TypeError):
object().__reduce_ex__(None)


class SharedKeyTests(unittest.TestCase):
Expand Down
4 changes: 4 additions & 0 deletions Misc/NEWS
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ What's New in Python 3.7.0 alpha 1?
Core and Builtins
-----------------

- bpo-29914: Fixed default implementations of __reduce__ and __reduce_ex__().
object.__reduce__() no longer takes arguments, object.__reduce_ex__() now
requires one argument.

- bpo-29949: Fix memory usage regression of set and frozenset object.

- bpo-29935: Fixed error messages in the index() method of tuple, list and deque
Expand Down
41 changes: 11 additions & 30 deletions Objects/clinic/typeobject.c.h
Original file line number Diff line number Diff line change
Expand Up @@ -131,61 +131,42 @@ type___sizeof__(PyTypeObject *self, PyObject *Py_UNUSED(ignored))
}

PyDoc_STRVAR(object___reduce____doc__,
"__reduce__($self, protocol=0, /)\n"
"__reduce__($self, /)\n"
"--\n"
"\n"
"Helper for pickle.");

#define OBJECT___REDUCE___METHODDEF \
{"__reduce__", (PyCFunction)object___reduce__, METH_FASTCALL, object___reduce____doc__},
{"__reduce__", (PyCFunction)object___reduce__, METH_NOARGS, object___reduce____doc__},

static PyObject *
object___reduce___impl(PyObject *self, int protocol);
object___reduce___impl(PyObject *self);

static PyObject *
object___reduce__(PyObject *self, PyObject **args, Py_ssize_t nargs, PyObject *kwnames)
object___reduce__(PyObject *self, PyObject *Py_UNUSED(ignored))
{
PyObject *return_value = NULL;
int protocol = 0;

if (!_PyArg_ParseStack(args, nargs, "|i:__reduce__",
&protocol)) {
goto exit;
}

if (!_PyArg_NoStackKeywords("__reduce__", kwnames)) {
goto exit;
}
return_value = object___reduce___impl(self, protocol);

exit:
return return_value;
return object___reduce___impl(self);
}

PyDoc_STRVAR(object___reduce_ex____doc__,
"__reduce_ex__($self, protocol=0, /)\n"
"__reduce_ex__($self, protocol, /)\n"
"--\n"
"\n"
"Helper for pickle.");

#define OBJECT___REDUCE_EX___METHODDEF \
{"__reduce_ex__", (PyCFunction)object___reduce_ex__, METH_FASTCALL, object___reduce_ex____doc__},
{"__reduce_ex__", (PyCFunction)object___reduce_ex__, METH_O, object___reduce_ex____doc__},

static PyObject *
object___reduce_ex___impl(PyObject *self, int protocol);

static PyObject *
object___reduce_ex__(PyObject *self, PyObject **args, Py_ssize_t nargs, PyObject *kwnames)
object___reduce_ex__(PyObject *self, PyObject *arg)
{
PyObject *return_value = NULL;
int protocol = 0;

if (!_PyArg_ParseStack(args, nargs, "|i:__reduce_ex__",
&protocol)) {
goto exit;
}
int protocol;

if (!_PyArg_NoStackKeywords("__reduce_ex__", kwnames)) {
if (!PyArg_Parse(arg, "i:__reduce_ex__", &protocol)) {
goto exit;
}
return_value = object___reduce_ex___impl(self, protocol);
Expand Down Expand Up @@ -256,4 +237,4 @@ object___dir__(PyObject *self, PyObject *Py_UNUSED(ignored))
{
return object___dir___impl(self);
}
/*[clinic end generated code: output=ce354e436e2360a0 input=a9049054013a1b77]*/
/*[clinic end generated code: output=8c4c856859564eaa input=a9049054013a1b77]*/
13 changes: 5 additions & 8 deletions Objects/typeobject.c
Original file line number Diff line number Diff line change
Expand Up @@ -4393,31 +4393,28 @@ _common_reduce(PyObject *self, int proto)
/*[clinic input]
object.__reduce__

protocol: int = 0
/

Helper for pickle.
[clinic start generated code]*/

static PyObject *
object___reduce___impl(PyObject *self, int protocol)
/*[clinic end generated code: output=5572e699c467dd5b input=227f37ed68bd938a]*/
object___reduce___impl(PyObject *self)
/*[clinic end generated code: output=d4ca691f891c6e2f input=11562e663947e18b]*/
{
return _common_reduce(self, protocol);
return _common_reduce(self, 0);
}

/*[clinic input]
object.__reduce_ex__

protocol: int = 0
protocol: int
/

Helper for pickle.
[clinic start generated code]*/

static PyObject *
object___reduce_ex___impl(PyObject *self, int protocol)
/*[clinic end generated code: output=2e157766f6b50094 input=8dd6a9602a12749e]*/
/*[clinic end generated code: output=2e157766f6b50094 input=f326b43fb8a4c5ff]*/
{
static PyObject *objreduce;
PyObject *reduce, *res;
Expand Down