python 編碼中為什么要寫(xiě)類(lèi)型注解?
1、背景
我們先談?wù)劄槭裁丛赑ython編碼過(guò)程中強(qiáng)烈推薦使用類(lèi)型注解 ?
Python對(duì)于初學(xué)者來(lái)說(shuō)是非常好上手,原因是在于對(duì)計(jì)算機(jī)底層原理的高度封裝和動(dòng)態(tài)語(yǔ)言的特性使得Python用起來(lái)非常的舒適。但這種“舒適”是有代價(jià)的,我們可能聽(tīng)說(shuō)過(guò)一句形容動(dòng)態(tài)語(yǔ)言的話(huà),動(dòng)態(tài)一時(shí)爽,一直動(dòng)態(tài)一直爽。為什么會(huì)這么說(shuō)?動(dòng)態(tài)的確會(huì)賦予我們?cè)诰幋a時(shí)更多的靈活性與能力,但是動(dòng)態(tài)帶來(lái)的是更多的不確定性及混亂,導(dǎo)致了后來(lái)的維護(hù)者甚至作者自己都會(huì)產(chǎn)生很大的維護(hù)壓力(可以想象一個(gè)經(jīng)過(guò)幾年迭代的復(fù)雜系統(tǒng),如果大部分都使用動(dòng)態(tài)的方式來(lái)編寫(xiě)代碼的樣子),正所謂能力越大責(zé)任越大,需要進(jìn)行克制;
而類(lèi)型注解能很好的幫我們?cè)诰S護(hù)與開(kāi)發(fā)時(shí),理清變量類(lèi)型降低不確定性和混亂度,并且從容的使用變量。在這里廢話(huà)了這么多,主要是為了能讓讀者能深刻意識(shí)到動(dòng)態(tài)帶來(lái)的正反方向帶來(lái)的“爽”。后面進(jìn)入正題;
2、使用方式
2.1、 Python3內(nèi)置的類(lèi)型注解
內(nèi)置注解肯能大家都接觸過(guò),但總感覺(jué)很麻煩,導(dǎo)致后面很容易就放棄寫(xiě)注解,這是因?yàn)榈玫讲徽答?,看如下示例?/p>
a: str = "aa" b: int = 1 # 參數(shù)和返回標(biāo)注了類(lèi)型,那么接下來(lái)調(diào)用時(shí)就能進(jìn)行提示 def example(a: str) -> str: return f"Hello {a}" pirnt(example("world")) # # 一些簡(jiǎn)單的標(biāo)注,看起來(lái)起不到效果,但如果換個(gè)有含義的名字呢 User = str Age = int Answer = str def say_hello(u: User) -> Answer: return f"Hello {u}" print(say_hello("Shadow"))
上面簡(jiǎn)單演示了內(nèi)置的類(lèi)型注解是如何使用的,但是其實(shí)這么簡(jiǎn)單的類(lèi)型注解并不能幫助我們很好的標(biāo)注變量;下面介紹一個(gè)typing模塊
2.2、typing 模塊的快速入門(mén)
typing 模塊是類(lèi)型注解的主角,Python運(yùn)行時(shí)不強(qiáng)制執(zhí)行函數(shù)和變量類(lèi)型注解,但這些注解可用于類(lèi)型檢查器、IDE、靜態(tài)檢查器等第三方工具。這些第三方工具會(huì)在我們編碼時(shí)進(jìn)行提示與糾錯(cuò);
下面提供一些日常使用到的方法與用例給大家參考:
import typing # 自定義類(lèi)型注解 User = str Age = int # 定義有多種類(lèi)型注解的類(lèi)型 AnyStr = typing.TypeVar('AnyStr', str, bytes) a_str: AnyStr = "a" a_bytes: AnyStr = b"a" # 通用類(lèi)型, 接收通用的類(lèi)型,盡量少的去使用 def example_1(a: typing.Any): print(a) """ typing 模塊是允許使用下標(biāo)來(lái)輔助標(biāo)記類(lèi)型 """ # 列表, 下標(biāo)為列表的屬性 def example_2(a_list: typing.List[User]) -> typing.List[str]: pass # 字典,下標(biāo)第一個(gè)為key,第二個(gè)為value def example_3(a_dict: typing.Dict[User, Age]) -> typing.Dict[str, int]: pass # 元祖,下標(biāo)為元祖的屬性 def example_4(a_tuple: typing.Tuple[User] = None) -> typing.Tuple[User]: pass # Union, 在一些場(chǎng)景下我們某些參數(shù)或返回值是不確定,至少給定一個(gè)參數(shù)類(lèi)型 def example_5(a_b: typing.Union[str, int]) -> typing.Union[str, int]: pass # Optional, 與Union 有點(diǎn)類(lèi)似,但默認(rèn)多帶一個(gè)None,至少給定一個(gè)參數(shù)類(lèi)型 # 如:Optional[str] 等價(jià)于 Union[str, None] def example_6(a: str) -> typing.Optional[str]: pass # Tuple, 返回值有多個(gè)的時(shí)候, 如需要返回str, int, bool, float def example_7() -> typing.Tuple[str, int, bool, float]: pass # class, 類(lèi)本身也是一種類(lèi)型 class Action: up: str = "up" down: str = "down" # 指定需求一個(gè)action對(duì)象的參數(shù) def example_8(action_obj: Action) -> Action: pass # 這樣在一些枚舉參數(shù)的場(chǎng)景下,我們也可以使用類(lèi)作為我們枚舉參數(shù)的歸類(lèi) def example_9(action_cls: Action) -> Action: pass # 如果上面的枚舉參數(shù)你覺(jué)得并不能很好的實(shí)現(xiàn),那么還是可以使用自定義類(lèi)型注解的方式去實(shí)現(xiàn) Action = str up: Action = "up" down: Action = "down" # 在python3.9 中對(duì)枚舉參數(shù)類(lèi)型有更好的支持 MODE = type.Literal['r', 'rb', 'w', 'wb'] def open_file(file: str, mode: MODE) -> str: pass open_file('/some/path', 'r') # 正常 open_file('/other/path', 'typo') # 會(huì)提示該類(lèi)型不合法 # Type, 在一些多態(tài)類(lèi)的場(chǎng)景下標(biāo)注同一個(gè)類(lèi)型的不同的形態(tài) class User: ... class BasicUser(User): ... class ProUser(User): ... class TeamUser(User): ... # 相當(dāng)于 typing.Union[User, BasicUser, ProUser, TeamUser] def make_new_user(user_class: typing.Type[User]) -> User: return user_class()
以上十幾個(gè)用例場(chǎng)景基本能覆蓋大部分日常編碼,如果還有一些別的需求可參考官方的文檔,上面有明確的說(shuō)明;
Docs: docs.python.org/zh-cn/3/lib…
3、寫(xiě)在最后
希望文章能對(duì)大家對(duì)類(lèi)型注解的了解與使用有所幫助,早日脫離被動(dòng)態(tài)繞得心里“罵娘”與找不到"娘"的日子。
以上就是python 編碼中為什么要寫(xiě)類(lèi)型注解?的詳細(xì)內(nèi)容,更多關(guān)于python 類(lèi)型注解的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
python編程測(cè)試電腦開(kāi)啟最大線(xiàn)程數(shù)實(shí)例代碼
這篇文章主要介紹了python編程測(cè)試電腦開(kāi)啟最大線(xiàn)程數(shù)實(shí)例代碼,分享了相關(guān)代碼示例,小編覺(jué)得還是挺不錯(cuò)的,具有一定借鑒價(jià)值,需要的朋友可以參考下2018-02-02Python爬取新型冠狀病毒“謠言”新聞進(jìn)行數(shù)據(jù)分析
這篇文章主要介紹了Python爬取新型冠狀病毒“謠言”新聞進(jìn)行數(shù)據(jù)分析,本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì),具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-02-02詳解Django ORM引發(fā)的數(shù)據(jù)庫(kù)N+1性能問(wèn)題
這篇文章主要介紹了詳解Django ORM引發(fā)的數(shù)據(jù)庫(kù)N+1性能問(wèn)題,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-10-10Python標(biāo)準(zhǔn)庫(kù)之多進(jìn)程(multiprocessing包)介紹
這篇文章主要介紹了Python標(biāo)準(zhǔn)庫(kù)之多進(jìn)程(multiprocessing包)介紹,本文講解了進(jìn)程池、共享資源、共享內(nèi)存、Manager等內(nèi)容,需要的朋友可以參考下2014-11-11Python實(shí)現(xiàn)將絕對(duì)URL替換成相對(duì)URL的方法
這篇文章主要介紹了Python實(shí)現(xiàn)將絕對(duì)URL替換成相對(duì)URL的方法,涉及Python字符串操作及正則匹配的相關(guān)技巧,需要的朋友可以參考下2015-06-06Python中urlencode()函數(shù)構(gòu)建URL查詢(xún)字符串的利器學(xué)習(xí)
這篇文章主要為大家介紹了Python中urlencode()函數(shù)構(gòu)建URL查詢(xún)字符串的利器學(xué)習(xí),有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-10-10