在C/C++中嵌入Python

8.2  在C/C++中嵌入Python

在C/C++中嵌入Python，可以使用Python提供的强大功能，通过嵌入Python可以替代动态链接库形式的接口，这样可以方便地根据需要修改脚本代码，而不用重新编译链接二进制的动态链接库。
8.2.1  高层次嵌入Python

使用Python/C API可以在较高层次上嵌入Python。所谓的高层次嵌入主要是指程序与脚本间没有交互。在VC++ 6.0中新建一个空“Win32 Console Application”，在工程中新建一个C源文件。将如下所示代码添加到其中。

#include <Python.h> int main() { Py_Initialize();        /* Python解释器初始化 */ PyRun_SimpleString("print 'hi,python!'");  /* 运行字符串 */ Py_Finalize();        /* 结束Python解释器，释放资源 */ return 0; }

编译工程，运行程序后输出如下所示。
hi,python!

可以看到程序很简单，只使用了3个函数。其中Py_Initialize函数的原型如下所示。
void Py_Initialize()

在嵌入Python脚本时必须使用该函数，它初始化Python解释器。在使用其他的Python/C API之前必须先调用Py_Initialize函数。其中PyRun_SimpleString函数用来执行一段Python代码。其函数原型如下所示。
int PyRun_SimpleString(const char *command)

在程序的最后使用了Py_Finalize函数，其原型如下所示。
void Py_Finalize()

Py_Finalize函数用于关闭Python解释器，释放解释器所占用的资源。

除了使用PyRun_SimpleString函数以外，还可以使用PyRun_SimpleFile()函数来运行“.py”脚本文件。其函数原型如下所示。
int PyRun_SimpleFile( FILE *fp, const char *filename)

其参数含义如下。
• fp：打开的文件指针。
• filename：要运行的Python脚本文件名。

在Windows下使用该函数时需要注意所使用的编译器版本。由于官方发布的Python是由Visual Studio 2003.NET编译的。如果使用其他版本的编译器，由于版本差异导致FILE的定义有所区别，因此使用其他版本的编译器会导致程序崩溃。

为了简便起见可以使用如下方式来代替PyRun_SimpleFile函数实现同样的功能。
PyRun_SimpleString("execfile('file.py')"); # 使用execfile运行Python脚本文件

 

8.2.2  较低层次嵌入Python

在上一节的例子中只使用简单的函数就完成了在C语言中嵌入Python。但如果需要在C程序中用Python脚本传递参数，或者获得Python脚本的返回值，则要使用更多的函数来编写C程序。由于Python有自己的数据类型，因此在C程序中要使用专门的API对相应的数据类型进行操作。常用的函数有以下几种。

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

其参数含义如下。
• format：格式化字符串，如表8-1所示。
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：已导入的模块对象。

8.2.3  在C中嵌入Python实例

在VC++ 6.0中新建一个名为“EmbPython”的空“Win32 Console Application”工程。向其添加如下所示的“EmbPython.c”文件。

#include <stdio.h> #include <Python.h> int main(int argc, char* argv[]) {  PyObject *modulename, *module, *dic, *func, *args, *rel, *list; char *funcname1 = "sum"; char *funcname2 = "strsplit"; int i; Py_ssize_t s; printf("-==在C中嵌入Python==-/n"); /* Python解释器的初始化*/ Py_Initialize();                      if(!Py_IsInitialized())   {   printf("初始化失败!");   return -1;   } /* 导入Python模块,并检验是否正确导入 */ modulename = Py_BuildValue("s", "pytest");  module = PyImport_Import(modulename);   if(!module)   {   printf("导入pytest失败!");   return  -1;      } /* 获得模块中函数并检验其有效性 */ dic = PyModule_GetDict(module);  if(!dic) { printf("错误!/n"); return -1;   } /* 获得sum函数地址并验证 */ func = PyDict_GetItemString(dic,funcname1);   if(!PyCallable_Check(func))   {   printf("不能找到函数 %s",funcname1);     return -1;   } /* 构建列表 */ list = PyList_New(5); printf("使用Python中的sum函数求解下列数之和/n"); for (i = 0; i < 5; i++) { printf("%d/t",i); PyList_SetItem(list,i,Py_BuildValue("i",i)); } printf("/n"); /* 构建sum函数的参数元组*/ args = PyTuple_New(1); PyTuple_SetItem(args,0,list); /* 调用sum函数 */ PyObject_CallObject(func,args); /* 获得strsplit函数地址并验证*/ func = PyDict_GetItemString(dic,funcname2);   if(!PyCallable_Check(func))   {   printf("不能找到函数 %s",funcname2);     return -1; }   /* 构建strsplit函数的参数元组 */ args = PyTuple_New(2); printf("使用Python中的函数分割以下字符串:/n"); printf("this is an example/n"); PyTuple_SetItem(args,0,Py_BuildValue("s","this is an example"));   PyTuple_SetItem(args,1,Py_BuildValue("s"," "));  /* 调用strsplit函数并获得返回值 */ rel = PyObject_CallObject(func, args);   s = PyList_Size(rel); printf("结果如下所示:/n"); for ( i = 0; i < s; i ++) { printf("%s/n",PyString_AsString(PyList_GetItem(rel,i))); } /* 释放资源 */ Py_DECREF(list); Py_DECREF(args); Py_DECREF(module);  /* 结束Python解释器 */ Py_Finalize();    printf("按回车键退出程序:/n"); getchar();   return 0; }

程序输出如下所示。

-==在C中嵌入Python==-
使用Python中的sum函数求解下列数之和
0       1       2       3       4
Using Function sum
The result is: 10

使用Python中的函数分割以下字符串:
this is an example

结果如下所示:
this
is
an
example

按回车键退出程序: