Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
cpython
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kirill Smelkov
cpython
Commits
c84f2c50
Commit
c84f2c50
authored
23 years ago
by
Fred Drake
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Documentation for the new PyArg_UnpackTuple() function.
parent
e4616e67
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
47 additions
and
0 deletions
+47
-0
Doc/api/utilities.tex
Doc/api/utilities.tex
+47
-0
No files found.
Doc/api/utilities.tex
View file @
c84f2c50
...
...
@@ -388,6 +388,53 @@ Interpreter}.
purpose.
\end{cfuncdesc}
\begin{cfuncdesc}
{
int
}{
PyArg
_
UnpackTuple
}{
PyObject *args, char *name,
int min, int max,
\moreargs
}
A simpler form of parameter retrieval which does not use a format
string to specify the types of the arguments. Functions which use
this method to retrieve their parameters should be declared as
\constant
{
METH
_
VARARGS
}
in function or method tables. The tuple
containing the actual parameters should be passed as
\var
{
args
}
; it
must actually be a tuple. The length of the tuple must be at least
\var
{
min
}
and no more than
\var
{
max
}
;
\var
{
min
}
and
\var
{
max
}
may be
equal. Additional arguments must be passed to the function, each of
which should be a pointer to a
\ctype
{
PyObject*
}
variable; these
will be filled in with the values from
\var
{
args
}
; they will contain
borrowed references. The variables which correspond to optional
parameters not given by
\var
{
args
}
will not be filled in; these
should be initialized by the caller.
This function returns true on success and false if
\var
{
args
}
is not
a tuple or contains the wrong number of elements; an exception will
be set if there was a failure.
This is an example of the use of this function, taken from the
sources for the
\module
{_
weakref
}
helper module for weak references:
\begin{verbatim}
static PyObject *
weakref
_
ref(PyObject *self, PyObject *args)
{
PyObject *object;
PyObject *callback = NULL;
PyObject *result = NULL;
if (PyArg
_
UnpackTuple(args, "ref", 1, 2,
&
object,
&
callback))
{
result = PyWeakref
_
NewRef(object, callback);
}
return result;
}
\end{verbatim}
The call to
\cfunction
{
PyArg
_
UnpackTuple()
}
in this example is
entirely equivalent to this call to
\cfunction
{
PyArg
_
ParseTuple()
}
:
\begin{verbatim}
PyArg
_
ParseTuple(args, "O|O:ref",
&
object,
&
callback)
\end{verbatim}
\versionadded
{
2.2
}
\end{cfuncdesc}
\begin{cfuncdesc}
{
PyObject*
}{
Py
_
BuildValue
}{
char *format,
\moreargs
}
Create a new value based on a format string similar to those
...
...
This diff is collapsed.
Click to expand it.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment