什么,听说3分钟入门Cython??

Python的代码优雅而实用,但是它的速度确实不怎样。Cython企图在保留Python美好的同时,兼顾代码的效率,这里先贴出Cython的两个官方文档,以方便大家对Cython更系统的学习:
英文 http://docs.cython.org/en/latest/
中文 https://moonlet.gitbooks.io/cython-document-zh_cn/content/ch1-basic_tutorial.html
为什么最近会和Cython打上交道,说起来是因为我看了一篇名叫 《Cython三分钟入门》 的文章,毫无疑问文章写得很不错,但是标题起得实在不好,因为太标题党啦!
跑通整个项目我花了大概两天时间,尽管代码量并不大。接下来我仍然会以文章中的例子来进行说明,结合这两天的经历,从三个环境出发:1. Windows环境;2. Linux环境;3. Cgywin环境,将我遇到的问题一并讲清楚,希望能帮助到和我有相同问题的同学。

Cython的安装

Cython是一个Python库,理所当然的安装手段就是

    -> pip intsall cython

当然对于Cygwin用户,也能够进入Cygwin安装程序中下载Cython包,效果是一样的,步骤可以参考我的另一篇文章《Cygwin,让你拥有Windows下的Linux环境》。

由于各主机的配置不一样,你测试出来的时间和我不一样很正常,但是这种性能的上升是必定和我一样的!

Python版本

下面是一段Python实现的代码,作用是计算沿地球表面两点之间的距离,是我们的version1。我们会让它调用50万次,并测定它所需的时间:

# version1.py
import math  
def great_circle(lon1,lat1,lon2,lat2):  
    radius = 3956 #miles  
    x = math.pi/180.0  
    a = (90.0-lat1)*(x)  
    b = (90.0-lat2)*(x)  
    theta = (lon2-lon1)*(x)  
    c = math.acos((math.cos(a)*math.cos(b)) +  
              (math.sin(a)*math.sin(b)*math.cos(theta)))  
    return radius*c  

实现以下代码来调用version1::

# efficiency.py
import timeit
lon1,lat1,lon2,lat2=-72.345,34.323,-61.823,54.826
num=500000 #调用50万次
t=timeit.Timer("v1.great_circle(%f,%f,%f,%f)"%(lon1,lat1,lon2,lat2),
               "import version1 as v1")
print('纯python版本用时:'+str(t.timeit(num))+'sec')

好的,我的电脑花了大约3.3s,有点感人。当然我们的时间可能并不一样,但无一例外都不怎么快。

Python+C版本

一定程度上混搭Python和C数据类型,是我们的version2,但要注意,必须是.pyx文件,因为我们需要将其编译为Python拓展,这一步我会在后面仔细讲。我们同样会调用50万次,并测定它所需的时间:

# version2.pyx
import math
def great_circle(float lon1,float lat1,float lon2,float lat2):
    cdef float radius=3956.0
    cdef float pi=3.14159265
    cdef float x=pi/180.0
    cdef float a,b,theta,c
    a=(90.0-lat1)*(x)
    b=(90.0-lat2)*(x)
    theta=(lon2-lon1)*(x)
    c=math.acos((math.cos(a)*math.cos(b) +
            math.sin(a)*math.sin(b)*math.cos(theta)))
    return c*radius  

实现以下代码来调用version2:

# efficiency.py
import timeit
lon1,lat1,lon2,lat2=-72.345,34.323,-61.823,54.826
num=500000 #调用50万次
t=timeit.Timer("v2.great_circle(%f,%f,%f,%f)"%(lon1,lat1,lon2,lat2),
               "import version2 as v2")
print('python+c版本用时:'+str(t.timeit(num))+'sec')

我的电脑花了大约2.2s,与3.3s相比是不是快了不少。相信在你的电脑上也能够看到这么明显的变化。

C版本(Python调用)

我们大致分析一下,version2的瓶颈是在哪里!我们调用的是python的math模块,是不是这里大大地限制了性能?现在我们使用C标准库替代之:

