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.

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

Jump to bottom

Document how to use varargs in Argument Clinic #1277

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Document how to use varargs in Argument Clinic #1277

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
449ff4e
Document how to use varargs in Argument Clinic
aisk Feb 23, 2024
bf96705
move up the section
aisk Feb 25, 2024
ec5c728
Use the term from https://docs.python.org/3/glossary.html#term-parameter
aisk Feb 25, 2024
f2edea8
remove the term markup
aisk Feb 25, 2024
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
20 changes: 20 additions & 0 deletions development-tools/clinic.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2213,3 +2213,23 @@ 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
Loading