Python標(biāo)準(zhǔn)庫(kù)之typing的用法(類型標(biāo)注)
PEP 3107引入了功能注釋的語(yǔ)法,PEP 484 加入了類型檢查
標(biāo)準(zhǔn)庫(kù) typing 為類型提示指定的運(yùn)行時(shí)提供支持。
示例:
def f(a: str, b:int) -> str: return a * b
如果實(shí)參不是預(yù)期的類型:
但是,Python運(yùn)行時(shí)不強(qiáng)制執(zhí)行函數(shù)和變量類型注釋。使用類型檢查器,IDE,lint等才能幫助代碼進(jìn)行強(qiáng)制類型檢查。
使用NewType 創(chuàng)建類型NewType() 是一個(gè)輔助函數(shù),用于向類型檢查器指示不同的類型,在運(yùn)行時(shí),它返回一個(gè)函數(shù),該函數(shù)返回其參數(shù)。
import typingId = typing.NewType('Id', int)a = Id(2020)
使用 NewType() 創(chuàng)建的類型會(huì)被類型檢查器視為它的原始類型的子類。
回調(diào)(Callable)將回調(diào)函數(shù)類型標(biāo)注為 Callable[[Arg1Type, Arg2Type], ReturnType]。
from typing import Callabledef f(a: int) -> str: return str(a)def callback(a: int, func: Callable[[int], str]) -> str: return func(a)print(callback(1, f))泛型
為容器元素添加預(yù)期的類型
from typing import Mappinga: Mapping[str, str]
通過(guò) TypeVar 進(jìn)行參數(shù)化來(lái)約束一個(gè)類型集合:
from typing import TypeVarT = TypeVar(’T’) # 可以是任何東西。A = TypeVar(’A’, str, bytes) # 必須是 str 或 bytes
使用 TypeVar 約束一個(gè)類型集合,但不允許單個(gè)約束
例如:
T = TypeVar(’T’, str)
這樣會(huì)拋出一個(gè)異常 TypeError: A single constraint is not allowed
typing 包含的類型AbstractSet = typing.AbstractSetAny = typing.AnyAnyStr = ~AnyStrAsyncContextManager = typing.AbstractAsyncContextManagerAsyncGenerator = typing.AsyncGeneratorAsyncIterable = typing.AsyncIterableAsyncIterator = typing.AsyncIteratorAwaitable = typing.AwaitableByteString = typing.ByteStringCallable = typing.CallableClassVar = typing.ClassVarCollection = typing.CollectionContainer = typing.ContainerContextManager = typing.AbstractContextManagerCoroutine = typing.CoroutineCounter = typing.CounterDefaultDict = typing.DefaultDictDeque = typing.DequeDict = typing.DictFrozenSet = typing.FrozenSetGenerator = typing.GeneratorHashable = typing.HashableItemsView = typing.ItemsViewIterable = typing.IterableIterator = typing.IteratorKeysView = typing.KeysViewList = typing.ListMapping = typing.MappingMappingView = typing.MappingViewMutableMapping = typing.MutableMappingMutableSequence = typing.MutableSequenceMutableSet = typing.MutableSetNoReturn = typing.NoReturnOptional = typing.OptionalReversible = typing.ReversibleSequence = typing.SequenceSet = typing.SetSized = typing.SizedTYPE_CHECKING = FalseTuple = typing.TupleType = typing.TypeUnion = typing.UnionValuesView = typing.ValuesViewtyping-python用于類型注解的庫(kù)簡(jiǎn)介
動(dòng)態(tài)語(yǔ)言的靈活性使其在做一些工具,腳本時(shí)非常方便,但是同時(shí)也給大型項(xiàng)目的開(kāi)發(fā)帶來(lái)了一些麻煩。
自python3.5開(kāi)始,PEP484為python引入了類型注解(type hints),雖然在pep3107定義了函數(shù)注釋(function annotation)的語(yǔ)法,但仍然故意留下了一些未定義的行為.現(xiàn)在已經(jīng)擁有許多對(duì)于靜態(tài)類型的分析的第三方工具,而pep484引入了一個(gè)模塊來(lái)提供這些工具,同時(shí)還規(guī)定一些不能使用注釋(annoation)的情況
#一個(gè)典型的函數(shù)注釋例子,為參數(shù)加上了類型def greeting(name: str) -> str: return ’Hello ’ + name
伴隨著python3.6的pep526則更進(jìn)一步引入了對(duì)變量類型的聲明,和在以前我們只能在注釋中對(duì)變量的類型進(jìn)行說(shuō)明
# 使用注釋來(lái)標(biāo)明變量類型primes = [] # type:list[int]captain = ... #type:strclass Starship: stats = {} #type:Dict[str,int]primes:List[int] = []captain:str #Note: no initial valueclass Starship: stats: ClassVar[Dict[str,int]] = {}typing--對(duì)于type hints支持的標(biāo)準(zhǔn)庫(kù)
typing模塊已經(jīng)被加入標(biāo)準(zhǔn)庫(kù)的provisional basis中,新的特性可能會(huì)增加,如果開(kāi)發(fā)者認(rèn)為有必要,api也可能會(huì)發(fā)生改變,即不保證向后兼容性
我們已經(jīng)在簡(jiǎn)介中介紹過(guò)類型注解,那么除了默認(rèn)類型的int、str用于類型注解的類型有哪些呢?
typing庫(kù)便是一個(gè)幫助我們實(shí)現(xiàn)類型注解的庫(kù)
類型別名(type alias)
在下面這個(gè)例子中,Vector和List[float]可以視為同義詞
from typing import ListVector = List[float]def scale(scalar: float, vector: Vector)->Vector: return [scalar*num for num in vector]new_vector = scale(2.0, [1.0, -4.2, 5.4])
類型別名有助于簡(jiǎn)化一些復(fù)雜的類型聲明
from typing import Dict, Tuple, ListConnectionOptions = Dict[str, str]Address = Tuple[str, int]Server = Tuple[Address, ConnectionOptions]def broadcast_message(message: str, servers: List[Server]) -> None: ...# The static type checker will treat the previous type signature as# being exactly equivalent to this one.def broadcast_message(message: str,servers: List[Tuple[Tuple[str, int], Dict[str, str]]]) -> None: pass
新類型(New Type)
使用NewType來(lái)輔助函數(shù)創(chuàng)造不同的類型
form typing import NewTypeUserId = NewType('UserId', int)some_id = UserId(524313)
靜態(tài)類型檢查器將將新類型視為原始類型的子類。這對(duì)于幫助捕獲邏輯錯(cuò)誤非常有用
def get_user_name(user_id: UserId) -> str: pass# typechecksuser_a = get_user_name(UserId(42351))# does not typecheck; an int is not a UserIduser_b = get_user_name(-1)
你仍然可以使用int類型變量的所有操作來(lái)使用UserId類型的變量,但結(jié)果返回的都是都是int類型。例如
# output仍然是int類型而不是UserId類型output = UserId(23413) + UserId(54341)
雖然這無(wú)法阻止你使用int類型代替UserId類型,但可以避免你濫用UserId類型
注意,這些檢查僅僅被靜態(tài)檢查器強(qiáng)制檢查,在運(yùn)行時(shí)Derived = NewType(’Derived’,base)將派生出一個(gè)函數(shù)直接返回你傳的任何參數(shù),這意味著Derived(some_value)并不會(huì)創(chuàng)建任何新類或者創(chuàng)建任何消耗大于普通函數(shù)調(diào)用消耗的函數(shù)
確切地說(shuō),這個(gè)表達(dá)式 some_value is Derived(some_value) 在運(yùn)行時(shí)總是對(duì)的。
這也意味著不可能創(chuàng)建派生的子類型,因?yàn)樗谶\(yùn)行時(shí)是一個(gè)標(biāo)識(shí)函數(shù),而不是一個(gè)實(shí)際類型:
from typing import NewTypeUserId = NewType(’UserId’, int)# Fails at runtime and does not typecheckclass AdminUserId(UserId): pass
然而,它可以創(chuàng)建一個(gè)新的類型基于衍生的NewType
from typing import NewTypeUserId = NewType(’UserId’, int)ProUserId = NewType(’ProUserId’, UserId)
然后對(duì)于ProUserId的類型檢查會(huì)如預(yù)料般工作
Note:回想一下,使用類型別名聲明的兩個(gè)類型是完全一樣的,令Doing = Original將會(huì)使靜態(tài)類型檢查時(shí)把Alias等同于Original,這個(gè)結(jié)論能夠幫助你簡(jiǎn)化復(fù)雜的類型聲明
與Alias不同,NewType聲明了另一個(gè)的子類,令Derived = NewType(’Derived’, Original)將會(huì)使靜態(tài)類型檢查把Derived看做Original的子類,這意味著類型Original不能用于類型Derived,這有助于使用最小的消耗來(lái)防止邏輯錯(cuò)誤。
回調(diào)(callable)
回調(diào)函數(shù)可以使用類似Callable[[Arg1Type, Arg2Type],ReturnType]的類型注釋
例如
from typing import Callabledef feeder(get_next_item: Callable[[], str]) -> None: # Bodydef async_query(on_success: Callable[[int], None],on_error: Callable[[int, Exception], None]) -> None: # Body
可以通過(guò)對(duì)類型提示中的參數(shù)列表替換一個(gè)文本省略號(hào)來(lái)聲明一個(gè)可調(diào)用的返回類型,而不指定調(diào)用參數(shù),例如 Callable[..., ReturnType]
泛型(Generics)
因?yàn)槿萜髦械脑氐念愋托畔⒂捎诜盒筒煌ㄟ^(guò)一般方式靜態(tài)推斷,因此抽象類被用來(lái)拓展表示容器中的元素
from typing import Mapping, Sequencedef notify_by_email(employees: Sequence[Employee], overrides: Mapping[str, str]) -> None: ...
可以通過(guò)typing中的TypeVar將泛型參數(shù)化
from typing import Sequence, TypeVarT = TypeVar(’T’) # 申明類型變量def first(l: Sequence[T]) -> T: # Generic function return l[0]
用戶定義泛型類型
from typing import TypeVar, Genericfrom logging import LoggerT = TypeVar(’T’)class LoggedVar(Generic[T]): def __init__(self, value: T, name: str, logger: Logger) -> None:self.name = nameself.logger = loggerself.value = value def set(self, new: T) -> None:self.log(’Set ’ + repr(self.value))self.value = new def get(self) -> T:self.log(’Get ’ + repr(self.value))return self.value def log(self, message: str) -> None:self.logger.info(’%s: %s’, self.name, message)
定義了Generic[T]作為L(zhǎng)oggedVar的基類,同時(shí)T也作為了方法中的參數(shù)。
通過(guò)Generic基類使用元類(metaclass)定義__getitem__()使得LoggedVar[t]是有效類型
from typing import Iterabledef zero_all_vars(vars: Iterable[LoggedVar[int]]) -> None: for var in vars:var.set(0)
泛型可以是任意類型的變量,但也可以被約束
from typing import TypeVar, Generic...T = TypeVar(’T’)S = TypeVar(’S’, int, str)class StrangePair(Generic[T, S]): ...
每個(gè)類型變量的參數(shù)必須是不同的
下面是非法的
from typing import TypeVar, Generic...T = TypeVar(’T’)class Pair(Generic[T, T]): # INVALID ...
你可以使用Generic實(shí)現(xiàn)多繼承
from typing import TypeVar, Generic, SizedT = TypeVar(’T’)class LinkedList(Sized, Generic[T]): ...
當(dāng)繼承泛型類時(shí),一些類型變量可以被固定
from typing import TypeVar, MappingT = TypeVar(’T’)class MyDict(Mapping[str, T]): ...
使用泛型類而不指定類型參數(shù)則假定每個(gè)位置都是Any,。在下面的例子中,myiterable不是泛型但隱式繼承Iterable [Any]
from typing import Iterableclass MyIterable(Iterable): # Same as Iterable[Any]
還支持用戶定義的泛型類型別名。實(shí)例:
from typing import TypeVar, Iterable, Tuple, UnionS = TypeVar(’S’)Response = Union[Iterable[S], int]# Return type here is same as Union[Iterable[str], int]def response(query: str) -> Response[str]: ...T = TypeVar(’T’, int, float, complex)Vec = Iterable[Tuple[T, T]]def inproduct(v: Vec[T]) -> T: # Same as Iterable[Tuple[T, T]] return sum(x*y for x, y in v)
Generic的元類是abc.ABCMeta的子類,泛型類可以是包含抽象方法或?qū)傩缘腁BC類(A generic class can be an ABC by including abstract methods or properties)
同時(shí)泛型類也可以含有ABC類的方法而沒(méi)有元類沖突。
Any
一種特殊的類型是。靜態(tài)類型檢查器將將每個(gè)類型視為與任何類型和任何類型兼容,與每個(gè)類型兼容。
from typing import Anya = None # type: Anya = [] # OKa = 2 # OKs = ’’ # type: strs = a # OKdef foo(item: Any) -> int: # Typechecks; ’item’ could be any type, # and that type might have a ’bar’ method item.bar() ...
以上為個(gè)人經(jīng)驗(yàn),希望能給大家一個(gè)參考,也希望大家多多支持好吧啦網(wǎng)。
相關(guān)文章:
1. .Net Core和RabbitMQ限制循環(huán)消費(fèi)的方法2. jsp網(wǎng)頁(yè)實(shí)現(xiàn)貪吃蛇小游戲3. asp(vbs)Rs.Open和Conn.Execute的詳解和區(qū)別及&H0001的說(shuō)明4. ASP.NET MVC遍歷驗(yàn)證ModelState的錯(cuò)誤信息5. 用css截取字符的幾種方法詳解(css排版隱藏溢出文本)6. ASP 信息提示函數(shù)并作返回或者轉(zhuǎn)向7. asp中response.write("中文")或者js中文亂碼問(wèn)題8. PHP設(shè)計(jì)模式中工廠模式深入詳解9. CSS hack用法案例詳解10. 將properties文件的配置設(shè)置為整個(gè)Web應(yīng)用的全局變量實(shí)現(xiàn)方法
