Skip to content

Argument Clinic: document vectorcall #1948

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
StanFromIreland merged 3 commits into from
Oct 29, 2026
+13 −0
Merged

Argument Clinic: document vectorcall #1948

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8481c79
Argument Clinic: document vectorcall
cmaloney Oct 27, 2026
ab014a1
Fix indentation
cmaloney Oct 28, 2026
6495604
Update development-tools/clinic/howto.rst
cmaloney Oct 29, 2026
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
13 changes: 13 additions & 0 deletions development-tools/clinic/howto.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
.. _clinic-howtos:

How-to guides
Expand Down Expand Up @@ -875,6 +875,19 @@
(If your function doesn't support keywords, the parsing function
generated will throw an exception if it receives any.)

* :ref:`vectorcall protocol <python:vectorcall>` support can be added using the
``@vectorcall`` directive. This will output an additional function that can be
used in the :c:member:`~PyTypeObject.tp_vectorcall` slot.
The generated function adds a fair amount of code, so benchmark first
and only use it where it gives a significant speedup.

Current restrictions:

* Optional groups are not supported.
* The type must be immutable (:c:macro:`Py_TPFLAGS_IMMUTABLETYPE`).

@cmaloney cmaloney Oct 28, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

There are more restrictions than this in the current implementation but I'm steadily working to remove them as I move types.


.. versionadded:: 3.16


How to change and redirect Clinic's output
------------------------------------------
Expand Down
Loading