diff options
author | Georg Brandl <georg@python.org> | 2007-12-01 22:24:47 (GMT) |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2007-12-01 22:24:47 (GMT) |
commit | 16f1df91ce6d5b0a921adbfca56f692d3408f582 (patch) | |
tree | 113d0dcfdf883f9ff2351e498ddfd234504caab7 /Doc/extending | |
parent | 77b2d63b40942087f023999a0329aeea6dd1d6e9 (diff) | |
download | cpython-16f1df91ce6d5b0a921adbfca56f692d3408f582.zip cpython-16f1df91ce6d5b0a921adbfca56f692d3408f582.tar.gz cpython-16f1df91ce6d5b0a921adbfca56f692d3408f582.tar.bz2 |
Document PyEval_* functions from ceval.c.
Credits to Michael Sloan from GHOP.
Diffstat (limited to 'Doc/extending')
-rw-r--r-- | Doc/extending/extending.rst | 23 |
1 files changed, 18 insertions, 5 deletions
diff --git a/Doc/extending/extending.rst b/Doc/extending/extending.rst index 4a11d97..21eeddf 100644 --- a/Doc/extending/extending.rst +++ b/Doc/extending/extending.rst @@ -471,10 +471,10 @@ Later, when it is time to call the function, you call the C function :cfunc:`PyEval_CallObject`. This function has two arguments, both pointers to arbitrary Python objects: the Python function, and the argument list. The argument list must always be a tuple object, whose length is the number of -arguments. To call the Python function with no arguments, pass an empty tuple; -to call it with one argument, pass a singleton tuple. :cfunc:`Py_BuildValue` -returns a tuple when its format string consists of zero or more format codes -between parentheses. For example:: +arguments. To call the Python function with no arguments, pass in NULL, or +an empty tuple; to call it with one argument, pass a singleton tuple. +:cfunc:`Py_BuildValue` returns a tuple when its format string consists of zero +or more format codes between parentheses. For example:: int arg; PyObject *arglist; @@ -532,9 +532,22 @@ event code, you might use the following code:: Py_DECREF(result); Note the placement of ``Py_DECREF(arglist)`` immediately after the call, before -the error check! Also note that strictly spoken this code is not complete: +the error check! Also note that strictly speaking this code is not complete: :cfunc:`Py_BuildValue` may run out of memory, and this should be checked. +You may also call a function with keyword arguments by using +:cfunc:`PyEval_CallObjectWithKeywords`. As in the above example, we use +:cfunc:`Py_BuildValue` to construct the dictionary. :: + + PyObject *dict; + ... + dict = Py_BuildValue("{s:i}", "name", val); + result = PyEval_CallObjectWithKeywords(my_callback, NULL, dict); + Py_DECREF(dict); + if (result == NULL) + return NULL; /* Pass error back */ + /* Here maybe use the result */ + Py_DECREF(result); .. _parsetuple: |