Skip to content

Document how to use varargs in Argument Clinic #1277

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

Closed
wants to merge 7 commits into from
Closed

Document how to use varargs in Argument Clinic #1277

Changes from 4 commits
Commits
Show all changes
7 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
b2f1914
Add description about what the implementaion functions will receive
aisk Oct 13, 2024
7d6c9c9
Update development-tools/clinic.rst
aisk Oct 14, 2024
9e7f846
Merge branch 'main' into ac-varargs
aisk Jul 21, 2025
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
17 changes: 17 additions & 0 deletions development-tools/clinic.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1495,6 +1495,23 @@ 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 var-positional parameter functions
-------------------------------------------------

To convert a var-positional parameter function,
prepending the parameter name with ``*`` ,
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
Member 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]
var_positional_sample

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

.. versionadded:: 3.11


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

Expand Down