Skip to content

Clarify documentation about PyVectorcall_Function #107140

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.

Sign up for GitHub

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
vstinner merged 2 commits into from
Jul 24, 2023
Merged

Clarify documentation about PyVectorcall_Function #107140

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b9e279
Clarify documentation about PyVectorcall_*
da-woods Jul 23, 2023
68b6c82
revert NARGS and Call
da-woods Jul 24, 2023
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
Next Next commit
Clarify documentation about PyVectorcall_* 
The documentation implies that PyVectorcall_NARGS, PyVectorcall_Function, and PyVectorcall_Call were available in Python 3.8.

This is half-true - they were available under a different name. I think it's clearer to set the "version added" to 3.9
  • Loading branch information
@da-woods
da-woods authored Jul 23, 2023
commit 3b9e279c8d593bc5e7fba303399a2d614d136503
6 changes: 3 additions & 3 deletions Doc/c-api/call.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ Vectorcall Support API
However, the function ``PyVectorcall_NARGS`` should be used to allow
for future extensions.

.. versionadded:: 3.8
.. versionadded:: 3.9
Copy link
Copy Markdown
Member

@vstinner vstinner Jul 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PyVectorcall_NARGS() is defined as a static inline function in Python 3.8.0: https://github.com/python/cpython/blob/v3.8.0/Include/cpython/abstract.h#L75


.. c:function:: vectorcallfunc PyVectorcall_Function(PyObject *op)

Expand All @@ -152,7 +152,7 @@ Vectorcall Support API
This is mostly useful to check whether or not *op* supports vectorcall,
which can be done by checking ``PyVectorcall_Function(op) != NULL``.

.. versionadded:: 3.8
.. versionadded:: 3.9

.. c:function:: PyObject* PyVectorcall_Call(PyObject *callable, PyObject *tuple, PyObject *dict)

Expand All @@ -164,7 +164,7 @@ Vectorcall Support API
It does not check the :c:macro:`Py_TPFLAGS_HAVE_VECTORCALL` flag
and it does not fall back to ``tp_call``.

.. versionadded:: 3.8
.. versionadded:: 3.9
Copy link
Copy Markdown
Member

@vstinner vstinner Jul 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In Python 3.8.0, PyVectorcall_Call() was already defined as a regular function: https://github.com/python/cpython/blob/v3.8.0/Include/cpython/abstract.h#L141



.. _capi-call:
Expand Down