大致计划如下(测试平台仅限于Windows 和 Linux，编译器限于 MSVC、Mingw及linux gcc)：

  • 传统方式调用 C 模块
  • 用 ctypes 调用C动态库
  • 如有精力和兴趣，简单熟悉一下swig、boost.python, sip, shiboken
  • 用 C 调用 Python

如果只是简单地调用系统调用或c函数，应该考虑使用ctypes。但传统方式更通用，比如C模块中同时要调用python。

简单例子示例代码//hellomodule.c 

#include <Python.h> 
 
 #include <string.h> 
 
 static PyObject * message(PyObject *self, PyObject *args) 
 
 { 
 
 char *src, res[100]; 
 
 if (! PyArg_Parse(args, "(s)", &src)) 
 
 { 
 
 return NULL; 
 
 } 
 
 else 
 
 { 
 
 strcpy(res, "Hello, "); 
 
 strcat(res, src); 
 
 return Py_BuildValue("s", res); 
 
 } 
 
 } 
 
 static struct PyMethodDef methods[] = 
 
 { 
 
 //导出到Python中的名字、函数指针，参数类型，函数描述 
 
 {"message", message, 1, "descript of message"}, 
 
 //结束 
 
 {NULL, NULL, 0, NULL}  
 
 }; 
 
 PyMODINIT_FUNC inithello() 
 
 {  
 
 // 导出的模块名，前面结构数组的指针 
 
 (void) Py_InitModule("hello", methods); 
 
 }

  • 先定义一个函数，函数的参数和返回值都是 PyObject* 类型。(函数内需要将其转成C语言的类型，最后转成PyObject* 类型返回)
  • 定义一个结构数组，包含我们模块内函数的信息
  • __declspec(dllexport)这个东西

编译

  • 用 msvc 编译

cl /LD hellomodule.c /ID:\python26\include /LIBPATH:D:\python26\libs D:\python26\libs\python26.lib /ohello.pyd

  • 用 mingw 编译

gcc hellomodule.c -shared -ID:\Python26\include -LD:\Python26\libs -lpython26 -o hello.pyd

  • linux 下编译

gcc -shared hellomodule.c -I/usr/include/python2.6 -ohello.so -L/usr/lib/python2.6 -lpython2.6

  • 采用distutils方式

前面都是直接调用编译器来生成C模块，有时输这么多命令总是不太方便。幸好，Python 在这方面提供了一个工具。 我们只需要编写一个简单的Python文件：

#setup.py 
 
 from distutils.core import setup, Extension 
 
 example_mod = Extension('hello', sources = ['hellomodule.c']) 
 
 setup(name = "hello", 
 
 version = "1.0", 
 
 description = "A sample extension module", 
 
 ext_modules = [example_mod], #setup()中，只有这行是必须的 
 
 )

然后执行

python setup.py build

即可。

也可以直接执行

python setup.py install

将模块安装到Python路径下

测试运行import hello

print hello.message("OK")

备忘：小插曲，采用msvc编译后，运行时始终找不到 message 函数。最终发现和注释中有中文有关(可能是和unix的换行符结合使用的问题)，细节部分序进一步试验。

重新审视例子

  • #include <Python.h>
  • PyObject* func(PyObject* self, PyObject * args)
  • 结构数组 (包含函数信息)
  • 模块初始化函数 (注册结构数组)

方法函数

一个可由Python解释器调用的函数，可以响应Python程序的调用。C函数接受两个Python对象作为输入，输出一个Python对象返回给解释器作为结果，或者返回NULL在脚本中触发一个异常。

在该函数中，涉及到数据转换，首先需要将 Python 类型编程 C 类型的数据，其次将C类型数据转换成 Python 类型返回。

  • PyArg_Parse 或 PyArg_ParseTuple 或 PyArg_ParseTupleAndKeywords

PyArg_ParseTuple(args, ""); //无参数，调用 f()

PyArg_ParseTuple(args, "s", &s); // 字符串参数，比如调用f('hello')

PyArg_ParseTuple(args, "lls", &k, &l, &s); //f(1, 2, 'three')

PyArg_ParseTuple(args, "(ii)s#", &i, &j, &s, &size);// f((1, 2), 'three')

PyArg_ParseTuple(args, "s|si", &file, &mode, &bufsize);// f('a') f('a', 'w') f('a', 'wb', 100)

  • Py_BuildValue 或 专用的 PyString_FromString一类。

Py_BuildValue("s", "hello") 'hello'

Py_BuildValue("ss", "hello", "world") ('hello', 'world')

Py_BuildValue("s#", "hello", 4) 'hell'

Py_BuildValue("()") ()

Py_BuildValue("(i)", 123) (123,)

Py_BuildValue("(ii)", 123, 456) (123, 456)

Py_BuildValue("(i,i)", 123, 456) (123, 456)

Py_BuildValue("[i,i]", 123, 456) [123, 456]

Py_BuildValue("{s:i,s:i}","abc", 123, "def", 456) {'abc': 123, 'def': 456}

结构数组

将函数名映射为函数指针。名字会成为模块的属性名，Python代码用这个名字来调用C函数。

主要是第三个参数：

  • METH_VARARGS 表示采用C调用约定，必须指定。
  • METH_VARARGS | METH_KEYWORDS 有关键词参数
  • PyArg_ParseTuple()

初始化函数

Py_InitModule读取注册表来建立新模块的属性字典，并在sys.modules表中为该C模块新建了一个表项

错误处理

分两种：

  • C触发的异常，return NULL 即可触发标准的Python异常
  • PyArg_parser返回0)

引用计数

  • Py_INCREF(obj)
  • Py_DECREF(obj)
  • Py_XINCREF(obj)
  • Py_XDECREF(obj)

API函数创建一个新对象并返回给C时，会先增加它们的引用计数。除非一个新对象要回传给Python，创建它的C程序应该要减少它的引用计数。

回调：c中调用Python

  • http://docs.python.org/extending/extending.html#calling-python-functions-from-c

参考

  • http://wiki.woodpecker.org.cn/moin/PP3eD/Ch-22-5
  • http://docs.python.org/extending/extending.html