Cython全教程2 多種定義方式

—— 本篇文章，主要講述Cython中的四種定義關鍵字

全教程2 多種定義方式：

? ? ? ? 在Cython中，關于定義的關鍵字有四個，分別是：

? ? ? ? cdef、def、cpdef、DEF

一、cdef定義關鍵字

? ? ? ? 顧名思義，cdef關鍵字定義的是一個C函數/方法（CFunction），也用來定義C變量；

????????定義的東西只能在Cython里調用而在Python里無法訪問到。

? ? ? ? 我相信，理解以下案例，即可掌握（注意看代碼旁的注釋）

? ? ? ? （1）正確案例：

#cython: language_level=3
# -*- coding: UTF-8 -*-
# -*- file: test.pyx -*-###在Cython里： 可以單個定義變量/函數
cdef int cint_value1 = 66, cint_value2 = 88 #定義了兩個int變量
cdef float cfloat_value = 10.0              #定義了一個float變量
cdef float *h = &cfloat_value               #定義了一個float指針變量cdef int* cint_list = [1, 2, 3]            #定義數組①：使用指針聲明數組
cdef float[3] float_list1 = [1.0, 2.0]     #定義數組②：使用類Java聲明數組
cdef list[3] float_list2 = [6.0, 7.0, 8.0] #定義數組③：使用python列表
cdef double double_list[2] = [12.2, 13.3]  #定義數組④：使用類C聲明數組，不推薦cdef dict[int, str] dt = {}           #定義了一個字典,鍵為int,值為str。或者直接用dict也行cdef tuple tp = (1, 2, 3)
cdef tuple[3] tp = (1, 2, 3)
cdef tuple[int, int, int] _tp = (1, 2, 3)
cdef (int, int, int) __tp = (1, 2, 3) #上中下4種定義元組的方式都可以cdef tuple[list[3], dict[str, list[2]]] complex_tp  #定義復雜的也可以cdef void say_hello() noexcept: #聲明這個函數里沒有拋出錯誤print("Hello, Cython!")cdef int set_value(int* value) except *: #聲明這個函數里拋出了錯誤if value == NULL:                    #在C函數參數列表里無需使用cdefraise Exception("野指針！")value[0] = 100return value[0]    #Cython里指針只能用下標表示cdef void say_more_hello() noexcept:cdef int _for _ in range(10):say_hello() #調用say_hello()函數###或者一次性大量定義
cdef:double d_value = 0.0 #double型bint is_ok = 1       #1/0，類似于bool型（其實就是bool型）unsigned int u_int = 0signed int s_int = -1void is_ok_say():print("我學會了" if is_ok else "我再想想")#定義了一個C++類
cdef class CppClass(object):cdef:int cppclassdef __cinit__(CppClass self) -> None: #注意1：__cinit__其實就是__init__self.cppclass = 100               #注意2：self最好也寫上類型#注意3：Magic Method只能用def而不能用cdefcdef int get_cppclass(CppClass self) noexcept:return self.cppclasscdef object cppclass_plus1(CppClass self) noexcept: #C函數里也可以使用閉包cdef void inter_func():self.cppclass += 1return inter_func@staticmethodcdef void hello() noexcept:say_more_hello()@staticmethodcdef (int, int, int) get_tp() noexcept:return _tp

? ? ? ? 結合以上，注意：

? ? ? ? ①：在C++類（cdef class）里，聲明對象屬性只能在類體里，也就是在cdef int cppclass那里，并且不能直接在聲明的時候賦值（不能有默認值）。

? ? ? ? ②：在C++類（cdef class）里，魔法方法（特殊方法）不能使用cdef，只能使用def。

? ? ? ? ③：在C++類（cdef class）里，__cinit__方法類似于__init__方法，都屬于初始化方法。但不同的是，__cinit__適合于給對象屬性賦值，__init__適合調用函數/方法；__cinit__先于__init__執行（它們可以同時存在）。

