【原】Python/C API使用方法简介 (在C/C++中嵌入Python)

由于Python功能强大并且各种应用程序库十分丰富，它常常可以以一种简单的方式来完成C/C++比较难实现的功能。Python/C API可以使得C/C++程序员在他们的程序中嵌入Python程序，使得开发的灵活性和简易性大大提高。在这里我以python 2.5版本举一个小例子来简单讲述一下Python/C API的用法，如果大家有兴趣可以参见官方文档来深入学习：

http://docs.python.org/c-api/

 

在code之前需要先做一些准备：

1. 把python的include和libs目录分别加到vc的include和lib directories中去。
2. 另外，由于python没有提供debug lib，具体地说，就是没有提供python25_d.lib了,所以默认只能在Release下运行。
3. 可以自己编译python的源代码来得到python25_d.lib。
4. 或者，想要在debug下运行程序的话，你要把pyconfig.h（在python25/include/目录下）的大概是在283行，
5. 把pragma comment(lib,"python25_d.lib")改成pragma comment(lib,"python25.lib")，让python都使用非debug lib.

 

我们需要嵌套的这段Python代码用于遍历目录得到其下的所有文件。将这个.py文件copy到工程目录中。

#-*- coding:gbk -*-

import os,sys

def walk_dir(dirpath,dirfile):
    if not os.path.exists(dirpath) :
        print '%s does not exits, please try again !' %dirpath
        return -1

    dirtuple=[dirs for dirs in os.walk(dirpath)][0]
    #print 'dirtuple is',dirtuple
    root=dirtuple[0]
    #print 'root is',root
    if root[len(root)-1] != os.sep :
        root+=os.sep

    f=file(dirfile,'a')
    for files in dirtuple[2]:
        f.write('%s\n' % (root+files))
        f.flush()   #avoid buffer overflow
    f.close()

    for dirs in dirtuple[1]:
        walk_dir(root+dirs,dirfile)

    return 1

 

下面这段代码中的注释简要介绍了常用的Python/C API

#include <string>
#include <iostream>
#include <Python.h>

//Python c api使用方法

using namespace std;

string GetPyFun(string s1,string s2)
{
    // void Py_Initialize( )
    //初始化Python解释器，在C++程序中使用其它Python/C API之前，必须调用此函数，如果调用失败，将产生一个致命的错误
    Py_Initialize();

    //定义变量
    PyObject * pModule = NULL;
    PyObject * pFunc = NULL;
    PyObject * pArg    = NULL;
    PyObject * result;
    char *resultStr = "";

    //int PyRun_SimpleString( const char *command)
    //直接执行一段Python代码，就好象是在__main__ 函数里面执行一样。
    //PyRun_SimpleString("import sys");
    //PyRun_SimpleString("sys.path.append('C:\\Documents and Settings\\Administrator\\My Documents\\Visual Studio 2005\\Projects\\hello\\hello')");

    //PyObject* PyImport_ImportModule(char *name)
    //导入一个Python模块，参数name可以是*.py文件的文件名。相当于Python内建函数__import__()
    pModule =PyImport_ImportModule("hello");//这里是要调用的文件名

    //PyObject* PyObject_GetAttrString(PyObject *o, char *attr_name)
    //返回模块对象o中的attr_name属性或函数，相当于Python中表达式语句：o.attr_name
    pFunc= PyObject_GetAttrString(pModule, "Hello");

    //PyObject* Py_BuildValue( char *format, ...)
    //format以tuple的形式指定，一个参数就是(i)
    //构建一个参数列表，把C类型转换为Python对象，使Python可以使用C类型数据
    pArg= Py_BuildValue("(s,s)", s1.c_str(),s2.c_str());

    //pParm = PyTuple_New(2);
    //PyTuple_SetItem(pParm, 0, Py_BuildValue("s", csEntity));
    //PyTuple_SetItem(pParm, 1, Py_BuildValue("s", csEntity));

    //PyObject* PyEval_CallObject(PyObject* pfunc, PyObject* pargs)
    //用于调用Python函数
    //此函数接受两个PyObject*形参
    //pfunc是要被调用的Python函数，通常可由PyObject_GetAttrString获得
    //pargs是函数的参数列表，通常可由Py_BuildValue获得
    result = PyEval_CallObject(pFunc, pArg);

    //int PyArg_Parse( PyObject *args, char *format, ...)
    //解构Python数据为C的类型，这样C程序中才可以使用Python里的数据。
    PyArg_Parse(result, "s", &resultStr);

    //关闭Python解释器，释放解释器所占用的资源
    Py_Finalize();
    return resultStr;
}

int Walk(const string& s1,const string& s2)
{
    // void Py_Initialize( )
    //初始化Python解释器，在C++程序中使用其它Python/C API之前，必须调用此函数，如果调用失败，将产生一个致命的错误
    Py_Initialize();

    //定义变量
    PyObject * pModule = NULL;
    PyObject * pFunc = NULL;
    PyObject * pArg    = NULL;
    PyObject * result;
    int reVal = 0;

    //int PyRun_SimpleString( const char *command)
    //直接执行一段Python代码，就好象是在__main__ 函数里面执行一样。
    //PyRun_SimpleString("import sys");
    //PyRun_SimpleString("sys.path.append('C:\\Documents and Settings\\Administrator\\My Documents\\Visual Studio 2005\\Projects\\hello\\hello')");

    //PyObject* PyImport_ImportModule(char *name)
    //导入一个Python模块，参数name可以是*.py文件的文件名。相当于Python内建函数__import__()
    pModule =PyImport_ImportModule("walkdir");//这里是要调用的文件名

    //PyObject* PyObject_GetAttrString(PyObject *o, char *attr_name)
    //返回模块对象o中的attr_name属性或函数，相当于Python中表达式语句：o.attr_name
    pFunc= PyObject_GetAttrString(pModule, "list_dir");

    //PyObject* Py_BuildValue( char *format, ...)
    //format以tuple的形式指定，一个参数就是(i)
    //构建一个参数列表，把C类型转换为Python对象，使Python可以使用C类型数据
    pArg= Py_BuildValue("(s,s)", s1.c_str(),s2.c_str());

    //pParm = PyTuple_New(2);
    //PyTuple_SetItem(pParm, 0, Py_BuildValue("s", csEntity));
    //PyTuple_SetItem(pParm, 1, Py_BuildValue("s", csEntity));

    //PyObject* PyEval_CallObject(PyObject* pfunc, PyObject* pargs)
    //用于调用Python函数
    //此函数接受两个PyObject*形参
    //pfunc是要被调用的Python函数，通常可由PyObject_GetAttrString获得
    //pargs是函数的参数列表，通常可由Py_BuildValue获得
    result = PyEval_CallObject(pFunc, pArg);

    //int PyArg_Parse( PyObject *args, char *format, ...)
    //解构Python数据为C的类型，这样C程序中才可以使用Python里的数据。
    PyArg_Parse(result, "i", &reVal);

    //关闭Python解释器，释放解释器所占用的资源
    Py_Finalize();
    return reVal;
}

int main()
{
    //string re=GetPyFun("hello","world");
    //cout<<"\n"<<re<<endl;

    cout<<"enter a path and a filename:"<<endl;
    string path,dir;
    cin>>path>>dir;
    int re=Walk(path,dir);

    return 0;
}