diff options
| author | Larry Hastings <larry@hastings.org> | 2012-03-20 20:06:16 +0000 |
|---|---|---|
| committer | Larry Hastings <larry@hastings.org> | 2012-03-20 20:06:16 +0000 |
| commit | c067da0e5c050df338fdc2f8ab6a01283f92f0ea (patch) | |
| tree | 3f2c3e7d841c3a64d57e43936a025e76a5055616 /Doc/c-api/arg.rst | |
| parent | 5409615e74558e99b8f4b6575a6d78f5a1d7a840 (diff) | |
| download | cpython-c067da0e5c050df338fdc2f8ab6a01283f92f0ea.tar.gz | |
Issue #14328: Add keyword-only parameters to PyArg_ParseTupleAndKeywords.
They're optional-only for now (unlike in pure Python) but that's all
I needed. The syntax can easily be relaxed if we want to support
required keyword-only arguments for extension types in the future.
Diffstat (limited to 'Doc/c-api/arg.rst')
| -rw-r--r-- | Doc/c-api/arg.rst | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/Doc/c-api/arg.rst b/Doc/c-api/arg.rst index 196aa772b8..f33714e1b7 100644 --- a/Doc/c-api/arg.rst +++ b/Doc/c-api/arg.rst @@ -338,6 +338,15 @@ inside nested parentheses. They are: :c:func:`PyArg_ParseTuple` does not touch the contents of the corresponding C variable(s). +``$`` + :c:func:`PyArg_ParseTupleAndKeywords` only: + Indicates that the remaining arguments in the Python argument list are + keyword-only. Currently, all keyword-only arguments must also be optional + arguments, so ``|`` must always be specified before ``$`` in the format + string. + + .. versionadded:: 3.3 + ``:`` The list of format units ends here; the string after the colon is used as the function name in error messages (the "associated value" of the exception that |