C语言调用Python代码的方法

问题

你想在c中安全的执行某个python调用并返回结果给c。 例如，你想在c语言中使用某个python函数作为一个回调。

解决方案

在c语言中调用python非常简单，不过涉及到一些小窍门。 下面的c代码告诉你怎样安全的调用：

#include <python.h>

/* execute func(x,y) in the python interpreter. the
arguments and return result of the function must be python floats */
double call_func(pyobject *func, double x, double y) {
pyobject *args; pyobject *kwargs; pyobject *result = 0; double retval;

/* make sure we own the gil */ pygilstate_state state = pygilstate_ensure();

/* verify that func is a proper callable */ if (!pycallable_check(func)) {

fprintf(stderr,”call_func: expected a callablen”); goto fail;
} /* build arguments */ args = py_buildvalue(“(dd)”, x, y); kwargs = null;

/* call the function */ result = pyobject_call(func, args, kwargs); py_decref(args); py_xdecref(kwargs);

/* check for python exceptions (if any) */ if (pyerr_occurred()) {

pyerr_print(); goto fail;
}

/* verify the result is a float object */ if (!pyfloat_check(result)) {

fprintf(stderr,”call_func: callable didn't return a floatn”); goto fail;
}

/* create the return value */ retval = pyfloat_asdouble(result); py_decref(result);

/* restore previous gil state and return */ pygilstate_release(state); return retval;

fail:
py_xdecref(result); pygilstate_release(state); abort(); // change to something more appropriate
}

要使用这个函数，你需要获取传递过来的某个已存在python调用的引用。 有很多种方法可以让你这样做， 比如将一个可调用对象传给一个扩展模块或直接写c代码从已存在模块中提取出来。

下面是一个简单例子用来展示从一个嵌入的python解释器中调用一个函数：

#include <python.h>

/* definition of call_func() same as above */
...

/* load a symbol from a module */
pyobject *import_name(const char *modname, const char *symbol) {
 pyobject *u_name, *module;
 u_name = pyunicode_fromstring(modname);
 module = pyimport_import(u_name);
 py_decref(u_name);
 return pyobject_getattrstring(module, symbol);
}

/* simple embedding example */
int main() {
 pyobject *pow_func;
 double x;

 py_initialize();
 /* get a reference to the math.pow function */
 pow_func = import_name("math","pow");

 /* call it using our call_func() code */
 for (x = 0.0; x < 10.0; x += 0.1) {
 printf("%0.2f %0.2f\n", x, call_func(pow_func,x,2.0));
 }
 /* done */
 py_decref(pow_func);
 py_finalize();
 return 0;
}

要构建例子代码，你需要编译c并将它链接到python解释器。 下面的makefile可以教你怎样做（不过在你机器上面需要一些配置）。

all::
 cc -g embed.c -i/usr/local/include/python3.3m \
  -l/usr/local/lib/python3.3/config-3.3m -lpython3.3m

编译并运行会产生类似下面的输出：

0.00 0.00
0.10 0.01
0.20 0.04
0.30 0.09
0.40 0.16
...

下面是一个稍微不同的例子，展示了一个扩展函数， 它接受一个可调用对象和其他参数，并将它们传递给 call_func() 来做测试：

/* extension function for testing the c-python callback */
pyobject *py_call_func(pyobject *self, pyobject *args) {
 pyobject *func;

 double x, y, result;
 if (!pyarg_parsetuple(args,"odd", &func,&x,&y)) {
 return null;
 }
 result = call_func(func, x, y);
 return py_buildvalue("d", result);
}

使用这个扩展函数，你要像下面这样测试它：

>>> import sample
>>> def add(x,y):
...   return x+y
...
>>> sample.call_func(add,3,4)
7.0
>>>

讨论

如果你在c语言中调用python，要记住最重要的是c语言会是主体。 也就是说，c语言负责构造参数、调用python函数、检查异常、检查类型、提取返回值等。

作为第一步，你必须先有一个表示你将要调用的python可调用对象。 这可以是一个函数、类、方法、内置方法或其他任意实现了 __call__() 操作的东西。 为了确保是可调用的，可以像下面的代码这样利用 pycallable_check() 做检查：

double call_func(pyobject *func, double x, double y) {
 ...
 /* verify that func is a proper callable */
 if (!pycallable_check(func)) {
 fprintf(stderr,"call_func: expected a callable\n");
 goto fail;
 }
 ...

在c代码里处理错误你需要格外的小心。一般来讲，你不能仅仅抛出一个python异常。 错误应该使用c代码方式来被处理。在这里，我们打算将对错误的控制传给一个叫 abort() 的错误处理器。 它会结束掉整个程序，在真实环境下面你应该要处理的更加优雅些（返回一个状态码）。 你要记住的是在这里c是主角，因此并没有跟抛出异常相对应的操作。 错误处理是你在编程时必须要考虑的事情。

调用一个函数相对来讲很简单——只需要使用 pyobject_call() ， 传一个可调用对象给它、一个参数元组和一个可选的关键字字典。 要构建参数元组或字典，你可以使用 py_buildvalue() ,如下：

double call_func(pyobject *func, double x, double y) {
 pyobject *args;
 pyobject *kwargs;

 ...
 /* build arguments */
 args = py_buildvalue("(dd)", x, y);
 kwargs = null;

 /* call the function */
 result = pyobject_call(func, args, kwargs);
 py_decref(args);
 py_xdecref(kwargs);
 ...

如果没有关键字参数，你可以传递null。当你要调用函数时， 需要确保使用了 py_decref() 或者 py_xdecref() 清理参数。 第二个函数相对安全点，因为它允许传递null指针（直接忽略它）， 这也是为什么我们使用它来清理可选的关键字参数。

调用完python函数之后，你必须检查是否有异常发生。 pyerr_occurred() 函数可被用来做这件事。 对于异常的处理就有点麻烦了，由于是用c语言写的，没有python那样的异常机制。 因此，你必须要设置一个异常状态码，打印异常信息或其他相应处理。 在这里，我们选择了简单的 abort() 来处理。另外，传统c程序员可能会直接让程序奔溃。

...
/* check for python exceptions (if any) */
if (pyerr_occurred()) {
 pyerr_print();
 goto fail;
}
...
fail:
 pygilstate_release(state);
 abort();

从调用python函数的返回值中提取信息通常要进行类型检查和提取值。 要这样做的话，你必须使用python对象层中的函数。 在这里我们使用了 pyfloat_check() 和 pyfloat_asdouble() 来检查和提取python浮点数。

最后一个问题是对于python全局锁的管理。 在c语言中访问python的时候，你需要确保gil被正确的获取和释放了。 不然的话，可能会导致解释器返回错误数据或者直接奔溃。 调用 pygilstate_ensure() 和 pygilstate_release() 可以确保一切都能正常。

double call_func(pyobject *func, double x, double y) {
 ...
 double retval;

 /* make sure we own the gil */
 pygilstate_state state = pygilstate_ensure();
 ...
 /* code that uses python c api functions */
 ...
 /* restore previous gil state and return */
 pygilstate_release(state);
 return retval;

fail:
 pygilstate_release(state);
 abort();
}

一旦返回，pygilstate_ensure() 可以确保调用线程独占python解释器。 就算c代码运行于另外一个解释器不知道的线程也没事。 这时候，c代码可以*的使用任何它想要的python c-api 函数。 调用成功后，pygilstate_release()被用来将解释器恢复到原始状态。

要注意的是每一个 pygilstate_ensure() 调用必须跟着一个匹配的 pygilstate_release() 调用——即便有错误发生。 在这里，我们使用一个 goto 语句看上去是个可怕的设计， 但是实际上我们使用它来将控制权转移给一个普通的exit块来执行相应的操作。 在 fail: 标签后面的代码和python的 final: 块的用途是一样的。

如果你使用所有这些约定来编写c代码，包括对gil的管理、异常检查和错误检查， 你会发现从c语言中调用python解释器是可靠的——就算再复杂的程序，用到了高级编程技巧比如多线程都没问题。

以上就是c语言调用python代码的方法的详细内容，更多关于c语言调用python的资料请关注其它相关文章！