<cython>学习笔记第二章:编译和运行cython

Cython第二章,编译和运行cython


编译Pipeline

由于cython是python的超集,因此python解释器不能直接解释cython的代码,通过cython compilation pipeline,可以将cython代码转换为python的扩展模块。pipeline分为两阶段:

  1. cython代码转化为c或c++
  2. c/c++代码编译成.so共享库

标准编译路径

python的标准库distutils package用来编译、打包、发布python项目,其中一个功能是将C代码编译成python的扩展模块。也就是编译pipeline中的第二个阶段。第一个阶段则交给cythonize命令。

一个纯cython代码可以使用简单的setup.py脚本编译成为.so动态库,考虑以下cython代码(位置:/examples/02-compiling/distutils/fib.pyx):

def fib(long n):
    '''Returns the nth Fibonacci number.'''
    cdef long a=0, b=1, i
    for i in range(n):
        a, b = a + b, a
    return a

由于是纯cython代码,可以使用以下setup.py进行编译

from distutils.core import setup
from Cython.Build import cythonize
#cythonize:编译源代码为C或C++,返回一个distutils Extension对象列表
setup(ext_modules=cythonize('fib.pyx'))

执行

python setup.py build_ext -i

在同一目录下,得到fib.c build/ 和扩展库fib.so,fib.so是可以通过from fib import fib进行调用的。

使用cython包装纯c代码的编译

在使用cython包装c代码时,编译时,需要指定额外的原文件,例如:

cfib.c

#include "cfib.h"

unsigned long long fib(unsigned long n) {
    unsigned long a=0, b=1, i, tmp;
    for (i=0; i<n; ++i) {
        tmp = a; a = a + b; b = tmp;
    }
    return a;
}

wrap_fib.pyx

cdef extern from "cfib.h":
    unsigned long _fib "fib"(unsigned long n)

def fib(n):
    ''' Returns the nth Fibonacci number.'''
    return _fib(n)

cfib.h略,在这种情况下,使用需要传递给cythonize的内容不能是wrap_fib.pyx,而是将wrap_fib.pyx与源文件cfib.c打包成一个Extension对象,setup.py如下:

from distutils.core import setup, Extension
from Cython.Build import cythonize

# First create an Extension object with the appropriate name and sources
ext = Extension(name="wrap_fib", sources=["cfib.c", "wrap_fib.pyx"])

# Use cythonize on the extension object.
setup(ext_modules=cythonize(ext))

执行

python setup.py build_ext -i

得到wrap_fib.so

如果cfib.c已经是预编译成动态库libfib.so,那么setup.py例子如下:

from distutils.core import setup, Extension
from Cython.Build import cythonize

# First create an Extension object with the appropriate name and sources
ext = Extension(name="wrap_fib", 
    sources=["wrap_fib.pyx"],
    library_dirs=["/path/libfib.so"],
    libraries=["fib"])

# Use cythonize on the extension object.
setup(ext_modules=cythonize(ext))

IPython与Cython的动态编译(%%cython magic)

Ipython的一个扩展功能是能够动态的编译cython代码为python扩展模块,打开这个功能,执行命令%load_ext cythonmagic,然后使用%%cython编写动态的cython代码,例子如下:

%%cython
def fib(int n):
    cdef int i
    cdef double a=0.0,b=1.0
    for i in range(n):
        a,b=a+b,a
    return a

ipython将会把以上的代码在后台进行编译成.so然后导入当前的解释器,我们可以直接调用fib函数。

%%cython 命令可以接受一些参数,--cplus c++代码,-I include,-c 编译参数。

pyximport,import .pyx文件时进行编译

pyximport可以在import一个pyx文件时动态对其进行编译,由于这种方法依赖于cython和gcc,因此不适合应用在生产系统上,例子:

import pyximport
#在import之前调用install命令
pyximport.install()
#import fib.pyx,和import fib.py的感觉一样
import fib

pyimport还能够处理更加复杂的情况,例如,可以处理cython文件中需要引用的别的c、c++头文件,还可以处理cython包含的其他cython文件。我们引入一个.pyxdeps文件来记录这些外部包含关系,将包含所有依赖文件的list,一行一个。pyxdeps文件只能处理代码的依赖性,如何将几个源代码编译和连接成一个python扩展模块,这还需要一个.pyxbld文件,.pyxbld文件中将包含一个或两个函数:

make_ext(modname,pyxfilename)
    接受两个参数,返回一个Extension对象
make_setup_args
    如果定义了,pyximport将额外的参数传递给setup函数

例子(位置/examples/02-compiling/pyximport):

_fic.c略
_fib.h略
fib.pyx

#cfib函数包装了_fib.c中的_cfib函数
cdef extern from "_fib.h":
    unsigned long int _cfib "fib"(unsigned long int)

def cfib(unsigned long int n):
    return _cfib(n)
#使用cython写的fib函数
def fib(long n):
    '''Returns the nth Fibonacci number.'''
    cdef long a=0, b=1, i
    for i in range(n):
        a, b = a + b, a
    return a

fib.pyxbld

def make_ext(modname, pyxfilename):
    from distutils.extension import Extension
    return Extension(modname,
            #告诉distutils把哪些源文件link起来
            sources=[pyxfilename, '_fib.c'],
            #告诉distutils把在哪个路径查找头文件
            include_dirs = ['.'])

# def make_setup_args():
    # return dict(script_args=["--compiler=mingw32"])

执行pyximport就可以导入fib模块中的cfib和fib函数了

手工编译cython

这一节讨论如何手工编译cython代码,就以上一节的_fib.c,_fib.h,fib.pyx为例,fib.pyx中本身包含一个fib函数,同时包含一个包装_fib.c的函数cfib, 例子:

#fib.pyx->fib.c
cython fib.pyx
#CLFAGS\LDFLAGS,编译连接参数
CFLAGS=$(python-config --cflags)
LDFLAGS=$(python-config --ldflags)
#分别编译fib.c和_fib.c为fib.o和_fib.o
gcc -c fib.c ${CFLAGS}
gcc -c _fib.c ${CFLAGS}
#连接
gcc fib.o _fib.o -o fib.so -shared ${LDFLAGS}

得到可调用的fib.so

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,569评论 4 363
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,499评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,271评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,087评论 0 209
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,474评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,670评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,911评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,636评论 0 202
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,397评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,607评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,093评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,418评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,074评论 3 237
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,092评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,865评论 0 196
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,726评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,627评论 2 270

推荐阅读更多精彩内容