Cython中def,cdef,cpdef的区别

这是我的第一篇翻译，希望大家多多给出意见和建议。
如有转载，请注明出处。
原文来自：https://stackoverflow.com/questions/28362009/definition-of-def-cdef-and-cpdef-in-cython

问题

我想知道在我声明一个函数时def, cdef, cpdef的区别。
def 与其他两种的区别还算大致清晰。可是有时我见到声明时添加了返回值，有时见到的声明却没有添加返回值。

我还想知道在cython中如何声明一个字符串变量，因为我不知道怎么搞，我就按照声明对象的方式做了。

回答0

def 用来在Python中声明一个函数。因为Cython是基于C runtime的，所以允许我们使用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

回答1

最关键的不同在于 where the function can be called from，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可见（一旦它被imported Cython module中。而 g 不可能被call from Python，它将被翻译成C signature：

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

其中的 struct __pyx_obj_11name_of_module_C * 是我们的 class C 翻译成的 C struct。这就允许我们把它传递给 C 函数，比如作为一个函数指针。
相对而言，f 就不能轻易的被C调用了。

cdef 函数的限制

cdef 函数不能在我们的函数内定义。这是因为没有方法可以存储获取变量在C函数指针，如下代码就是不允许的。

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

cdef 函数不能处理 *args *kwargs 类型的变量。这主要是因为它们不能轻易的翻译成 C signature。

cdef 函数的优势

cdef 函数可以接受任何类型的变量，包括哪些Python中没有的类型，比如指针。
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 函数（使得我们可以从Pyhton调用）。就允许的变量类型而言，cpdef 函数具有 cdef 和 def 函数的限制。

什么时候使用 cdef 和 cpdef 函数？

一旦函数被调用，那么 cdef 和 def 函数内部代码的运行速度没有区别。
因此我们仅在以下条件下使用 cdef 函数：

1. 需要传递非Python类型
2. 需要传递它作为一个函数指针到C
3. 需要经常调用（加速函数调用很重要）而且不需要从Python调用

使用 cpdef 函数的条件：

1. 需要经常调用（所以使用加速函数调用很重要）而且需要从Python调用