C语言调用Python代码的方法

2023-07-19 17:05:04 250

问题

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

解决方案

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

#include

/*Executefunc(x,y)inthePythoninterpreter.The
argumentsandreturnresultofthefunctionmustbePythonfloats*/
doublecall_func(PyObject*func,doublex,doubley){
PyObject*args;PyObject*kwargs;PyObject*result=0;doubleretval;

/*MakesureweowntheGIL*/PyGILState_STATEstate=PyGILState_Ensure();

/*Verifythatfuncisapropercallable*/if(!PyCallable_Check(func)){

fprintf(stderr,”call_func:expectedacallablen”);gotofail;
}/*Buildarguments*/args=Py_BuildValue(“(dd)”,x,y);kwargs=NULL;

/*Callthefunction*/result=PyObject_Call(func,args,kwargs);Py_DECREF(args);Py_XDECREF(kwargs);

/*CheckforPythonexceptions(ifany)*/if(PyErr_Occurred()){

PyErr_Print();gotofail;
}

/*Verifytheresultisafloatobject*/if(!PyFloat_Check(result)){

fprintf(stderr,”call_func:callabledidn'treturnafloatn”);gotofail;
}

/*Createthereturnvalue*/retval=PyFloat_AsDouble(result);Py_DECREF(result);

/*RestorepreviousGILstateandreturn*/PyGILState_Release(state);returnretval;

fail:
Py_XDECREF(result);PyGILState_Release(state);abort();//Changetosomethingmoreappropriate
}

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

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

#include

/*Definitionofcall_func()sameasabove*/
...

/*Loadasymbolfromamodule*/
PyObject*import_name(constchar*modname,constchar*symbol){
PyObject*u_name,*module;
u_name=PyUnicode_FromString(modname);
module=PyImport_Import(u_name);
Py_DECREF(u_name);
returnPyObject_GetAttrString(module,symbol);
}

/*Simpleembeddingexample*/
intmain(){
PyObject*pow_func;
doublex;

Py_Initialize();
/*Getareferencetothemath.powfunction*/
pow_func=import_name("math","pow");

/*Callitusingourcall_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();
return0;
}

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

all::
cc-gembed.c-I/usr/local/include/python3.3m\
-L/usr/local/lib/python3.3/config-3.3m-lpython3.3m

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

0.000.00
0.100.01
0.200.04
0.300.09
0.400.16
...

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

/*ExtensionfunctionfortestingtheC-Pythoncallback*/
PyObject*py_call_func(PyObject*self,PyObject*args){
PyObject*func;

doublex,y,result;
if(!PyArg_ParseTuple(args,"Odd",&func,&x,&y)){
returnNULL;
}
result=call_func(func,x,y);
returnPy_BuildValue("d",result);
}

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

>>>importsample
>>>defadd(x,y):
...returnx+y
...
>>>sample.call_func(add,3,4)
7.0
>>>

讨论

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

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

doublecall_func(PyObject*func,doublex,doubley){
...
/*Verifythatfuncisapropercallable*/
if(!PyCallable_Check(func)){
fprintf(stderr,"call_func:expectedacallable\n");
gotofail;
}
...

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

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

doublecall_func(PyObject*func,doublex,doubley){
PyObject*args;
PyObject*kwargs;

...
/*Buildarguments*/
args=Py_BuildValue("(dd)",x,y);
kwargs=NULL;

/*Callthefunction*/
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程序员可能会直接让程序奔溃。

...
/*CheckforPythonexceptions(ifany)*/
if(PyErr_Occurred()){
PyErr_Print();
gotofail;
}
...
fail:
PyGILState_Release(state);
abort();

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

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

doublecall_func(PyObject*func,doublex,doubley){
...
doubleretval;

/*MakesureweowntheGIL*/
PyGILState_STATEstate=PyGILState_Ensure();
...
/*CodethatusesPythonCAPIfunctions*/
...
/*RestorepreviousGILstateandreturn*/
PyGILState_Release(state);
returnretval;

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

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

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

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

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

声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。

C语言调用Python代码的方法

热门推荐

随机推荐