Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit c44e9ec

Browse files
committed
Added docs for PyObject_CallFunctionObArgs() and PyObject_CallMethodObArgs().
Minor cleanups & markup consistency fixes.
1 parent 81c7aa2 commit c44e9ec

1 file changed

Lines changed: 32 additions & 11 deletions

File tree

Doc/api/abstract.tex

Lines changed: 32 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -183,31 +183,52 @@ \section{Object Protocol \label{object}}
183183
\bifuncindex{apply}
184184
\end{cfuncdesc}
185185

186-
\begin{cfuncdesc}{PyObject*}{PyObject_CallFunction}{PyObject *callable_object,
187-
char *format, ...}
188-
Call a callable Python object \var{callable_object}, with a variable
186+
\begin{cfuncdesc}{PyObject*}{PyObject_CallFunction}{PyObject *callable,
187+
char *format, \moreargs}
188+
Call a callable Python object \var{callable}, with a variable
189189
number of C arguments. The C arguments are described using a
190190
\cfunction{Py_BuildValue()} style format string. The format may be
191191
\NULL, indicating that no arguments are provided. Returns the
192192
result of the call on success, or \NULL{} on failure. This is the
193-
equivalent of the Python expression
194-
\samp{apply(\var{callable_object}\var{args})} or
195-
\samp{\var{callable_object}(*\var{args})}.
193+
equivalent of the Python expression \samp{apply(\var{callable},
194+
\var{args})} or \samp{\var{callable}(*\var{args})}.
196195
\bifuncindex{apply}
197196
\end{cfuncdesc}
198197

199198

200199
\begin{cfuncdesc}{PyObject*}{PyObject_CallMethod}{PyObject *o,
201-
char *method, char *format, ...}
200+
char *method, char *format,
201+
\moreargs}
202202
Call the method named \var{m} of object \var{o} with a variable
203203
number of C arguments. The C arguments are described by a
204204
\cfunction{Py_BuildValue()} format string. The format may be \NULL,
205205
indicating that no arguments are provided. Returns the result of the
206206
call on success, or \NULL{} on failure. This is the equivalent of
207-
the Python expression \samp{\var{o}.\var{method}(\var{args})}. Note
208-
that special method names, such as \method{__add__()},
209-
\method{__getitem__()}, and so on are not supported. The specific
210-
abstract-object routines for these must be used.
207+
the Python expression \samp{\var{o}.\var{method}(\var{args})}.
208+
\end{cfuncdesc}
209+
210+
211+
\begin{cfuncdesc}{PyObject*}{PyObject_CallFunctionObArgs}{PyObject *callable,
212+
\moreargs,
213+
\code{NULL}}
214+
Call a callable Python object \var{callable}, with a variable
215+
number of \ctype{PyObject*} arguments. The arguments are provided
216+
as a variable number of parameters followed by \NULL.
217+
Returns the result of the call on success, or \NULL{} on failure.
218+
\versionadded{2.2}
219+
\end{cfuncdesc}
220+
221+
222+
\begin{cfuncdesc}{PyObject*}{PyObject_CallMethodObArgs}{PyObject *o,
223+
PyObject *name,
224+
\moreargs,
225+
\code{NULL}}
226+
Calls a method of the object \var{o}, where the name of the method
227+
is given as a Python string object in \var{name}. It is called with
228+
a variable number of \ctype{PyObject*} arguments. The arguments are
229+
provided as a variable number of parameters followed by \NULL.
230+
Returns the result of the call on success, or \NULL{} on failure.
231+
\versionadded{2.2}
211232
\end{cfuncdesc}
212233

213234

0 commit comments

Comments
 (0)