Python3 類型標(biāo)注支持操作

typing為Python的一個(gè)標(biāo)注庫，此默認(rèn)支持PEP 484和PEP 526指定的類型提示。最基本的支持由Any、Union、Tuple、Callable、TypeVar和Generic類型組成。

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

舉個(gè)栗子，函數(shù)接收并返回一個(gè)字符串，如下所示：

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

在函數(shù)func中，參數(shù)預(yù)期是str類型，并且返回str類型

typing模塊的作用：

類型檢查，防止運(yùn)行時(shí)出現(xiàn)參數(shù)和返回值類型不符合

作為開發(fā)文檔附加說明，方便使用者調(diào)用傳入和返回類型

該模塊加入之后并不會(huì)影響程序的運(yùn)行，不會(huì)報(bào)正式的錯(cuò)誤，只有提醒

類型別名

類型別名通過將類型分配別名來進(jìn)行定義，在這個(gè)例子中，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()輔助函數(shù)來創(chuàng)建不同的類型

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

靜態(tài)類型檢查器會(huì)將新類型視為它最原始類型的子類，這對于捕捉邏輯錯(cuò)誤非常有用：

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類型的變量執(zhí)行所有的int支持的操作，但結(jié)果將始終為int類型，如下：

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

值得注意的是，UserId = NewType("UserId", int)，UserId是一個(gè)函數(shù)，該函數(shù)將會(huì)立即返回你傳遞給它的任何參數(shù)。這也意味著，無法創(chuàng)建UserId的子類型，因?yàn)樗沁\(yùn)行時(shí)的標(biāo)識(shí)函數(shù)，而不是實(shí)際類型，下面這種寫法是錯(cuò)誤的：

class MyUser(UserId):
    pass

但是，可以基于UserId創(chuàng)建NewType，如下：

ChildUserId = NewType("ChildUserId", UserId)

Callable

期望特定簽名的回調(diào)函數(shù)可以將類型標(biāo)注為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)

如果傳遞過去的回調(diào)函數(shù)中的參數(shù)或返回類型不匹配，PyCharm將會(huì)有警告提示

泛型(Generics)

泛型可以使用typing模塊中名為TypeVar的新工廠進(jìn)行參數(shù)化，如下：

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

泛型類型可以有任意數(shù)量的類型變量，這樣的話類型變量可能會(huì)收到限制：

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

這樣的話，finder函數(shù)將只能接收int/str類型的參數(shù)，否則將會(huì)有警告提示

typing模塊常用類型

int,、float: 整形、浮點(diǎn)型

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

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

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

Generator: 生成器類型

更多關(guān)于typing模塊的使用：https://docs.python.org/zh-cn/3.7/library/typing.html

Python 3 新特性:類型注解

前幾天有同學(xué)問到，這個(gè)寫法是什么意思：

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

我們知道 Python 是一種動(dòng)態(tài)語言，變量以及函數(shù)的參數(shù)是不區(qū)分類型。因此我們定義函數(shù)只需要這樣寫就可以了：

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

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

于是 Python 3 提供了一個(gè)新的特性：

函數(shù)注解

也就是文章開頭的這個(gè)例子：

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

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

然后特別要強(qiáng)調(diào)的是，Python 解釋器并不會(huì)因?yàn)檫@些注解而提供額外的校驗(yàn)，沒有任何的類型檢查工作。也就是說，這些類型注解加不加，對你的代碼來說沒有任何影響：

輸出：

但這么做的好處是：

讓別的程序員看得更明白

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

在函數(shù)的 __annotations__ 屬性中會(huì)有你設(shè)定的注解：

輸出：

在 Python 3.6 中，又引入了對變量類型進(jìn)行注解的方法：

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

更進(jìn)一步，如果你需要指明一個(gè)全部由整數(shù)組成的列表：

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

但同樣，這些僅僅是“注解”，不會(huì)對代碼產(chǎn)生任何影響。

不過，你可以通過 mypy 庫來檢驗(yàn)最終代碼是否符合注解。

安裝 mypy：

pip install mypy

執(zhí)行代碼：

mypy test.py

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

這些新特性也許你并不會(huì)在代碼中使用，不過當(dāng)你在別人的代碼中看到時(shí)，請按照對方的約定進(jìn)行賦值或調(diào)用。

當(dāng)然，也不排除 Python 以后的版本把類型檢查做到解釋器里，誰知道呢。

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。