Pickling of objects of classes whose __new__ mandates the use of keyword-only arguments is supported with protocol 4 (using a new opcode NEWOBJ_EX). But it is possible to implement this feature with protocol 2+ (less efficiently than with NEWOBJ_EX). __new_ex__ is pickled as partial(cls.__new__, cls, *args, **kwargs). Pickled data is compatible with older Python releases up to 2.7 (issue5228).

Proposed patch adds support of __new__ with keyword arguments with protocols 2 and 3.

"Pickling of objects of classes whose __new__ mandates the use of keyword-only arguments is supported with protocol 4 (using a new opcode NEWOBJ_EX)."

Hum, can you please write a short example of such class which can only be pickled by the protocol 4 currently? Just for my information.

I understand that some objects cannot be serialized by pickle with protocol lower than 4, whereas your change makes possible to serialize them on Python 3, and it will be possible to deserialize them on Python 2 and Python 3.

If I understood correctly, the change makes sense.

I reviewed the patch, it looks good to me.

> Hum, can you please write a short example of such class which can only be pickled by the protocol 4 currently? Just for my information.

For now there are no such classes in the stdlib. No one implements __getnewargs_ex__. But an alternative implementation of pickling for methodcaller could use it (I implemented methodcaller pickling in issue22955 in different way, via __reduce_ex__, but used the same trick for passing keyword arguments to constructor).

Note that multiprocessing uses default protocol 3 (issue23403), and this is not configurable.

New changeset bc5894a3a0e6 by Serhiy Storchaka in branch 'default':
Issue #24164: Objects that need calling ``__new__`` with keyword arguments,
https://hg.python.org/cpython/rev/bc5894a3a0e6

Thank you for your review Victor.

Buildbots failed.

http://buildbot.python.org/all/builders/AMD64%20Debian%20root%203.x/builds/2807/steps/test/logs/stdio

======================================================================
FAIL: test_reduce (test.test_descr.PicklingTests)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/test/test_descr.py", line 4745, in test_reduce
    obj.__reduce_ex__(proto)
AssertionError: ValueError not raised

New changeset df33dbbef7bb by Serhiy Storchaka in branch 'default':
Issue #24164: Fixed test_descr: __getnewargs_ex__ now is supported in protocols 2 and 3.
https://hg.python.org/cpython/rev/df33dbbef7bb

Thank you Victor. Tests are fixed.

I think the documentation needs to be updated. Here is a patch for pickle documentation.

"Thank you Victor. Tests are fixed."

Not all of them. Failure on FreeBSD:

(I don't know what is test_pyclbr!?)

http://buildbot.python.org/all/builders/AMD64%20FreeBSD%2010.0%203.x/builds/3866/


======================================================================
FAIL: test_others (test.test_pyclbr.PyclbrTest)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/usr/home/buildbot/python/3.x.koobs-freebsd10/build/Lib/test/test_pyclbr.py", line 159, in test_others
    cm('pickle')
  File "/usr/home/buildbot/python/3.x.koobs-freebsd10/build/Lib/test/test_pyclbr.py", line 86, in checkModule
    self.assertIsInstance(py_item, (FunctionType, BuiltinFunctionType))
AssertionError: <class 'functools.partial'> is not an instance of (<class 'function'>, <class 'builtin_function_or_method'>)

----------------------------------------------------------------------

New changeset 288953a787ce by Victor Stinner in branch 'default':
Issue #24164: Fix test_pyclbr
https://hg.python.org/cpython/rev/288953a787ce

> New changeset 288953a787ce by Victor Stinner in branch 'default':
> Issue #24164: Fix test_pyclbr

Another fix would be to accept functools.partial type, but it looks like the test wants to exclude symbols which comes from other modules.

At least, test_pyclbr was fixed by my change. Most 3.x buildbots are green again.

Thank you Victor for fixing test_pyclbr. test_pyclbr looks fragile and may be there are bugs in pyclbr itself. But this is different issue.

Could you please look at proposed documentation changes?

Serhiy Storchaka added the comment:
> Could you please look at proposed documentation changes?

Sure, done.

Documentation patch updated.

pickle_new_ex_protocol_2_doc_2.patch looks good to me.

New changeset de982d8b7b15 by Serhiy Storchaka in branch 'default':
Issue #24164: Document changes to __getnewargs__ and __getnewargs_ex__.
https://hg.python.org/cpython/rev/de982d8b7b15

Thanks.

New changeset 7adc1d24d05b by Victor Stinner in branch 'default':
Closes #25645: Fix a reference leak introduced by change bc5894a3a0e6 of the
https://hg.python.org/cpython/rev/7adc1d24d05b