Python3 類型標註支持操作

Posted on by

typing為Python的一個標註庫，此默認支持PEP 484和PEP 526指定的類型提示。最基本的支持由Any、Union、Tuple、Callable、TypeVar和Generic類型組成。

有關完整的規范，請參閱PEP 484，有關任何類型提示的簡單介紹，請參閱PEP 483。

舉個栗子，函數接收並返回一個字符串，如下所示：

def func(name: str) -> str:
    return "Hello" + name

在函數func中，參數預期是str類型，並且返回str類型

typing模塊的作用：

類型檢查，防止運行時出現參數和返回值類型不符合

作為開發文檔附加說明，方便使用者調用傳入和返回類型

該模塊加入之後並不會影響程序的運行，不會報正式的錯誤，隻有提醒

類型別名

類型別名通過將類型分配別名來進行定義，在這個例子中，Vector和List[str]可以視為可互換的同義詞：

from typing import List
Vector = List[str]
def func(name: str) -> Vector:
    return [name]
print(Vector, type(Vector))         # typing.List[str] <class 'typing.GenericMeta'>
value = func("laozhang")
print(value, type(value))           # ['laozhang'] <class 'list'>

NewType

使用NewType()輔助函數來創建不同的類型

from typing import NewType
UserId = NewType("UserId", int)
UserName = NewType("UserName", str)

靜態類型檢查器會將新類型視為它最原始類型的子類，這對於捕捉邏輯錯誤非常有用：

def from_int_to_str(user_id: UserId) -> str:
    return str(user_id)
    
print(from_int_to_str(UserId(123)))     # 123
print(from_int_to_str(123))             # 123

你仍然可以對UserId類型的變量執行所有的int支持的操作，但結果將始終為int類型，如下：

value = UserId(123) + UserId(456)
print(value)            # 579
print(type(value))      # <class 'int'>

值得註意的是，UserId = NewType(“UserId”, int)，UserId是一個函數，該函數將會立即返回你傳遞給它的任何參數。這也意味著，無法創建UserId的子類型，因為它是運行時的標識函數，而不是實際類型，下面這種寫法是錯誤的：

class MyUser(UserId):
    pass

但是，可以基於UserId創建NewType，如下：

ChildUserId = NewType("ChildUserId", UserId)

Callable

期望特定簽名的回調函數可以將類型標註為Callable[[Arg1Type, Arg2Type], ReturnType]。例如：

from typing import Callable
def finder(on_success: Callable[[str, int], None]) -> None:
    pass  
def on_success(s: str, i: int) -> None:
    pass
finder(on_success=on_success)

如果傳遞過去的回調函數中的參數或返回類型不匹配，PyCharm將會有警告提示

泛型(Generics)

泛型可以使用typing模塊中名為TypeVar的新工廠進行參數化，如下：

from typing import TypeVar
T = TypeVar("T")
def finder(s: T) -> T:
    return s

泛型類型可以有任意數量的類型變量，這樣的話類型變量可能會收到限制：

from typing import TypeVar
T = TypeVar("T", int, str)
def finder(s: T) -> T:
    return s

這樣的話，finder函數將隻能接收int/str類型的參數，否則將會有警告提示

typing模塊常用類型

int,、float: 整形、浮點型

bool、str: 佈爾型、字符串類型

List、Dict、Tuple、Set: 列表、字典、元組、集合

Iterable、Iterator: 可迭代類型、迭代器類型

Generator: 生成器類型

更多關於typing模塊的使用：https://docs.python.org/zh-cn/3.7/library/typing.html

Python 3 新特性:類型註解

前幾天有同學問到，這個寫法是什麼意思：

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

我們知道 Python 是一種動態語言，變量以及函數的參數是不區分類型。因此我們定義函數隻需要這樣寫就可以瞭：

def add(x, y):
    return x + y

這樣的好處是有極大的靈活性，但壞處就是對於別人代碼，無法一眼判斷出參數的類型，IDE 也無法給出正確的提示。

於是 Python 3 提供瞭一個新的特性：

函數註解

也就是文章開頭的這個例子：

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

用 : 類型 的形式指定函數的參數類型，用 -> 類型 的形式指定函數的返回值類型。

然後特別要強調的是，Python 解釋器並不會因為這些註解而提供額外的校驗，沒有任何的類型檢查工作。也就是說，這些類型註解加不加，對你的代碼來說沒有任何影響：

輸出：

但這麼做的好處是：

讓別的程序員看得更明白

讓 IDE 瞭解類型，從而提供更準確的代碼提示、補全和語法檢查（包括類型檢查，可以看到 str 和 float 類型的參數被高亮提示）

在函數的 __annotations__ 屬性中會有你設定的註解：

輸出：

在 Python 3.6 中，又引入瞭對變量類型進行註解的方法：

a: int = 123
b: str = 'hello'

更進一步，如果你需要指明一個全部由整數組成的列表：

from typing import List
l: List[int] = [1, 2, 3]

但同樣，這些僅僅是“註解”，不會對代碼產生任何影響。

不過，你可以通過 mypy 庫來檢驗最終代碼是否符合註解。

安裝 mypy：

pip install mypy

執行代碼：

mypy test.py

如果類型都符合，則不會有任何輸出，否則就會給出類似輸出：

這些新特性也許你並不會在代碼中使用，不過當你在別人的代碼中看到時，請按照對方的約定進行賦值或調用。

當然，也不排除 Python 以後的版本把類型檢查做到解釋器裡，誰知道呢。

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：