<cython>学习笔记第二章:编译和运行cytho
Cython第二章,编译和运行cython
编译Pipeline
由于cython是python的超集,因此python解释器不能直接解释cython的代码,通过cython compilation pipeline,可以将cython代码转换为python的扩展模块。pipeline分为两阶段:
- cython代码转化为c或c++
- 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