? ? ? ? ④：定義的C變量/屬性，能用的類型不外乎于（int, float, bint, list, dict, tuple, 自己定義的C類型, Cython自帶的C類型），對于其他的類型，只能用object來聲明。

? ? ? ? ⑤：在C++類（cdef class）里，C++類的父類只能是C++類或object類或Exception類，C++類不允許繼承Py類。

? ? ? ? ⑥：對于C++類（cdef class），可以直接被Python訪問到，但其里面的C函數不能被訪問到。

? ? ? ??（2）以下的是錯誤實例：

#cython: language_level=3
# -*- coding: UTF-8 -*-
# -*- file: test.pyx -*-cdef void* printf = print           #錯誤！只能用object來聲明指針函數，或者說，Py函數只能用object接受，C函數可以用指針函數接受
cdef tuple[int] tp1 = (1, 2, 3)     #錯誤！聲明的元組里面只能有一個int，即tuple[int]<->tuple[1]
cdef tuple tp2 = (1, 2, 3, 4, 5)    #正確！這樣的話可以
cdef tuple[5] tp3 = (1, 2, 3, 4, 5) #正確！這樣的話也可以from abc import ABC
cdef class CppClass(ABC): #錯誤！ABC為Py類，C++類只能僅能繼承C++類/object/Exceptioncdef __cinit__(CppClass self) noexcept: #錯誤！特殊方法只能是def定義self.cppclass = 100 #錯誤！必須先在類體內定義才能當作對象屬性使用def __repr__(CppClass self) -> str: #正確！特殊方法只能是def定義return ""

?（3）來個語境實例：

#cython: language_level=3
# -*- coding: UTF-8 -*-
# -*- file: test.pyx -*-#假設在D:/Test/test.pyx
cdef void say_hello() noexcept:print("Hello, Cython!")cdef class CppClass(object):def __cinit__(CppClass self) -> None:passcdef void say_more_hello1(CppClass self) noexcept:cdef int _for _ in range(10):say_hello()def say_more_hello2(CppClass self) -> None:cdef int _for _ in range(10):say_hello()#假設現在編譯了，在D:/Test/main.py
from test import *say_hello() #報錯！cdef定義的C函數只能在Cython里使用cpp: CppClass = CppClass() #允許！C++類直接可以在Python里使用cpp.say_more_hello1() #錯誤！cdef定義的C函數只能在Cython里使用，在Python里訪問不到
cpp.say_more_hello2() #正確！def定義的Py函數可以使用，可以訪問到

?（4）再舉個實際的實例：

#cython: language_level=3
# -*- coding: UTF-8 -*-
# -*- file: test.pyx -*-import pygame
import tkintercdef class PygameRun(object):cdef object screen  #注意看此處，Py類聲明的對象只能用object!cdef PygameRun run  #PgameRun是C++類，就是C類型,當然可以不用object了def __cinit__(PygameRun self) -> None:pygame.init()self.screen = pygame.display.set_mode((100, 100), RESIZABLE|SCALED, vsync=1)self.run = self...cdef object get_image(PygameRun self, str file) noexcept: #注意看此處，Py類聲明的對象只能用object!return pygame.image.load(file).convert_alpha()cdef PygameRun get_pygamerun(PygameRun self) noexcept: #PygameRun是C++類，就是C類型return self.runcdef object get_pygamescreen(PygameRun self) noexcept: #Py類聲明的對象就只能用object了return self.screencdef class TkinterRun(tkinter.Tk): #錯誤！C++類不能繼承Py類！pass

二、def定義關鍵字

? ? ? ? 就如在Python類似，def關鍵字是定義一個函數/方法（PyFunction），只不過在Cython里應該說為“定義一個Py函數/方法”。Py函數可以被Python調用，當然也能被Cython所調用。

????????但需要注意以下操作：

? ? ? ? ①：Py函數里不能完成非Py函數的定義，也就是不能完成非Py函數的閉包。

? ? ? ? ②：Py函數的參數列表不能出現指針類型。