# version3.pyx
cdef extern from "math.h":
    float cosf(float theta)
    float sinf(float theta)
    float acosf(float theta)
def great_circle(float lon1,float lat1,float lon2,float lat2):
    cdef float radius=3956.0
    cdef float pi=3.14159265
    cdef float x=pi/180.0
    cdef float a,b,theta,c
    a=(90-lat1)/(x)
    b=(90-lat2)/(x)
    theta=(lon2-lon1)*(x)
    c=acosf((cosf(a)*cosf(b))+(sinf(a)*sinf(b)*cosf(theta)))
    return radius*c

实现以下代码来调用version3:

# efficiency.py
import timeit
lon1,lat1,lon2,lat2=-72.345,34.323,-61.823,54.826
num=500000 #调用50万次
t=timeit.Timer("v3.great_circle(%f,%f,%f,%f)"%(lon1,lat1,lon2,lat2),
               "import version3 as v3")
print('纯c版本(Python函数调用)用时:'+str(t.timeit(num))+'sec')

0.6s,相当惊人!!这才是我们追求的速度不是吗?

C版本(C调用)

观察上面的代码,容易发现调用50万次这个是循环使用Python实现的。我们知道循环是一个相当耗时的操作,那么如果我们把这个循环放到C代码里,是否能更进一步地提升性能:

# version4.pyx
cdef extern from "math.h":
    float cosf(float theta)
    float sinf(float theta)
    float acosf(float theta)
cdef float _great_circle(float lon1,float lat1,float lon2,float lat2):
    cdef float radius=3956.0
    cdef float pi=3.14159265
    cdef float x=pi/180.0
    cdef float a,b,theta,c
    a=(90-lat1)*(x)
    b=(90-lat2)*(x)
    theta=(lon2-lon1)*(x)
    c=acosf((cosf(a)*cosf(b))+(sinf(a)*sinf(b)*cosf(theta)))
    return radius*c
def great_circle(float lon1,float lat1,float lon2,float lat2,int num):
    cdef int i
    cdef float x
    for i from 0<=i<num:
        x=_great_circle(lon1,lat1,lon2,lat2)
    return x

实现以下代码来调用version4:

# efficiency.py
import timeit
lon1,lat1,lon2,lat2=-72.345,34.323,-61.823,54.826
t=timeit.Timer("v4.great_circle(%f,%f,%f,%f,%i)"%(lon1,lat1,lon2,lat2,num),
           "import version4 as v4")
print('纯c版本(C函数调用)用时:'+str(t.timeit(1))+'sec')

