Skip to content

Document how to use varargs in Argument Clinic #1629

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.

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
merged 6 commits into from
Aug 18, 2025
Merged
Changes from all commits
Commits
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
31 changes: 31 additions & 0 deletions development-tools/clinic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1495,6 +1495,37 @@ You can still use a self converter, a return converter, and specify
a *type* argument to the object converter for :c:macro:`METH_O`.


How to convert ``*args`` parameters (starargs / var-positional)
---------------------------------------------------------------

There are two converters suitable for ``*args``: *array* and *tuple*.

Using the *array* converter will provide the implementation function with
a C array *args* of type of :c:type:`PyObject * <PyObject>` and the number
of items in the array as :c:type:`Py_ssize_t` *args_length*.
For example::

/*[clinic input]
var_positional_sample

spam: int
*args: array
[clinic start generated code]*/

Using the *tuple* converter will provide the implementation function with
a standard :c:type:`PyTupleObject`.
For example::

/*[clinic input]
var_positional_sample

spam: int
*args: tuple
[clinic start generated code]*/

.. versionadded:: 3.11


How to convert ``tp_new`` and ``tp_init`` functions
---------------------------------------------------

Expand Down
Loading