用Python實現函數參數註解和類型提示

一、概述

參數註解和類型提示是Python中的兩個重要特性。這兩個特性可以幫助我們更好地理解和使用函數，提高代碼的可讀性和維護性。

參數註解是函數定義中的一種特殊的注釋方式，它可以用來說明函數參數的含義和類型等信息。類型提示則是在註解的基礎上，為參數和函數的返回值添加具體的類型信息。這些信息可以在代碼編寫和調試階段起到輔助作用，也有助於其他開發人員閱讀和理解代碼。

Python 3.0引入了參數註解和類型提示的語法支持，使得這兩個特性成為Python編程中的標準做法。

二、參數註解

參數註解可以在函數定義中為參數添加註釋，它的語法如下：

def function_name(arg1: type, arg2: type) -> return_type:
    """Function docstring"""
    # function body

在函數定義中，參數註解放在參數名和冒號之間。如果參數有默認值，註解在默認值之前聲明。註解後面可以緊跟著函數的返回類型聲明，使用箭頭 “→” 符號連接。如果函數沒有返回值，則返回類型聲明可以省略。

參數註解一般不會影響函數的實際執行。它的主要作用是幫助開發人員理解函數的用途和參數類型等信息。下面是一個簡單的示例：

def add(x: int, y: int) -> int:
    return x + y

上述例子中，參數x和參數y都被註解為整型，而返回值被註解為整型。這些註解可以幫助其他開發人員理解該函數的參數和返回值類型，增強代碼的可讀性。

三、類型提示

類型提示是在參數註解的基礎上，使用實際數據類型為參數和返回值添加具體的類型信息。它可以用於代碼編輯器、靜態類型檢查工具和代碼文檔生成工具等場景。

Python 3.5引入了類型提示的語法支持，在函數定義、類定義和變數賦值等場景中，可以使用 “->” 符號聲明變數的數據類型。

下面以函數定義為例，展示類型提示的一個基本用法：

def add(x: int, y: int) -> int:
    return x + y

print(add(1, 2))  # 輸出3
print(add(1.0, 2.0))  # 類型錯誤，會在編譯時報錯

在上述代碼中，我們為參數x和y以及返回結果添加了類型提示int，編譯器在編譯時可以進行靜態類型檢查，保證類型的正確性。如果嘗試將浮點數傳遞給該函數，在編譯時就會產生錯誤。

四、類型提示的高級用法

1. 使用Union

Union可以允許參數接收多個不同類型，語法如下：

from typing import Union

def foo(x: Union[int, float]):
    print(x)

foo(1)    # 輸出1
foo(1.0)  # 輸出1.0
foo("1")  # 類型錯誤，不能把字元串傳遞給Union[int, float]

在上述代碼中，參數x被註解為Union[int, float]，即可以接受整型和浮點型兩種類型。

2. 使用Any

如果函數的參數和返回類型不確定，可以使用Any類型。Any可以接受任何類型的數據，但是不利於靜態類型檢查。

from typing import Any

def foo(x: Any) -> Any:
    return x

print(foo(1))    # 輸出1
print(foo("1"))  # 輸出"1"

3. 使用List和Tuple

List和Tuple分別表示列表和元組，可以在類型提示中進行使用。這兩個類型還可以接受嵌套的類型提示，如下：

from typing import List, Tuple

def foo(x: List[Tuple[str, int]]):
    for item in x:
        name, age = item
        print("Name:", name, "Age:", age)

data = [("Tom", 20), ("Lucy", 25), ("Mike", 30)]
foo(data)

在上面這個示例中，我們定義了一個接受List參數的函數foo，該函數接受一個元素為Tuple[str, int]類型的列表作為輸入。傳遞給該函數的數據必須符合這個約束條件。

五、小結

參數註解和類型提示是Python中的兩個常用特性。它們不僅可以幫助代碼更加規範化，還能提高代碼的可讀性和可維護性。掌握這兩個技術，在代碼編寫和調試過程中能夠提高工作效率，也能讓其他開發人員更好地理解你的代碼。

總的來說，Python的類型註解和提示為Python這個動態語言在類型檢查上提供了一些不錯的選擇。