惊喜地发现,我们把性能提升到了0.12s,速度提高了将近30倍,very amazing。
float great_circle(float lon1,float lat1,float lon2,float lat2){ float radius=3956.0; float pi=3.14159265; float x=pi/180.0; float a,b,theta,c; a=(90.0-lat1)*(x); b=(90.0-lat2)*(x); theta=(lon2-lon1)*(x); c=acos((cos(a)*cos(b))+(sin(a)*sin(b)*cos(theta))); return radius*c; int main(){ int i; float x; clock_t start, finish; double Total_time; start = clock(); for(i=0;i<=NUM;i++) x=great_circle(-72.345,34.323,-61.823,54.826); finish = clock(); Total_time = (double)(finish-start) / CLOCKS_PER_SEC; printf("%f sec",Total_time); printf("\n"); printf("%f",x);

当然,如果你有C语言的集成环境,直接运行就能可以得到结果!我们知道Linux系统的gcc组件能够编译C代码,为了方便,我们直接在Linux系统下编译运行,这里我提供两种方式:

->Linux环境下:gcc -lm -octest version5.c
   当前路径生成ctest.exe
->time ./ctest
   测试该模块运行所需时间

对于使用Cygwin来完成这条命令的用户,可能会遇到下面的麻烦,博主也遇到了
<center><font color="red">错误:</font>pyconfig.h No such file or directory</center>
通过网上查阅相关资料,发现这是由于某些组件的缺失造成的,它们可能是下面这些组件:

  • python-devel(对应python2.x)/python3-devel(对应python3.x)
  • libxml2-dev
  • libxslt-dev
    一般来说,主要是python-devel的原因。总之,看情况吧。
  • ->Linux环境下:gcc -o version5 version5.c
       当前路径生成version5.exe
    ->./version5
       测试该模块运行所需时间

    可能由于测试的方式不同,这里用时反而还要长那么一点。但总的来说,Cython能够有效地改善性能。当然,大多数情况下,Python的性能是足够好的,一旦循环、数字运算和Python函数调用上去了,性能就会相应地下降,在这种情况下,我建议你们使用Cython进行优化。

  • 对于Linux系统,编译一下代码能够得到:.pyx->.c->.o->.dll
    这是对应的,因为Windows系统能够使用的Python拓展是.pyd文件,而Linux系统能够使用的Python拓展是.o或.dll文件。但是我们完全不用担心,你的系统总是有选择地去做适合它自己的事情,我们只需要顺水推舟。
  • #setup.py
    # Run as:
    #    python setup.py build   编译
    #    python setup.py install 安装(效果同pip install xxx)
    from distutils.core import setup
    from Cython.Build import cythonize
    #cythonize:编译源代码为C或C++,返回一个distutils Extension对象列表
    setup(ext_modules=cythonize('XXXXX.pyx'))
    

    我们在前文提到的.pyx文件并不能直接作为Python拓展,我们需要编写setup.py来帮助我们获得Python拓展。在'XXXXX.pyx'中填入.pyx文件的路径,然后我们在shell环境下(setup.py的目录下)执行以下命令:
    python setup.py build
    一般来说,我们能在当前目录下看到一个名为build的文件夹,我们需要的Python拓展就在里面!注意执行该命令的python版本要对应。

    执行以下命令:
    python setup.py install
    安装该模块到site-package文件夹下。

    Cython编译中的问题

    我之所以无法像文章所说的那样三分钟入门,就是因为这些乱七八糟的问题,这里我汇总一下我自己遇到的问题,希望后来的人不要像我一样走弯路。原生Linux环境问题不大,会出现问题主要就是Windows系统和Cygwin这种伪Linux环境,我就从这两个环境出发:

    Windows
    Unable to find vcvarsall.bat####

    这时候的我们,一般直接就把这个错误贴到百度或者google上,那么我们会看到一堆关于Windows下Cython安装的教程。
    注意,不要按网上说的,安装MinGW,然后在"..python安装路径...\Lib\distutils"下新建一个distutils.cfg文件,在这文件里面制订编译器为mingw32
    [build]
    compiler=mingw32
    一方面,我的电脑上已经安装了Cygwin,为什么非得另外安装一个MinGW,另一方面MinGW编译出来的东西,安装上了也有不好使的时候,甚至会无法编译;即使编译通过,安装上了,你安装的Python标准库不是由mingw编译的,你的拓展包却是mingw编译的,很难说能够完全兼容或者质量跟得上。(引用自参考文献2)
    但是参考文献2中提到的方法却不是很管用,可能不是很适合我的情况吧。那么要如何解决这个问题?这主要是因为涉及到了比较底层的问题,由于底层上对python支持的不足造成的。参考文献3提出的方法完美地解决了我的问题:
    打开Visual Studio的安装程序进入到下面的界面,选择下面这些组件安装。
    致命错误:Python.h:没有那个文件或目录####

    其实说白了,Cygwin下报错,大多数情况就是想告诉你,你丫的有哪些哪些组件没下载呀呀!!
    是的,只要我们安装python-devel(python2.x)/python3-devel(python3.x),便发现问题迎刃而解啦!
    这几天收获很大,巨开心!
    项目链接: https://github.com/kingboung/Miniproject/tree/master/Cython_accidence

    转载请告知!!博主个人网站:http://www.kingboung.me
    文章有不完善的地方,请留言告知!谢谢我的朋友们。