C调用Python脚本文件里的函数

代码是人家的，在此借用过来是为了说明C调用Python函数的方法。代码分为两部分，一为C的主程序部分，一为被调用的Python脚本部分。

Add.c

// C代码调，用上面的add函数
#include <stdio.h>
#include <stdlib.h>
#include "Python.h"

int main(int argc, char** argv)     // 初始化Python
{
//在使用Python系统前，必须使用Py_Initialize对其
//进行初始化。它会载入Python的内建模块并添加系统路     //是否初始化成功需要使用Py_IsInitialized。

char * string;
PyObject *pName, *pModule, *pDict, *pFunc, *pArgs, *pRetVal;

Py_Initialize();
if ( !Py_IsInitialized() )
return -1;

// 载入名为pytest的脚本(注意：不是pytest.py)
pName = PyString_FromString("pytest");
pModule = PyImport_Import(pName);
if ( !pModule )
{
printf("can't find pytest.py");
getchar();
return -1;
}
pDict = PyModule_GetDict(pModule);
if ( !pDict )
{
return -1;
}

// 找出函数名为add的函数
pFunc = PyDict_GetItemString(pDict, "add");
if ( !pFunc || !PyCallable_Check(pFunc) )
{
printf("can't find function [add]");
getchar();
return -1;
}

// 参数进栈
pArgs = PyTuple_New(2);

// PyObject* Py_BuildValue(char *format, ...)
// 把C++的变量转换成一个Python对象。当需要从
// C++传递变量到Python时，就会使用这个函数。此函数
// 有点类似C的printf，但格式不同。常用的格式有
// s 表示字符串，
// i 表示整型变量，
// f 表示浮点数，
// O 表示一个Python对象。b=f(a) 0.1-0.01=0.09

PyTuple_SetItem(pArgs, 0, Py_BuildValue("i",3));
PyTuple_SetItem(pArgs, 1, Py_BuildValue("i",4));

// 调用Python函数
pRetVal = PyObject_CallObject(pFunc, pArgs);
printf("function return value : %d\r\n", PyInt_AsLong(pRetVal));

Py_DECREF(pName);
Py_DECREF(pArgs);
Py_DECREF(pModule);
Py_DECREF(pRetVal);

// 关闭Python
Py_Finalize();
return 0;
}

pytest.py

#Python脚本，存为pytest.py
def add(a,b):
print "in python function add"
print "a = " + str(a)
print "b = " + str(b)
print "ret = " + str(a+b)
return a + b

运行结果如下：

in python function add
a = 3
b = 4
ret = 7
function return value : 7

Python脚本只作为辅助函数，实现一个加法功能，重点分析一下C部分。

void PyInitialize() 在嵌入Python脚本时必须使用该函数，它初始化Python解释器，在使用其他的Python/C API之前必须先调用Py_Initialize函数。

void Finalize() 用来关闭Python解释器，释放解释器所占用的资源。

另外，还要介绍一下PyRun_SimpleString()函数，其原型为int PyRun_SimpleString(const char *command)，用来执行一段Python代码。用法如下:

