Python与C之间的相互调用（Python C API及Python ctypes库）

分享一下我老师大神的人工智能教程！零基础，通俗易懂！http://blog.csdn.net/jiangjunshow

也欢迎大家转载本篇文章。分享知识，造福人民，实现我们中华民族伟大复兴！

               

write by 九天雁翎(JTianLing) -- blog.csdn.net/vagrxie

讨论新闻组及文件

我实现“onekeycodehighlighter"中碰到的一些小问题，需要实现全局快捷键，但是是事实上Qt并没有对全局快捷键提供支持，那么用Qt的话就只能通过Win32Api来完成了，而我，用的是PyQt，还需要用Python来调用win32 API，事实上，都没有什么难的。

因为Python如此的流行，导致，开源社区按照自己的爱好，对于Python与C之间互相调用上，各自开发了自己想要的调用方式，其中包括用Python C API来完成，包括ctypes这个Python标准库，还有那一大堆的各式各样的绑定方案如SIP,Boost::Python等，要知道，Python流行到什么程序，Boost库号称C++准标准库，唯一对C++以外的一种语言提供了支持，那就是Python，Python还是Symbian除C++,JAVA外支持的第3种语言，当年在原来的公司，我还一直以为Python是个新鲜的小玩意儿，要我鼓捣Python C API的时候很新鲜，（事实上原公司的确没有用Python的人）到了新公司一看，啊~~~公司只允许使用3中语言，C++,JAVA，还有Python，而大家对Python那都是驾轻就熟，信手拈来，常用来开发一些工具及脚本，呵呵，世界原来与我想象的并不同。
这里将以前工作中用到的Python C API知识，及最近用到的ctypes库的知识梳理一下。

Python C API

此部分可以参考我原来的文章《python c api 使用心得...》，这里只是会有一些实际的例子，原来那是一个大概流程的描述。
某年某月，在我开始学习Python古老的岁月中（我不是倚老卖老啊）。。。。ctypes还不存在，那时候我们都是老实的用C语言，调用Python CAPI来完成从Python中调用C语言函数的任务，我学习Python的时候还在想，哈哈哈哈哈，我以前学过C/C++，我可以很熟练的调用Python C API来完成Python调用Win32 API这样的任务，我多了不起啊：）这个时候的感觉就像，嘿，Python你不是了不起吗。。。。还不是没有办法逃离C语言的魔掌。。。。此时，画面中出现的是K&R嘿嘿嘿嘿的冷笑。。。。Guido van Rossum在他们脚下抱着头哭了。。。。。。。
那时候，情况大概是这样的：

准备工作：

闲话少说，看看Python C API。事实上，Python C API比起Lua的API了来说，清晰了很多，这也符合Pythonic的风格，就算这时Python C　API是设计给C语言使用者使用的，还是这样的风格，比起Lua API那种汇编式的接口，（据说为了效率，可以直接操作每个数据）强了太多了。
要使用Python C API，用普通的二进制包是不行的，得下源码包。这里我用3.1.1的源码包为例：Source Distribution
Python的源码在Windows的版本中已经完全换到VS2008了，直接用VS2008打开在PCbuild目录下的工程即可，对于VS2005及以前的用户打开PC目录下的其他版本工程。我们编译debug版本的pythoncore会得到python31_d.lib,python31_d.dll两个文件，需要的头文件在Include目录下，还需要将pyconfig.h文件从PCBuild目录下拷贝到Include中，（硬要直接指定也可以）这样准备工作就已经齐了。

Python C API有两个方向的使用方式，从C中调用Python脚本及利用C扩展Python。
先讲简单的从C中调用Python，也就是常说的在C中内嵌Python。

C中内嵌Python

新建立一个工程，首先需要将工作目录设置到Python-3.1.1PCbuild中，以获取到动态库，至于静态库的包含，Include目录的指定，那自然也是少不了的。文件中需要包含Python.h文件，这也是必须的。
接口中
    Py_Initialize();
    Py_Finalize();
