Check documentation of PyObject_CopyData

[purpleKarrot]

According to the documentation, PyObject_CopyData takes two arguments of type Py_buffer*:

cpython/Doc/c-api/buffer.rst

Line 502 in 71db5db

.. c:function:: int PyObject_CopyData(Py_buffer *dest, Py_buffer *src)

But in the implementation, it actually takes two arguments of PyObject*:

cpython/Objects/abstract.c

Line 613 in 71db5db

int PyObject_CopyData(PyObject *dest, PyObject *src)

Linked PRs

• gh-102383: [docs] Arguments of PyObject_CopyData are PyObject * #102390
• [3.11] gh-102383: [docs] Arguments of PyObject_CopyData are PyObject * (GH-102390) #102401

[terryjreedy]

I few lines below, abstract.c has

 if (!PyObject_CheckBuffer(dest) ||
 !PyObject_CheckBuffer(src)){
 PyErr_SetString(PyExc_TypeError,
 "both destination and source must be "\
 "bytes-like objects");

So the 'PyObjects' indeed have to be buffer-like. I don't know the technical details, but I suspect that there is no real bug.

[ronaldoussoren]

I don't know the technical details, but I suspect that there is no real bug.

There is a bug as the documentation does not match the implementation, Py_buffer is not a Python object. In this case IMHO the documentation should be fixed.

[sobolevn]

Yes, PyObject_CheckBuffer looks like so:

int
PyObject_CheckBuffer(PyObject *obj)
{
 PyBufferProcs *tp_as_buffer = Py_TYPE(obj)->tp_as_buffer;
 return (tp_as_buffer != NULL && tp_as_buffer->bf_getbuffer != NULL);
}

So, there's clearly a bug in the docs. PR is sent :)
Thanks a lot for the report!