使用C写Python的模块

1. 概述

Python 可以非常方便地和 C 进行相互的调用。

一般,我们不会使用 C 去直接编写一个 Python 的模块。通常的情景是,我们需要把 C 的相关模块包装一下,然后在 Python 中可以直接调用它。或者是,把 Python 逻辑中的某一效率要求很高的部分使用 C 来实现。整个过程大概是:

  1. 引入 Python.h 头文件。
  2. 编写包装函数。
  3. 函数中处理从 Python 传入的参数。
  4. 实现功能逻辑。
  5. 处理 C 中的返回值,包装成 Python 对象。
  6. 在一个 PyMethodDef 结构体中注册需要的函数。
  7. 在一个初始化方法中注册模块名。
  8. 把这个 C 源文件编译成链接库。
int add(int x, int y){
    return x + y;
}

//int main(void){
//    printf("%d", add(1, 2));
//    return 0;
//}

#include<Python.h>

static PyObject* W_add(PyObject* self, PyObject* args){
    int x;
    int y;
    if(!PyArg_ParseTuple(args, "i|i", &x, &y)){
        return NULL;
    } else {
        return Py_BuildValue("i", add(x, y));
    }
}

static PyMethodDef ExtendMethods[] = {
    {"add", W_add, METH_VARARGS, "a function from C"},
    {NULL, NULL, 0, NULL},
};

PyMODINIT_FUNC initdemo(){
    Py_InitModule("demo", ExtendMethods);
}

2. 引入 Python.h 头文件

这个文件一般位于 Python 的主目录中。比如我的 Ubuntu 10.04 下,它的位置在:

/usr/include/python2.6

在最后编译的时候指定目录就可以了。

3. 编写包装函数

因为 Python 用到的函数与普通的 C 函数,在输入和输出上,会有一些不同,所以,我们需要把普通的 C 做一些封来给 Python 用。

从另一方面来说,在实现功能的过程中,我们可以先完全不考虑这东西是拿给 Python 用的,只专注于使用 C 把它写好就可以了。最后,功能写好,测试没有问题之后,再做 Python 封装的工作。

包装函数一般声明成 static ,并且第一个参数是一个默认传入的 Python 对象,就是 Python 中某个对象的属性方法一样,第二个参数才是我们调用时传入的参数(实际上它是一个序列化后的字符串):

static PyObject* W_add(PyObject* self, PyObject* args);

4. 处理从 Python 传入的参数

因为我们的相关函数,之后是在 Python 环境中被调用的,那么它显然接受的就是从 Python 环境下传入的参数。这和 C 中你看到的函数是不同的,在 Python 的世界中,一切都是对象。所以,包装函数中首先要处理的问题就是解析从 Python 占获取的参数。

常用的函数有: PyArg_ParseTuple

int x;
int y;
PyArg_ParseTuple(args, "i|i", &x, &y);

PyArg_ParseTuple 的作用是解析我们从 Python 中传入的 args 这个字符串,然后以我们规定的格式将解析结果放入指定变量的内存位。

" i|i " 就表示要把传入的东西解析成两个整数,同样,还有 s 表示字符串等。

5. 实现逻辑功能

这部分没什么特别的,只需要在 C 中一样调用函数就可以了,相关变量我们已经在上一步处理过了。

add(x, y);

6. 处理 C 中的返回值

我们使用 C 完成了功能逻辑, C 中会产生一个返回值,要将这个值返回到我们之前调用函数的 Python 环境中,当然还需要经过一些处理才行。

常用的函数是: Py_BuildValue 。

return Py_BuildValue("i", add(x, y));

这个函数的用法和上一步中的 PyArg_ParseTuple 是一样的,它们过程相反。Py_BuildValue 把 C 中的值按给定的格式格式化成 Python 需要的对象。这里注意一下,对于W_add 这个函数,我们可是声明了它的返回类型为 PyObject// 的哦。

7. 注册函数

在上面的实现完成之后,就需要作导出的准备了。第一步,就是要在一个类型为 PyMethodDef的结构体中注册我们需要导出到 Python 中的函数:

static PyMethodDef ExtendMethods[] = {
    {"add", W_add, METH_VARARGS, "a function from C"},
    {NULL, NULL, 0, NULL},
}

这个结构体成员有四个函数:

  1. " add " 导出后在 Pyhton 中可见的方法名。
  2. W_add 实际映射到 C 中的方法名。
  3. METH_VARARGS 表示传入方法的是普通参数,当然还可以处理关键词参数。
  4. 此方法的注释。

8. 注册模块

在注册了方法后,就要注册此模块了。方法是定义一个 init// 的函数:

PyMODINIT_FUNC initdemo(){
    Py_InitModule("demo", ExtendMethods);
}

