全面認識 Python 類型註解

一、類型註解是什麼

類型註解，是 Python 的一項靜態類型檢查功能，可以在變量、函數參數和返回值上添加類型標註，增強代碼易讀性，降低程序出錯率。Python 3.5 版本引入了類型註解，但並不影響動態類型的特性，類型註解只是增添了一些靜態特性，進行檢查時需要使用第三方庫，如 Pyright、Mypy 等。

二、類型註解的好處

1. 增強代碼可讀性，一目了然。

2. 捕獲代碼中的類型錯誤，在編碼過程中及時發現錯誤，避免出現運行時錯誤。

3. 為代碼文檔提供了有力的支持，簡化了文檔的撰寫。

三、類型註解的基礎語法

1. 變量標註：

name:str = "PythonDtype"

這句話表示給 name 變量增加了 str 類型的類型標註，即 name 變量應當是一個字符串類型。

2. 函數參數和返回值標註：

def greet(name: str) -> str:
    return f"Hello, {name}"

這段代碼表示 greet 函數的參數 name 應當是一個字符串，返回值也是一個字符串。

3. 註解結構表達式，用於複雜的類型標註：

def get_item(items: Dict[str, Union[int, str]], key: str) -> Union[int, str]:
    return items.get(key)

這裡使用了字典和聯合類型，表示函數 get_item 接受一個鍵值為字符串類型的字典和一個字符串類型的鍵值，返回值為字符串類型或整數類型。

四、類型註解的注意點

1. 類型標註只是註解，僅當第三方靜態類型檢查工具使用時才會起作用。

2. 不能使用類型註解改變變量的類型。

3. 類型註解不支持 None 類型註解，如需使用 None 可以使用 Union：Union[None, int]。

五、類型註解的應用場景

1. 多人協作開發，類型註解有助於解釋變量的含義，降低代碼調試的難度。

2. 代碼審查過程中，有助於檢查代碼中的類型錯誤和邏輯錯誤，提高代碼質量。

3. 當出現錯誤時，類型註解可以快速幫助開發者定位問題。

六、使用 Pyright 進行類型檢查

Pyright 是一個快速的 Python 靜態類型檢查器，可以與主要的 Python 編輯器集成，快速檢查代碼錯誤。使用 Pyright 可以在編碼過程中檢查代碼中的類型錯誤，並及時修正。

安裝 Pyright：

npm install pyright -g

代碼檢查：

pyright [filename]

在不指定文件名時，Pyright 將檢查當前目錄下所有的 Python 文件。

七、結語

了解和掌握類型註解可以讓代碼更加易讀，減少代碼錯誤和調試時間。Pyright 提供了良好的靜態類型檢查工具，可以與多種 Python 編輯器集成，提高編程的效率。