GeezerVisonThe World Wide Web, restored to 800 pixels of glory. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Home|About|Gaming cabinet|Archives|How it works|Starter sites | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GeezerVison is showing github.com — Document how to use varargs in Argument Clinic by skirpichev · Pull Request #1629 · python/devguide Conversation
|
|
This is a minor correction of closed pr #1277 (now var-positional arguments passed a C array). The rest looks fine for me. |
All reactions
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Co-authored-by: Sergey B Kirpichev <[email protected]>
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Co-authored-by: Adam Turner <[email protected]>
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
AA-Turner
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should mention both the tuple and array converters, they do different things. Notably array results in PyObject * const *args and Py_ssize_t args_length, whereas tuple just passes a regular PyTupleObject.
Also, I found the PR where : object was removed (python/cpython#126560 by @serhiy-storchaka)
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
All reactions
It's not removed, just an alias for tuple. |
All reactions
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
| How to convert var-positional parameter functions | ||
| ------------------------------------------------- | ||
|
|
||
| To convert a var-positional parameter function, prepend the parameter name | ||
| with ``*`` and use the the ``array`` converter. | ||
| For example:: | ||
|
|
||
| /*[clinic input] | ||
| var_positional_sample | ||
|
|
||
| foo: int | ||
| *args: array | ||
| [clinic start generated code]*/ | ||
|
|
||
| The implementation function will receive var-positional arguments as C array | ||
| *args* of :c:type:`PyObject * <PyObject>`. Alternatively, you could use | ||
| ``tuple`` converter to pass a regular :c:type:`PyTupleObject` as argument. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A suggested rephrasing to split tuple and array. I've also switched to saying *args instead of emphasising var-positional, the documentation uses *args or starargs, when discussing the feature in the language reference, it seems to be only internal to Clinic to say varpos.
| How to convert var-positional parameter functions | |
| ------------------------------------------------- | |
| To convert a var-positional parameter function, prepend the parameter name | |
| with ``*`` and use the the ``array`` converter. | |
| For example:: | |
| /*[clinic input] | |
| var_positional_sample | |
| foo: int | |
| *args: array | |
| [clinic start generated code]*/ | |
| The implementation function will receive var-positional arguments as C array | |
| *args* of :c:type:`PyObject * <PyObject>`. Alternatively, you could use | |
| ``tuple`` converter to pass a regular :c:type:`PyTupleObject` as argument. | |
| 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]*/ |
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
All reactions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO, it's too verbose. But OK.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
All reactions
Co-authored-by: Adam Turner <[email protected]>
Reviewers
Uh oh!
There was an error while loading. Please reload this page.
Assignees
No one assignedLabels
Projects
Milestone
No milestoneDevelopment
Successfully merging this pull request may close these issues.
Uh oh!
There was an error while loading. Please reload this page.
4 participants
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.