mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-14 15:56:48 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 12

Corrected a section reference (title was wrong).

Browse source 
Added information on the return values of PyArg_ParseTuple() and
PyArg_ParseTupleAndKeywords().
This commit is contained in:
Fred Drake 2001-07-20 20:59:49 +00:00
parent 88fdaa7c9e
commit 3332778f35
1 changed files with 8 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

11
Doc/ext/ext.tex
View file

@ -547,8 +547,8 @@ This function must be registered with the interpreter using the
\constant{METH_VARARGS} flag; this is described in section \constant{METH_VARARGS} flag; this is described in section
\ref{methodTable}, ``The Module's Method Table and Initialization \ref{methodTable}, ``The Module's Method Table and Initialization
Function.'' The \cfunction{PyArg_ParseTuple()} function and its Function.'' The \cfunction{PyArg_ParseTuple()} function and its
arguments are documented in section \ref{parseTuple}, ``Format Strings arguments are documented in section \ref{parseTuple}, ``Extracting
for \cfunction{PyArg_ParseTuple()}.'' Parameters in Extension Functions.''
The macros \cfunction{Py_XINCREF()} and \cfunction{Py_XDECREF()} The macros \cfunction{Py_XINCREF()} and \cfunction{Py_XDECREF()}
increment/decrement the reference count of an object and are safe in increment/decrement the reference count of an object and are safe in
@ -651,7 +651,8 @@ must be a format string, whose syntax is explained below. The
remaining arguments must be addresses of variables whose type is remaining arguments must be addresses of variables whose type is
determined by the format string. For the conversion to succeed, the determined by the format string. For the conversion to succeed, the
\var{arg} object must match the format and the format must be \var{arg} object must match the format and the format must be
exhausted. exhausted. On success, \cfunction{PyArg_ParseTuple()} returns true,
otherwise it returns false and raises an appropriate exception.
Note that while \cfunction{PyArg_ParseTuple()} checks that the Python Note that while \cfunction{PyArg_ParseTuple()} checks that the Python
arguments have the required types, it cannot check the validity of the arguments have the required types, it cannot check the validity of the
@ -989,7 +990,9 @@ The \var{arg} and \var{format} parameters are identical to those of the
is the dictionary of keywords received as the third parameter from the is the dictionary of keywords received as the third parameter from the
Python runtime. The \var{kwlist} parameter is a \NULL{}-terminated Python runtime. The \var{kwlist} parameter is a \NULL{}-terminated
list of strings which identify the parameters; the names are matched list of strings which identify the parameters; the names are matched
with the type information from \var{format} from left to right. with the type information from \var{format} from left to right. On
success, \cfunction{PyArg_ParseTupleAndKeywords()} returns true,
otherwise it returns false and raises an appropriate exception.
\strong{Note:} Nested tuples cannot be parsed when using keyword \strong{Note:} Nested tuples cannot be parsed when using keyword
arguments! Keyword parameters passed in which are not present in the arguments! Keyword parameters passed in which are not present in the