Skip to content

Cython 和 Pyrex 之间的区别

原文: http://docs.cython.org/en/latest/src/userguide/pyrex_differences.html

警告: Cython 和 Pyrex 都在改变目标。到目前这个阶段,两个项目之间所有差异的明确列表已经很难完全列出和跟踪,但仍然希望这个宏观的列表能够让你理解目前的差异。应该注意的是,两个项目都在努力做到相互兼容,但 Cython 的目标是尽可能贴近 Python 并尽可能的像Python一样完整。

Python 3 支持

Cython 创建 .c 文件,可以在 Python 2.x 和 Python 3.x 中构建和使用。实际上,使用 Cython 编译模块很可能是将代码移植到 Python 3 的简单方法。

Cython 还支持 Python 3.0 和后来的主要 Python 版本附带的各种语法添加。如果它们不与现有的 Python 2.x 语法或语义冲突,它们一般来说也能被编译器接受。其他一切都取决于编译器指令 language_level=3(参见 编译器指令)。

List / Set / Dict 推导式

Cython 支持 Python 3 定义的列表、集合和字典的推导式:

[expr(x) for x in A]             # list
{expr(x) for x in A}             # set
{key(x) : value(x) for x in A}   # dict

如果 A 是列表,元组或字典,则这个循环会被优化。您也可以使用 for ... from 语法,但通常最好使用 for ... in range(...) 的语法,并使用一个 C 变量作为循环变量(比如 cdef int i )。

注意:见 自动range转换

请注意,Cython 还支持从 Python 2.4 开始的集合字面量。

仅关键字参数

Python 函数可以在 * 参数之后和 ** 参数之前列出仅限关键字的参数,例如:

def f(a, b, *args, c, d = 42, e, **kwds):
    ...

这里 cde 不能作为位置参数传递,必须作为关键字参数传递。此外,ce 是必需的关键字参数,因为它们没有默认值。

如果省略 * 之后的参数名,则该函数将不接受任何额外的位置参数,例如:

def g(a, b, *, c, d):
    ...

接收两个位置参数,并有两个必需的关键字参数。

条件表达式“x if b else y”

条件表达式正如https://www.python.org/dev/peps/pep-0308/ 中描述的:

X if C else Y

XY 中只有一个会被求值(具体哪个则取决于 C 的值)。

cdef 内联

模块级函数现在可以声明为内联, inline 关键字会被传递给 C 编译器。这些代码可以和宏一样快:

cdef inline int something_fast(int a, int b):
    return a*a + b

请注意,类级 cdef 函数是通过虚函数表处理的,因此几乎在所有情况下编译器都无法内联它们。

声明时赋值(例如“cdef int spam = 5”)

在 Pyrex 中,必须这么写:

cdef int i, j, k
i = 2
j = 5
k = 7

现在,有了 cython,可以这么写:

cdef int i = 2, j = 5, k = 7

右边的表达可以任意复杂,例如:

cdef int n = python_call(foo(x,y), a + b + c) - 32

for 循环中的'by'表达式(例如“for i from 0 <= i < 10 by 2”)

for i from 0 <= i < 10 by 2:
    print i

输出:

0
2
4
6
8

注意:并不鼓励使用此语法,因为它对于普通的 Python for 循环来说是多余的。参见 自动range转换

布尔 int 类型(例如,它的行为类似于 c int,但是作为布尔值与 python转换)

在 C 中,int 用于真值。在 python 中,任何对象都可以用作真值(使用 __nonzero__() 方法),但规范选择是两个布尔对象 TrueFalsebint(用于“boolean int”)类型被编译为 C int,但是作为布尔值与 Python之间强制转换。比较运算的返回类型和几个内置函数也是 bint 。这减少了在 bool()中包装的需要。例如,可以写:

def is_equal(x):
    return x == y

它将在 Pyrex 中返回 10,但在 Cython 中返回 TrueFalse 。可以声明函数的变量和返回值为 bint类型。例如:

cdef int i = x
cdef bint b = x

第一次转换将在 x.__int__() 中进行,而第二次转换在 x.__bool__()(a.k.a。__nonzero__()) 中进行,并对已知的内置类型进行适当的优化。

可执行类主体

包含一个生效的 classmethod()

cdef class Blah:
    def some_method(self):
        print self
    some_method = classmethod(some_method)
    a = 2*3
    print "hi", a

cpdef 函数

Cython 在通常的 defcdef之外添加了第三种函数类型。如果一个函数被声明为 cpdef,它可以被扩展和普通的 python 子类调用和覆盖。您基本上可以将 cpdef 方法视为 cdef 方法 + 一些额外的方法。 (这就是它至少实现的方式。)首先,它创建了一个 def 方法,除了调用底层 cdef 方法之外什么都不做(并且如果需要,可以进行参数解包/强制) )。在 cdef 方法的顶部添加了几行简单的代码以查看它是否被覆盖,类似于以下伪代码:

