Skip to content
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

Document how to use varargs in Argument Clinic #1277

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
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
Prev Previous commit
Next Next commit
move up the section
aisk committed Feb 25, 2024

Partially verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
We cannot verify signatures from co-authors, and some of the co-authors attributed to this commit require their commits to be signed.
commit bf96705b2c9b38443cdc2b703363bef13a75c241
40 changes: 20 additions & 20 deletions development-tools/clinic.rst
Original file line number Diff line number Diff line change
@@ -1495,6 +1495,26 @@ 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 variadic arguments functions
-------------------------------------------

Some functions can be called with an arbitrary number of arguments.
These arguments will be wrapped up in a tuple.

To convert a function to accept variadic arguments,
add a ``*`` in front of the parameter name just like Python,
and the parameter should use the ``object`` converter::
Copy link
Member

Choose a reason for hiding this comment

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

What happens if I use something else? E.g., what if I want to accept an arbitrary number of ints?

Also, what type does the implementation function receive?

Copy link
Author

Choose a reason for hiding this comment

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

Thank you for the review! I have added a new paragraph to explain more about it.


/*[clinic input]
vararg_sample

foo: int
*args: object
[clinic start generated code]*/

.. versionadded:: 3.11


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

@@ -2213,23 +2233,3 @@ and update your unit tests to reflect the new behaviour.
If you forget to update your input block during the alpha and beta phases,
the compiler warning will turn into a compiler error when the
release candidate phase begins.


How to convert variadic arguments functions
-------------------------------------------

Some functions can be called with an arbitrary number of arguments.
These arguments will be wrapped up in a tuple.

To convert a function to accept variadic arguments,
add a ``*`` in front of the parameter name just like Python,
and the parameter should use the ``object`` converter::

/*[clinic input]
vararg_sample

foo: int
*args: object
[clinic start generated code]*/

.. versionadded:: 3.11