cython中def,cdef和cpdef的定义

时间:2015-02-06 09:01:22

标签: python declaration cython

当我声明一个函数时,我想知道defcdefcpdef之间的区别。 def和其他人之间的区别或多或少都很明显。 而且我也看到有时它会在声明中添加返回类型(cdef void/double/int... name),有时则不会。

我也想知道如何在cython中声明一个字符串变量,因为我不知道它,我把它声明为对象。

2 个答案:

答案 0 :(得分:15)

关键区别在于可以从以下位置调用函数:def函数可以从Python和Cython调用,而cdef函数可以从Cython和C调用。

两种类型的函数都可以使用任何类型和无类型参数的混合声明,并且在两种情况下,内部都由Cython编译为C(并且编译的代码应该非常非常相似):

# A Cython class for illustrative purposes
cdef class C:
   pass

def f(int arg1, C arg2, arg3):
    # takes an integer, a "C" and an untyped generic python object
    pass

cdef g(int arg1, C arg2, arg3):
    pass

在上面的示例中,f将对Python可见(一旦导入了Cython模块),g将不会被Python调用。 g将转换为C签名:

PyObject* some_name(int, struct __pyx_obj_11name_of_module_C *, PyObject*)

(其中struct __pyx_obj_11name_of_module_C *只是我们的类C被翻译成的C结构)。这允许它作为函数指针传递给C函数。相反,f不能(轻松)从C调用。

cdef功能的限制:

cdef函数无法在其他函数中定义 - 这是因为无法在C函数指针中存储任何捕获的变量。例如。以下代码是非法的:

# WON'T WORK!
def g(a):
   cdef (int b):
      return a+b

cdef函数无法使用*args**kwargs类型参数。这是因为它们不能轻易翻译成C签名。

cdef功能的优势

cdef函数可以采用任何类型的参数,包括那些没有Python等价的参数(例如指针)。 def函数不能包含这些函数,因为它们必须可以从Python调用。

cdef函数也可以指定返回类型(如果未指定,则返回Python对象,C中为PyObject*)。 def函数总是返回一个Python对象,因此不能指定返回类型:

cdef int h(int* a):
    # specify a return type and take a non-Python compatible argument
    return a[0]

cdef函数比def函数更快地调用,因为它们转换为简单的C函数调用。

cpdef函数

cpdef函数使Cython生成cdef函数(允许从Cython快速调用函数)和def函数(允许您从Python调用它)。在def函数中,只调用cdef函数。就允许的参数类型而言,cpdef函数具有cdefdef函数的所有限制。

何时使用cdef功能

调用函数后,cdefdef函数内的代码运行速度没有差异。因此,在以下情况下仅使用cdef函数:

  • 您需要传入或传出非Python类型,或
  • 您需要将其作为函数指针传递给C,或者
  • 您经常调用它(因此加速函数调用非常重要)并且您不需要从Python调用它。

在经常调用它时使用cpdef函数(因此加速函数调用很重要)但是你需要从Python调用它。

答案 1 :(得分:4)

def在Python中声明一个函数。由于Cython基于C运行时,因此您可以使用cdefcpdef

cdef在C语言层声明函数。如您所知(或不是?)在C语言中,您必须为每个函数定义返回值的类型。有时函数返回void,这对于Python中的return来说是相同的。

Python是一种面向对象的语言。因此,您还可以在C ++语言层中定义类方法,并在子类中重写此方法:

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

摘要,为什么我们需要使用defcdefcpdef?因为如果你使用Cython,你的Python代码将在编译之前转换为C代码。因此,通过这些操作,您可以控制生成的C代码列表。

有关详情,建议您阅读官方文档:http://docs.cython.org/src/reference/language_basics.html