Check documentation of PyObject_CopyData #102383

purpleKarrot · 2023-03-03T00:08:28Z

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

The text was updated successfully, but these errors were encountered:

terryjreedy · 2023-03-03T00:53:11Z

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 · 2023-03-03T08:28:23Z

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 · 2023-03-03T09:48:19Z

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!

…102390)

…t *` (pythonGH-102390) (cherry picked from commit 7b91320) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>

…H-102390) (cherry picked from commit 7b91320) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>

* main: pythongh-102021 : Allow multiple input files for interpreter loop generator (python#102022) Add import of `unittest.mock.Mock` in documentation (python#102346) pythongh-102383: [docs] Arguments of `PyObject_CopyData` are `PyObject *` (python#102390) pythongh-101754: Document that Windows converts keys in `os.environ` to uppercase (pythonGH-101840) pythongh-102324: Improve tests of `typing.override` (python#102325)

bedevere-bot mentioned this issue Mar 3, 2023

gh-102383: [docs] Arguments of PyObject_CopyData are PyObject * #102390

Merged

sobolevn added a commit to sobolevn/cpython that referenced this issue Mar 3, 2023

pythongh-102383: [docs] Arguments of PyObject_CopyData are PyObjects

92835fe

sobolevn added type-bug An unexpected behavior, bug, or error docs Documentation in the Doc dir labels Mar 3, 2023

kumaraditya303 pushed a commit that referenced this issue Mar 3, 2023

gh-102383: [docs] Arguments of PyObject_CopyData are PyObject * (#…

7b91320

…102390)

bedevere-bot mentioned this issue Mar 3, 2023

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

Merged

miss-islington pushed a commit to miss-islington/cpython that referenced this issue Mar 3, 2023

pythongh-102383: [docs] Arguments of PyObject_CopyData are `PyObjec…

b492daf

…t *` (pythonGH-102390) (cherry picked from commit 7b91320) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>

miss-islington added a commit that referenced this issue Mar 3, 2023

gh-102383: [docs] Arguments of PyObject_CopyData are PyObject * (G…

00791f2

…H-102390) (cherry picked from commit 7b91320) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>

sobolevn closed this as completed Mar 4, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Check documentation of PyObject_CopyData #102383

Check documentation of PyObject_CopyData #102383

purpleKarrot commented Mar 3, 2023 •

edited by bedevere-bot

terryjreedy commented Mar 3, 2023

ronaldoussoren commented Mar 3, 2023

sobolevn commented Mar 3, 2023

Check documentation of PyObject_CopyData #102383

Check documentation of PyObject_CopyData #102383

Comments

purpleKarrot commented Mar 3, 2023 • edited by bedevere-bot

Linked PRs

terryjreedy commented Mar 3, 2023

ronaldoussoren commented Mar 3, 2023

sobolevn commented Mar 3, 2023

purpleKarrot commented Mar 3, 2023 •

edited by bedevere-bot