方法名必须是 init 加上模块名,然后调用 Py_InitModule 来注册模块,这个函数的第一个参数就是模块名,第二个参数是此模块中我们导出的方法,就是上一步我们定义的结构体。

9. 编译

最后一步就是编译了。没什么特别的,指定好 Python.h 头文件的位置就可以了:

gcc demo.c -I /usr/include/python2.6 -shared -o demo.so

当然,链接库的名字要和我们期望导出的模块名一致。

这样,你就可以在 Python 中使用 import 直接引入 demo 模块,然后调用它的 add 方法了:

import demo
demo.add(3, 4)
时间: 2024-08-05 11:54:56

使用C写Python的模块的相关文章

在eclipse上写python,用scapy模块,输出自己构造的报文却只有e?

问题描述 在eclipse上写python,用scapy模块,输出自己构造的报文却只有e? 如图,输出变量a,可是结果为"E"?这是怎么回事?请问怎么解决? 解决方案 http://blog.csdn.net/wang_walfred/article/details/40044141

第九章 Python自定义模块及导入方法

9.1 自定义模块 自定义模块你已经会了,平常写的代码放到一个文件里面就是啦! 例如,写个简单的函数,作为一个模块: #!/usr/bin/python # -*- coding: utf-8 -*- def func(a, b):    return a * b class MyClass:    def __init__(self, a, b):         self.a = a         self.b = b    def method(self):         return

python sys模块sys.path使用方法示例_python

python sys模块包含了与python解释器和它的环境有关的函数,这个你可以通过dir(sys)来查看他里面的方法和成员属性 复制代码 代码如下: import sysprint dir(sys) result: 复制代码 代码如下: ['__displayhook__', '__doc__', '__excepthook__', '__name__', '__package__', '__stderr__', '__stdin__', '__stdout__', '_clear_type

python threading模块线程锁的例子

python threading模块有两类锁:互斥锁(threading.Lock )和可重用锁(threading.RLock).两者的用法基本相同,具体如下: lock = threading.Lock() lock.acquire() dosomething-- lock.release() RLock的用法是将threading.Lock()修改为threading.RLock().便于理解,先来段代码: [root@361way lock]# cat lock1.py #!/usr/b

Python fileinput模块使用介绍_python

fileinput模块提供处理一个或多个文本文件的功能,可以通过使用for循环来读取一个或多个文本文件的所有行.它的工作方式和readlines很类似,不同点在于它不是将全部的行读到列表中而是创建了一个xreadlines对象. 下面是fileinput模块中的常用函数: input() #返回能够用于for循环遍历的对象 filename() #返回当前文件的名称 lineno() #返回当前已经读取的行的数量(或者序号) filelineno() #返回当前读取的行的行号 isfirstli

Python re模块介绍_python

Python中转义字符 正则表达式使用反斜杠" \ "来代表特殊形式或用作转义字符,这里跟Python的语法冲突,因此,Python用" \\\\ "表示正则表达式中的" \ ",因为正则表达式中如果要匹配" \ ",需要用\来转义,变成" \\ ",而Python语法中又需要对字符串中每一个\进行转义,所以就变成了" \\\\ ". 上面的写法是不是觉得很麻烦,为了使正则表达式具有更好

Python常用模块用法分析_python

本文较为详细的讲述了Python中常用的模块,分享给大家便于大家查阅参考之用.具体如下: 1.内置模块(不用import就可以直接使用) 常用内置函数: help(obj) 在线帮助, obj可是任何类型 callable(obj) 查看一个obj是不是可以像函数一样调用 repr(obj) 得到obj的表示字符串,可以利用这个字符串eval重建该对象的一个拷贝 eval_r(str) 表示合法的python表达式,返回这个表达式 dir(obj) 查看obj的name space中可见的nam

Python Configparser模块读取、写入配置文件

写代码中需要用到读取配置,最近在写python,记录一下. 如下,假设有这样的配置. [db] db_host=127.0.0.1 db_port=3306 db_user=root db_pass= [concurrent] thread=200 processor=400 可以使用ConfigParser模块来读取.写入配置. 1 #coding=utf-8 2 import ConfigParser 3 import sys 4 5 cf = ConfigParser.ConfigPars

python sax模块解析xml遇到非法字符怎么解决?

问题描述 python sax模块解析xml遇到非法字符怎么解决? 1C 用python的sax模块解析xml的时候出现非法字符直接停止了,百度搜到有大神说用回调函数处理当前的非法字符或者跳过直接运行接下来的内容.不过具体应该怎么实现呢?求大神赐教.下面是我的代码,非法字符是出现再其中的很多个tagname=""url""中的内容,能在原来的基础上改就更好了,再次感谢 import xml.saxclass XmlHandler( xml.sax.ContentHa