PyRun_SimpleString("print 'hi,python!'");  /* 运行字符串 *

PyRun_SimpleString("execfile('file.py')"); # 使用execfile运行Python脚本文件

常用的Python/C API函数介绍：

1．数字与字符串处理

在Python/C API中提供了Py_BuildValue()函数对数字和字符串进行转换处理，使之变成Python中相应的数据类型。其函数原型如下所示。

PyObject* Py_BuildValue( const char *format, ...)

其参数含义如下。

• format：格式化字符串，如表8-1所示（见我的另一篇博文《Python的扩展》 /article/11288960.html）。

Py_BuildValue()函数中剩余的参数即要转换的C语言中的整型、浮点型或者字符串等。其返回值为PyObject型的指针。在C语言中，所有的Python类型都被声明为PyObject型。

2．列表操作

在Python/C API中提供了PyList_New()函数用以创建一个新的Python列表。PyList_New()函数的返回值为所创建的列表。其函数原型如下所示。

PyObject* PyList_New( Py_ssize_t len)

其参数含义如下。

• len：所创建列表的长度。

当列表创建以后，可以使用PyList_SetItem()函数向列表中添加项。其函数原型如下所示。

int PyList_SetItem( PyObject *list, Py_ssize_t index, PyObject *item) 其参数含义如下：

• list：要添加项的列表。

• index：所添加项的位置索引。

• item：所添加项的值。

同样，可以使用Python/C API中PyList_GetItem()函数来获取列表中某项的值。PyList_GetItem()函数返回项的值。其函数原型如下所示。

PyObject* PyList_GetItem( PyObject *list, Py_ssize_t index)

其参数含义如下。

• list：要进行操作的列表。

• index：项的位置索引。

Python/C API中提供了与Python中列表操作相对应的函数。例如列表的append方法对应于PyList_Append()函数。列表的sort方法对应于PyList_Sort()函数。列表的reverse方法对应于PyList_Reverse()函数。其函数原型分别如下所示。

int PyList_Append( PyObject *list, PyObject *item)

int PyList_Sort( PyObject *list)

int PyList_Reverse( PyObject *list)

对于PyList_Append()函数，其参数含义如下。

• list：要进行操作的列表。

• item：要参加的项。

对于PyList_Sort()和PyList_Reverse()函数，其参数含义相同。

• list：要进行操作的列表。

3．元组操作

在Python/C API中提供了PyTuple_New()函数，用以创建一个新的Python元组。PyTuple_New()函数返回所创建的元组。其函数原型如下所示。

PyObject* PyTuple_New( Py_ssize_t len)

其参数含义如下。

• len：所创建元组的长度。

当元组创建以后，可以使用PyTuple_SetItem()函数向元组中添加项。其函数原型如下所示。

int PyTuple_SetItem( PyObject *p, Py_ssize_t pos, PyObject *o)

其参数含义如下所示。

• p：所进行操作的元组。

• pos：所添加项的位置索引。

• o：所添加的项值。

可以使用Python/C API中PyTuple_GetItem()函数来获取元组中某项的值。PyTuple_GetItem()函数返回项的值。其函数原型如下所示。

PyObject* PyTuple_GetItem( PyObject *p, Py_ssize_t pos)

其参数含义如下。

• p：要进行操作的元组。

• pos：项的位置索引。

当元组创建以后可以使用_PyTuple_Resize()函数重新调整元组的大小。其函数原型如下所示。

int _PyTuple_Resize( PyObject **p, Py_ssize_t newsize)

其参数含义如下。

• p：指向要进行操作的元组的指针。

• newsize：新元组的大小。

4．字典操作

在Python/C API中提供了PyDict_New()函数用以创建一个新的字典。PyDict_New()函数返回所创建的字典。其函数原型如下所示。

PyObject* PyDict_New()

当字典创建后，可以使用PyDict_SetItem()函数和PyDict_SetItemString()函数向字典中添加项。其函数原型分别如下所示。

int PyDict_SetItem( PyObject *p, PyObject *key, PyObject *val)

int PyDict_SetItemString( PyObject *p, const char *key, PyObject *val)

其参数含义如下。

• p：要进行操作的字典。

• key：添加项的关键字，对于PyDict_SetItem()函数其为PyObject型，对于PyDict_SetItemString()函数其为char型。

• val：添加项的值。

使用Python/C API中的PyDict_GetItem()函数和PyDict_GetItemString()函数来获取字典中某项的值。它们都返回项的值。其函数原型分别如下所示。

PyObject* PyDict_GetItem( PyObject *p, PyObject *key)

PyObject* PyDict_GetItemString( PyObject *p, const char *key)

其参数含义如下。

• p：要进行操作的字典。

• key：添加项的关键字，对于PyDict_GetItem()函数其为PyObject型，对于PyDict_GetItemString()函数其为char型。

使用Python/C API中的PyDict_DelItem()函数和PyDict_DelItemString()函数可以删除字典中的某一项。其函数原型如下所示。

int PyDict_DelItem( PyObject *p, PyObject *key)

int PyDict_DelItemString( PyObject *p, char *key)

其参数含义如下。

• p：要进行操作的字典。

• key：添加项的关键字，对于PyDict_DelItem()函数其为PyObject型，对于PyDict_DelItemString()函数其为char型。

使用Python/C API中的PyDict_Next()函数可以对字典进行遍历。其函数原型如下所示。

int PyDict_Next( PyObject *p, Py_ssize_t *ppos, PyObject **pkey, PyObject **pvalue)

其参数含义如下。

• p：要进行遍历的字典。

• ppos：字典中项的位置，应该被初始化为0。

• pkey：返回字典的关键字。

• pvalue：返回字典的值。

在Python/C API中提供了与Python中字典操作相对应的函数。例如字典的item方法对应于PyDict_Items()函数。字典的keys方法对应于

PyDict_Keys()函数。字典的values方法对应于PyDict_Values()函数。其函数原型分别如下所示。

PyObject* PyDict_Items( PyObject *p)

PyObject* PyDict_Keys( PyObject *p)

PyObject* PyDict_Values( PyObject *p)

其参数含义如下。

• p：要进行操作的字典。

5．释放资源

Python使用引用计数机制对内存进行管理，实现自动垃圾回收。在C/C++中使用Python对象时，应正确地处理引用计数，否则容易导致内存泄漏。在Python/C API中提供了Py_CLEAR()、Py_DECREF()等宏来对引用计数进行操作。

当使用Python/C API中的函数创建列表、元组、字典等后，就在内存中生成了这些对象的引用计数。在对其完成操作后应该使用Py_CLEAR()、

Py_DECREF()等宏来销毁这些对象。其原型分别如下所示。

void Py_CLEAR( PyObject *o)

void Py_DECREF( PyObject *o)

其参数含义如下。

• o：要进行操作的对象。

对于Py_CLEAR()其参数可以为NULL指针，此时，Py_CLEAR()不进行任何操作。而对于Py_DECREF()其参数不能为NULL指针，否则将导致错误。

6．模块与函数

使用Python/C API中的PyImport_Import()函数可以在C程序中导入Python模块。PyImport_Import()函数返回一个模块对象。其函数原型如下所示。

PyObject* PyImport_Import( PyObject *name)

其参数含义如下。

• name：要导入的模块名。

使用Python/C API中的PyObject_CallObject()函数和PyObject_CallFunction()函数，可以在C程序中调用Python中的函数。其参数原型分别如下所示。

PyObject* PyObject_CallObject( PyObject *callable_object, PyObject *args)

PyObject* PyObject_CallFunction( PyObject *callable, char *format, ...)

对于PyObject_CallObject()函数，其参数含义如下。

• callable_object：要调用的函数对象。

• args：元组形式的参数列表。

对于PyObject_CallFunction()函数，其参数含义如下。

• callable_object：要调用的函数对象。

• format：指定参数的类型。

• ...：向函数传递的参数。

使用Python/C API中的PyModule_GetDict()函数可以获得Python模块中的函数列表。PyModule_GetDict()函数返回一个字典。字典中的关键字为函数名，值为函数的调用地址。其函数原型如下所示。

PyObject* PyModule_GetDict( PyObject *module)

其参数含义如下。

• module：已导入的模块对象。