if hasattr(type(self), '__dict__'):
    foo = self.foo
    if foo is not wrapper_foo:
        return foo(args)
[cdef method body]

要检测类型是否具有字典,它只检查tp_dictoffset插槽,对于扩展类型,它是 NULL(默认情况下),但对于实例类,则为非空。如果字典存在,它会执行单个属性查找,并且可以(通过比较指针)判断返回的结果是否实际上是新函数。如果且仅当它是一个新函数时,则参数被打包到元组和方法中。这一切都非常快。一个标志会被设置用来保证直接在类上调用方法时不会发生此查找,例如:

cdef class A:
    cpdef foo(self):
        pass

x = A()
x.foo()  # 会检查是否被覆盖
A.foo(x) # 无论是否覆盖都会调用A的实现

有关说明和使用提示,请参阅 早期绑定速度

自动range转换

i 是任何 cdef 定义的整数类型时,这将把 for i in range(...) 形式的语句转换为 for i from ...,并且可以确定方向(即步骤的符号)。

警告:如果范围导致赋值给 i 溢出,这可能会改变语义。具体来说,如果设置了此选项,则在进入循环之前将引发错误,而如果没有此选项,循环将执行,直到遇到溢出值。如果这会影响你,请更改 Cython/Compiler/Options.py(最终会有更好的方法来设置它)。

更友好的类型转换

在 Pyrex 中,如果有一个类型 <int>x,其中 x 是一个 Python 对象,那么将获得 x 的内存地址。同样,如果一个类型 <bject>i ,其中 i 是一个 C int,那么将在内存中的 i 位置获得一个 “对象”。这会导致混乱的结果和段错误。

在 Cython <type>x 中,如果其中一个类型是 python 对象,则会尝试强制执行(如将 x 赋值给类型类型的变量时)。没有转换发生时它不会阻止你转换(虽然它会发出警告)。如果你真的想要这个地址,首先要转换为 void *

如在 Pyrex 中 <MyExtensionType>xx 转换为类型 MyExtensionType 而不进行任何类型检查。 Cython 支持使用类型检查进行转换的语法 <MyExtensionType?> (即如果 x 不是 MyExtensionType 的子类,它将抛出错误。

cdef / cpdef 函数中的可选参数

Cython 现在支持 cdefcpdef 的函数使用可选参数。

.pyx 文件中的语法和在 Python 中一样,只要你在 .pxd 文件中用 cdef foo(x=*) 声明这些函数。子类化时参数的数量可能会增加,但参数类型和顺序必须保持不变。在某些情况下,如果没有任何可选参数的 cdef / cpdef 函数被一个具有默认参数值的函数覆盖,则会有轻微的性能损失。

例如,可以这么写 .pxd 文件:

cdef class A:
    cdef foo(self)

cdef class B(A):
    cdef foo(self, x=*)

cdef class C(B):
    cpdef foo(self, x=*, int k=*)

使用相应的 .pyx 文件:

from __future__ import print_function

cdef class A:
    cdef foo(self):
        print("A")

cdef class B(A):
    cdef foo(self, x=None):
        print("B", x)

cdef class C(B):
    cpdef foo(self, x=True, int k=3):
        print("C", x, k)

注意:这也说明了 cpdef 函数是如何覆盖 cdef 函数。

结构中的函数指针

为方便起见, struct 中声明的函数会自动转换为函数指针。

C ++异常处理

cdef 函数现在可以声明为:

cdef int foo(...) except +
cdef int foo(...) except +TypeError
cdef int foo(...) except +python_error_raising_function

在这种情况下,C ++错误被捕获时将引发一个 Python 异常。更详细的文档请参阅在Cython中使用C ++

同义词

cdef import fromcdef extern from 的含义相同

源代码编码

Cython 支持 PEP 3120 PEP 263 ,即你可以从一行表示编码的注释开始写你的Cython源文件(通常用 UTF-8)。这会影响字节字符串的编码以及将u'abcd'等 unicode 字符串文字转换为 unicode 对象。

译者注:即支持类似于 Python 的 # -*- coding: utf-8 -*-

自动 typecheck

isinstance() 第二个参数是扩展类型时,Cython会进行更快速、不可欺骗的检查,而不是像 Pyrex 文档中所解释的那样引入新关键字 typecheck

from __future__ 指令

Cython 支持多种 from __future__ import ... 指令,具体来说是: absolute_importunicode_literalsprint_functiondivision

With 语句总是可用的。

纯 Python 模式

Cython 支持编译 .py 文件,并接收使用装饰器或者其他有效的 Python 语法进行的类型注释。这允许将相同的源文件解释为 Python程序,或者编译以获得优化的结果。有关详细信息,请参阅 纯 Python 模式



回到顶部