Python C API使用时需要注意什么

最新推荐文章于 2024-06-04 08:45:00 发布

刘一痕

最新推荐文章于 2024-06-04 08:45:00 发布

阅读量1k

点赞数

分类专栏： Python/Ruby

本文链接：https://blog.csdn.net/u013177568/article/details/62432506

版权

Python/Ruby 专栏收录该内容

46 篇文章 1 订阅

订阅专栏

一：用C API为Python写C语言函数，以方便Python中调用

1. 首先实现一个特定原型的函数，用Python C API来实现的话，所有函数必须是这种原型。必须是类似这样的

PyObject *Fun(PyObject *self, PyObject *args)

self应该是在用类的时候才会用到（我没有用到），args就是函数的参数。因为args是一个PyObject*类型（可以代表Python语言中的任何类型）

2. 将参数转换成C 语言表示的内容，用PyArg_ParseTuple函数。

3. 执行完需要的操作后，也必须返回一个PyObject*类型的值。通过Py_BuildValue函数来构建。

这里要说的是，假如希望返回一个Tuple类型的值，可以先用

PyObject *tuple = Py_BuildValue("(iis)", 1, 2, "three");

形式来构建，假如很多的话，可以用下面的方式来构建

PyObject *t;

t = PyTuple_New(3);

PyTuple_SetItem(t, 0, PyLong_FromLong(1L));

PyTuple_SetItem(t, 1, PyLong_FromLong(2L));

PyTuple_SetItem(t, 2, PyString_FromString("three"));

这一点在刚开始开工的时候迷惑了很久。

4. 将要输出的所有函数放入一个数组中，数组的结构是：

struct PyMethodDef {

const char *ml_name; /* The name of the built-in function/method */

PyCFunction ml_meth; /* The C function that implements it */

int ml_flags; /* Combination of METH_xxx flags, which mostly

describe the args expected by the C func */

const char *ml_doc; /* The __doc__ attribute, or NULL */

};

数组以{NULL, NULL}结束

5. 构造一个Python import时初始化的函数

类似

PyMODINIT_FUNC

initexample(void)

{

Py_InitModule("example", example_methods);

}

这里有个特别需要注意的是，初始化函数名字有严格要求，init后面必须跟模块名，否则Python找不到确定的函数会报没有初始化函数的错误

扩展模块写完后，编译成动态库（Python要求此动态库名字为pyd,实际就是改个后缀而已）。就可以直接在Python脚本中用import的方式加载了，对于使用来说，根本不需要知道此库是用C API扩展写的还是直接用Python语句写的（这点Lua做的也是一样好）

最后，python的源代码中附带了一个叫做example_nt的例子，可以参考一样，完整的扩展代码如下：

#include "Python.h"

static PyObject *

ex_foo(PyObject *self, PyObject *args)

{

printf("Hello, world/n");

Py_INCREF(Py_None);

return Py_None;

}

static PyMethodDef example_methods[] = {

{"foo", ex_foo, METH_VARARGS, "foo() doc string"},

{NULL, NULL}

};

PyMODINIT_FUNC

initexample(void)

{

Py_InitModule("example", example_methods);

}

二．C语言中调用Python语句

首先，void Py_Initialize()用来初始化，void Py_Finalize()用来结束Python的调用，这是必须要的。

燃火分两种情况，假如仅仅是几条语句的话，那么以PyRun_为前缀的一些函数都很好用，比如

int PyRun_SimpleString(const char *command)

函数就可以直接执行一条char*的Python语句。

需要获得返回值得话

PyObject* PyRun_String(const char *str, int start, PyObject *globals, PyObject *locals)

也很好用，以上两个函数用来处理Python源代码已经读入内存的情况，在文件中的时候

int PyRun_SimpleFile(FILE *fp, const char *filename)

PyObject* PyRun_File(FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals)

使用类似。不多讲了。

假如是个模块的话（比如一个函数），希望在C语言中调用的话那么使用起来就稍微复杂了一点。这种情况的需要在于你可以从C语言中向Python函数中传入参数并且执行，然后获取结果。

此处又分为几种情况：

在文件中，在内存中，编译过的，源代码。

在文件中都很好解决，和上面一样。这里主要讲在内存中的情况。（事实上我工作中需要并且耗费了很长时间才找到解决方法的就是这种情况）

未编译时：（也就是源代码）

1.通过

PyObject* Py_CompileString(const char *str, const char *filename, int start)

API首先编译一次。此API的参数我说明一下，str就是内存中的源代码，filename主要是出错时报错误用的，事实测试证明，你随意给个字符串也没有关系，但给NULL参数在运行时必然报错。start我一般用的是Py_file_input，因为的确是从文件中读取过来的，相对的还有Py_single_input用来表示一条语句，Py_eval_input的用法我也不是太清楚。

源代码通过此函数调用后，获得编译后的PyObject*,（其实假如跟进源代码中去看，是一个PyCodeObject结构）假设命名为lpCode。

2.此时再调用API

PyObject* PyImport_ExecCodeModule(char *name, PyObject *co)

导入模块。参数也说明一下，name为导入的模块名，co就是前面编译过的代码对象（lpCode）。返回的就是模块对象了，假设命名为lpMod。

3.再调用API

PyObject* PyObject_GetAttrString(PyObject *o, const char *attr_name)

获得函数对象。o就是模块对象（lpMod）,attr_name就是你想要调用的函数名了，假设叫main的函数，就是”main”，然后返回的就是函数对象，假设命名为lpFun。

4.此时可以用API

int PyCallable_Check(PyObject *o)

去检查一下是不是获得了一个函数。假如确定的话，就可以直接用

PyObject_Call开头的一族函数调用lpFun了。这些函数包括很多，一般就是输入参数的不同，但是效果都是一样的，就是调用函数而已。参数一般可以通过前面说过的build函数来获得，返回值也是获得一个PyObject*,可以通过PyArg_那个函数来获取，但是好像不太好，那是分析参数用的。推荐用确定类型（假设为type）的类似Py[type]_As的函数来获取。