Cython 中 def、cdef 和 cpdef 的定义

Question

声明函数时，

def

、

cdef

和

cpdef

有什么区别？

def 和其他之间的区别或多或少是明显的。我还发现有时会在声明中添加返回类型 (

cdef void/double/int... name

)，有时则不会。

如何在 Cython 中声明字符串变量，因为我不知道？我将其声明为对象。

Answer 1

关键区别在于可以从何处调用函数：

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

函数具有

cdef

和

def

函数的所有限制。

何时使用

cdef

功能

一旦调用该函数，

cdef

和

def

函数内的代码运行速度就没有区别。因此，仅在以下情况下使用

cdef

函数：

• 您需要传入或传出非Python类型，或者
• 你需要将它作为函数指针传递给C，或者
• 您经常调用它（因此加速函数调用很重要），并且您不需要从 Python 中调用它。

当您经常调用它时，请使用

cpdef

函数（因此加速函数调用很重要），但您确实需要从 Python 中调用它。

Answer 2

def

在 Python 中声明一个函数。由于 Cython 基于 C 运行时，因此它允许您使用

cdef

和

cpdef

。

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

总结一下，为什么我们需要使用

def

、

cdef

和

cpdef

？因为如果你使用 Cython，你的 Python 代码将在编译之前转换为 C 代码。因此，通过这些东西，您可以控制生成的 C 代码列表。

有关更多信息，我建议您阅读官方文档：http://docs.cython.org/src/reference/language_basics.html