介紹Python類型提示及其應用。類型提示可增強代碼可讀性，幫助檢測錯誤，提供更好的IDE支持。通過使用typing模塊，可以擴展Python的類型提示功能，編寫更高質量的代碼。

使用類型提示的原因

Python 的動態類型特質使其與靜態類型語言（如 C/C++ 和 Java）有所不同。靜態類型語言中，我們必須先使用特定類型顯式聲明變量，然后才能為變量賦值。在C/C++/Java 程序運行過程中，變量只能保存預定類型的數據。

然而，Python 作為動態類型語言，始終為我們提供了無需顯式聲明變量類型的靈活性。以下是在 Python 交互式 shell或腳本中可以使用的示例：

# 定義變量
x = 10
print(type(x))  # 輸出: <class 'int'>

# 現在將一個字符串分配給同一個變量
x = "Hello, World!"
print(type(x))  # 輸出: <class 'str'>

# 現在為同一變量指定一個浮點值
x = 3.14
print(type(x))  # 輸出: <class 'float'>

# 現在為同一變量分配一個列表
x = [1, 2, 3]
print(type(x))  # 輸出: <class 'list'>

在上述例子中，x從整數(int)開始，然后變成字符串(str)，接著是浮點數(float)，最后是列表(list)。我們每次使用type()函數打印x的類型。

雖然這種做法具有一定的優點，但是也可能會產生潛在的錯誤和誤解，尤其是在處理大型代碼庫或與團隊協作時。例如：

def add(a, b):
  return a + b


print(add(1, 2))  # 輸出: 3

print(add("Hello, ", "World!"))  # 輸出: Hello, World!

print(add(1, "2"))  # 引發類型錯誤

為了提高代碼的可讀性并防止某些類型的錯誤，Python 3.5 引入了稱為‘類型提示’的可選功能。

Python 類型提示是什么？

類型提示是Python中的一種機制，用于指出函數參數和返回值的預期類型。它們有助于進行靜態類型檢查，可以使用諸如Mypy、Pyright或Pytype等工具進行靜態類型檢查。類型提示不是由Python解釋器本身強制執行的，這意味著它們不會影響程序的實際運行時行為。

以下是一個帶有類型提示的函數示例：

def greet(name: str) -> str:
  return 'Hello, ' + name

在此示例中，name:str是一個類型提示，表明名稱應為字符串，而->str則是一個類型提示，指出函數應返回字符串。

Python 的類型提示可以利用所有標準數據類型，以及從模塊中導入定義的數據類型，以及用戶創建的自定義類型（如示例 1-5 中所示）。這些類型提示可以在各種上下文應用，包括全局變量、函數和方法中的參數，以及這些函數和方法中的局部變量。

類型提示的好處

增強了代碼的可讀性

類型提示使代碼更明確、更易理解。它們標明了函數參數和返回值的類型，從而令函數的使用方式更易理解。

錯誤檢測

您可以使用 Mypy、Pyright 或 Pytype 等工具根據類型提示執行靜態類型檢查。這些工具可以在運行代碼之前捕獲與類型相關的潛在錯誤。例如：

def add(a: int, b: int) -> int:
  return a + b


# 這將引發類型檢查錯誤，因為'2'是字符串，而不是整數。
result = add(1, '2')

更好地支持 IDE

許多 IDE 和編輯器（如 PyCharm 或 Visual Studio Code）可以利用類型提示為您提供更好的代碼補全和其他類型的智能幫助功能。

自我記錄代碼

類型提示能作為 Python 解釋器檢查的一種文檔形式。這有助于使文檔與代碼保持同步。例如：

def connect(host: str, port: int, timeout: float = 1.0) -> Connection:
  """連接到給定的主機和端口。"""
  # 實施

在這個函數簽名中，我們可以觀察到connect函數需要一個字符串類型的主機、一個整數類型的端口和一個可選的浮點數類型的超時（默認為1.0），并會返回一個Connection對象。任何閱讀代碼的人，以及任何理解Python類型提示的工具，都可以使用這些信息。

typing模塊

typing模塊是Python標準庫中相對較新添加的模塊，它通過提供一組特殊的數據類型：列表、元組和字典，來擴展Python的類型提示功能。

其中的每一個都對應于Python內部的一種類型：列表、元組和字典。雖然Python的內置集合可以容納任何類型的項，但typing模塊允許指定集合中包含的項類型，從而提供了更詳細、信息量更大的類型提示。

例如：

>>> list_1: list = ["Tony", 2, 1.5E2, True]
>>> import typing
>>> list_2: typing.List[float] = [10, 2.50, 4.2E-3]

在以上內容中，list_1是一個標準列表，能容納各種類型的元素。另一方面，list_2是typing.List類型的，應僅包含浮點數類型的元素。但是，如果無錯誤地追加了nonfloat類型的對象，則Python運行時會忽略此提示：

>>> l2.append("test")
[10, 2.5, 0.0042, 'test']

typing模塊的主要功能

• 類型提示：為變量和函數參數指定預期類型。
• 泛型類型：用參數定義類型，如List[int]。
• 類型別名：為復雜類型創建別名以提高可讀性。
• 函數重載：定義函數的多種調用方式。
• 類型檢查：靜態類型檢查程序可以使用提示來驗證類型的正確性。

最佳實踐

在Python中，有效地使用typing模塊能極大地增強代碼的可讀性、可維護性和健壯性。以下是利用這一強大功能的一些最佳實踐：

• 從公共接口入手：首先為模塊或類的公共接口添加類型提示，這些接口是代碼的其他部分或外部用戶要使用的函數、方法和類。
• 挑選特定類型：若可能，挑選特定類型，而非通用類型。例如，首選List[int]，別選擇List，或者首選Dict[str，float]，別選Dict。這種獨特性提供了更清晰的對函數預期和返回的指導，因此使靜態類型分析器能更好地進行錯誤檢查。

為復雜類型創建類型別名：對于復雜或頻繁使用的類型，請使用TypeVar和NewType函數創建類型別名。這不僅提升了可讀性，而且使得日后重構或更改類型更方便。

from typing import List, TypeVar

UserId = NewType('UserId', int)
Vector = TypeVar('Vector', List[float], List[int])

• 逐步實行類型提示：Python 的類型系統設計的目標是漸進式的。您不用一次性注釋所有代碼。可以從最關鍵的部分開始，逐步增加覆蓋范圍。在大型現有代碼庫中，這種方法更加可行，因為在這些代碼庫中立即進行全面檢修是不切實際的。
• 對可為 null 的類型使用 Optional：當變量可能為 None 時，顯式將其標記為 Optional。這種做法清楚地說明該變量可以具有 None 值，并強制您在代碼中處理這種情況，因此可以防止看似合理卻可能引起 NoneType錯誤的情況出現。

from typing import Optional


def function(arg: Optional[int]) -> None:
  ...

• 利用類型檢查工具：將 mypy 或 pyright 等工具中的類型檢查納入您的開發工作流程。將這些檢查作為持續集成流程的一部分運行，以便在類型錯誤進入生產環境之前將其捕獲。

總結

本文主要介紹了Python中的類型提示的概念、使用原因以及如何利用其優勢。類型提示可明確代碼意圖、增強代碼可讀性、以及在運行代碼之前捕獲類型相關錯誤。typing模塊則進一步擴展了Python的類型提示功能，可以指定集合中的項類型，從而提供更詳細、更豐富的類型提示。通過有效地使用本文所述技術，可以大大提高代碼的可讀性、可維護性和健壯性。