? ? ? ? ?：其實整個項目里幾乎不怎么會出現Py函數，因為各個功能都是C函數實現的。可以說，在整個項目里，唯一的一個Py函數就是最后的主函數，以此匯總各個C類型C對象，來供Python調用。

????????（1）正確案例：

#cython: language_level=3
# -*- coding: UTF-8 -*-
# -*- file: test.pyx -*-#假設在test.pyx
from typing import Anycdef class MyClass(object):cdef bint myclasscdef bint say_hello() noexcept:print("Hello, Cython!", end = ' ')return 1def main(*args: tuple, **kwargs: dict) -> Any:cdef MyClass my = MyClass()my.myclass = say_hello()return my#經過編譯后：在test0.py
from test import *print(main().myclass) #最后輸出 Hello, Cython 1

?????????（2）錯誤實例：

#cython: language_level=3
# -*- coding: UTF-8 -*-
# -*- file: test.pyx -*-cdef object CFunction1() noexcept:  #正確！cdef void inter() noexcept:print("This is CFuntion1's inter")return intercdef object CFunction2() noexcept:  #正確！def void inter() -> None:print("This is CFuntion2's inter")return interdef PyFunction1() -> object:  #正確！def inter() -> None:print("This is PyFuntion1's inter")return interdef PyFunction2() -> object:  #錯誤！cdef void inter() noexcept:print("This is PyFuntion2's inter")return inter

三、cpdef定義關鍵字

?????????顧名思義，cpdef關鍵字定義的是一個CP函數/方法（CpFunction），即既能被Cython調用又能被Python函數調用的函數。

? ? ? ? 雖然它叫CpFunction，其實它的規則就和CFunction類似。

? ? ? ? 一般什么時候使用呢？就是一個函數，又需要在Python里使用，又需要在Cython里使用，那么它就可以派上用場了。。使用條件比較苛刻，也不利于性能。

? ? ? ? 注意：

? ? ? ? ①：cpdef聲明的函數都是CpFunction。

? ? ? ? ②：將其修飾class則聲明成CFunction。

????????就現階段，我們僅僅需要知道如此就可以了，它用的不是很多。

四、DEF定義關鍵字：

? ? ? ? DEF關鍵字，一開始我遇到的時候是我在定義一個屬性叫DEF（防御力）的時候，結果說什么也不讓我命名，我一看好家伙都高亮了，結果發現還有這個關鍵字。

? ? ? ? 其實，這就類似于C語言里的預處理（宏），就是#define預處理語句。

? ? ? ? 值得注意的是：

? ? ? ? ①：類似于C語言的#define語句，不需要寫類型，在編譯的時候會替換。

? ? ? ? ②：但也不如C語言的，因為僅僅只能定義基本的數據（str/ int/ float/ bytes）。

? ? ? ? 當然還有其他的預處理指令比如IF/ ELSE，這些以后我會出專門的章節來講解的。

? ? ? ? 最后這些常量會被歸為Literal類型。?

五、編譯步驟

? ? ? ? ①：先編寫源文件.pyx：創建Test.pyx

# cython language_level=3
# -*- coding: utf-8  -*-
# -*- file: Test.pyx -*-
# -*- CSDN: Daisy-Mo -*-
# -*- Git:  Rosysuki -*-cdef class Steps(object):cdef Steps say1(Steps self) noexcept:print("先編寫源文件")return selfcdef Steps say2(Steps self) noexcept:print("再編譯文件")return selfcdef Steps say3(Steps self) noexcept:print("最后調用擴展")return selfdef main(*args: tuple, **kwargs: dict) -> None:cdef Steps steps = Steps()(steps.say1().say2().say3())

? ? ? ? ②：再編寫setup.py文件：?

# -*- coding: utf-8  -*-
# -*- file: setup.py -*-from setuptools import setup
from Cython.Build import cythonizesetup(ext_modules = cythonize(["Test.pyx"])
)