一对的调用是必须的，一个用于初始化Python的动态库，一个用于释放。释放时会输出[31818 refs]，意义不明。

PyRun_SimpleString

可用于执行简单的Python语句。如下：

#include "python.h"

int main(int argc, char* argv[])
{
    Py_Initialize();

    PyRun_SimpleString("print("Hello World")");
    Py_Finalize();

    system("PAUSE");
    return 0;
}

 

此时，输出为：

Hello World
[31829 refs]
请按任意键继续. . .

 

此时可以执行一些Python语句了，并且，特别需要注意的是，在一个Py_Initialize();与Py_Finalize();之间，Python语句执行是在同一个执行环境中，不懂什么意思？看个示例就知道了。

int main(int argc, char* argv[])
{
    Py_Initialize();

    PyRun_SimpleString("str = "Hello World"");
    PyRun_SimpleString("print(str)");

    Py_Finalize();

    system("PAUSE");
    return 0;
}

此例与上例输出是一样的，懂我的意思了吧？意思就是以前执行的语句对后面的语句是有效的，相当于在同一个交互式命令行中顺序执行语句。

获取返回值

PyRun_SimpleString有的缺点，文档中的描述是：

Returns 0 on success or -1 if an exception was raised.

那么你就无法在Python及C语言中传递任何信息。我们需要高级点的函数才行。

 

PyObject* PyRun_String(const char *str, int start, PyObject *globals, PyObject *locals)
就是干这个的。
但是需要注意的是此函数的一些参数的获取，按照想当然的给他们置空可是不行的，如下例所示：

#include "python.h"

int main(int argc, char* argv[])
{
    Py_Initialize();

    PyRun_SimpleString("x = 10");
    PyRun_SimpleString("y = 20");
    PyObject* mainModule = PyImport_ImportModule("__main__");
    PyObject* dict = PyModule_GetDict(mainModule);
    PyObject* resultObject = PyRun_String("x + y", Py_eval_input, dict, dict);

    if(resultObject)
    {
        long result = PyLong_AsLong(resultObject);
        printf("%d", result);
        Py_DECREF(resultObject);
    }

    Py_Finalize();

    system("PAUSE");
    return 0;
}
这里我利用了一个知识，那就是PyRun_SimpleString实际是将所有的代码都放在__main__ 模块中运行，注意啊，没有导入正确的模块及其dict，你会运行失败，失败的很惨。至此，C语言已经于Python来了个交互了。
呵呵，突然觉得深入下去就没有尽头了。。。。。。。还是点到为止吧。
稍微深入点的可以去看《Programming Python》一书。在啄木鸟上有此书及一些译文。Part VI: Integration 部分Chapter 23. Embedding Python，有相关的知识。

利用C扩展Python

此部分在《Programming Python》的Chapter 22. Extending Python 部分有介绍。
这里也只能开个头了，最多告诉你，其实，这些都没有什么难的。稍微复杂点的情况《python c api 使用心得...》一文中有介绍。
配置上与前面讲的类似，一般来说，利用C扩展Python最后会生成一个动态库，不过这个动态库的后缀会设为.pyd，只有这样，import的时候才会自动的查询到。
另外，为Python写扩展要遵循Python的那套规则，固定的几个命名。
首先看自带的例子：

#include "Python.h"

static PyObject *
ex_foo(PyObject *self, PyObject *args)
{
    printf("Hello, worldn");
    Py_INCREF(Py_None);
    return Py_None;
}

static PyMethodDef example_methods[] = {
    { "foo", ex_foo, METH_VARARGS, "foo() doc string"},
    { NULL, NULL}
};

static struct PyModuleDef examplemodule = {
    PyModuleDef_HEAD_INIT,
    "example",
    "example module doc string",
    -1,
    example_methods,
    NULL,
    NULL,
    NULL,
    NULL
};

PyMODINIT_FUNC
PyInit_example(void<