Hoʻohālikelike ʻO Python Type Checker: Hoʻokaʻawale i ka pahu pahu

No ke aha e uhaʻi ai nā pahu ʻokoʻa i ka Python Type Checkers — A he aha kāu e hana ai no ia

Ua oo loa ka ʻōnaehana paʻi lohi a Python mai ka hoʻokomo ʻana o PEP 484 i nā ʻano hōʻailona ma 2015. I kēia lā, hilinaʻi nā miliona o nā mea hoʻomohala i nā mea nānā ʻano static e hopu i nā pōpoki ma mua o ka hana ʻana. Akā, aia kahi kihi maʻalahi a hoʻonāukiuki o ka ʻano ʻano ʻōnaehana e hele mau ana i nā ʻenehana loea: he aha ke ʻano o ka ipu kaʻawale? Ke kākau ʻoe i x = [] me ka ʻole o ka hōʻike ʻana, pono e koho kāu mea nānā ʻano - a koho ʻokoʻa nā mea nānā like ʻole. Hoʻokumu kēia ʻokoʻa i nā pilikia maoli no nā hui e mālama ana i nā codebase nui, kahi e hiki ai ke hoʻololi a hui pū ʻana i nā mea nānā ʻano ʻano hiki ke hōʻea i nā haneli he nui i manaʻo ʻole ʻia i ka pō.

Ke wehewehe nei kēia ʻatikala pehea e mālama ai nā mea nānā ʻano Python nui ʻehā - mypy, pyright, pytype, a me pyre - i ka manaʻo o ka ipu hao ʻole, no ke aha lākou i ʻae ʻole ai, a me nā hoʻolālā kūpono e hiki ai iā ʻoe ke hana e kākau i ka Python palekana ʻano me ka nānā ʻole i kāu mea paahana.

Ka Pilikia Koʻikoʻi: ʻO nā ipu ʻokoʻa he pohihihi maoli nō

E noʻonoʻo i kēia laina hewa ʻole o Python: nā hopena = []. ʻO nā hopena he papa inoa[int]? He papa inoa[str]? He papa inoa[dict[str, Any]]? Me ka ʻole o ka pōʻaiapili hou, ʻaʻohe ala e ʻike ai. ʻAʻole mālama ka Python runtime - he ʻano like nā papa inoa ma ke ʻano - akā pono nā mea nānā ʻano static e kau i kahi ʻano kikoʻī i kēlā me kēia ʻano e hana i kā lākou hana. Hoʻokumu kēia i ka ʻāʻī koʻikoʻi ma waena o ka hiki ke hoʻoikaika ʻia o Python a me nā hōʻoia e hoʻāʻo ʻia e ka loiloi static.

Hoʻohui ka pilikia me nā puke wehewehe ʻōlelo a me nā pūʻulu. Hoʻopili ʻia kahi {} hakahaka ma ke ʻano he dict, ʻaʻole he set, kahi e hoʻohui ai i ka pohihihi syntactic ma luna o ka ambiguity pae ʻano. A me nā ipu pūnana - e noʻonoʻo defaultdict(list) a i ʻole hopena = {k: [] no k ma nā kī} — hoʻokuke i nā ʻenekini inference i ko lākou palena. Ua hoʻomohala kēlā me kēia ʻano mea nānā i kāna heuristic ponoʻī, a ʻoi aku ka nui o nā ʻokoʻa ma mua o ka ʻike ʻana o ka hapa nui o nā mea hoʻomohala.

Ma nā ʻōnaehana hana e hoʻoponopono ana i nā haʻahaʻa hana maoli - inā paha he CRM e mālama ana i nā moʻolelo o nā mea kūʻai aku, he module invoicing e hoʻopuka ana i nā mea laina, a i ʻole nā ana hoʻohui ʻana i ka pipeline - ʻike mau ʻia nā ipu hakahaka ma ke ʻano he kumu hoʻomaka. ʻO ka loaʻa ʻana o kā lākou ʻano ʻano hewa ʻaʻole ia e hoʻopuka wale i nā ʻōlelo aʻo linter; hiki iā ia ke uhi i nā ʻino maoli e paheʻe i ka wā holo.

Mypy: Hoʻopaneʻe ʻia me ka Manaʻo Loa

ʻO Mypy, ka mea nānā mua loa a hoʻohana nui ʻia ʻo Python type checker, lawe i kahi ala ʻoluʻolu i nā ipu ʻole. Ke hālāwai ʻo ia me x = []ma ​​ka laulā hana, hoʻāʻo ʻo ia e hoʻopanee i ka hoʻoholo ʻano ʻanoa hoʻohālikelike i ke ʻano mea mai ka hoʻohana ʻana ma hope. Inā kākau ʻoe i x = [] a ukali ʻia e x.append(42), ʻo ka mypy e hōʻike i ka papa inoa[int]. Hana maikaʻi kēia hoʻolālā "hui" no nā hihia maʻalahi kahi i hoʻopiha ʻia ai ka ipu i loko o ka laulā like.

Eia naʻe, loli nui ka ʻano o mypy ma muli o ka pōʻaiapili a me ka hoʻonohonoho koʻikoʻi. Ma ke ʻano o ka module (kiʻekiʻe-level code), a i ʻole ke hāʻawi ʻia ka pahu i kahi hana ʻē aʻe ma mua o ka hoʻopiha ʻia ʻana, hāʻule pinepine ka mypy i papa inoa [Kekahi] Ma lalo o ka hae --koki, hoʻomaka kēia i ka hewa, akā ma ke ʻano paʻamau e hala mālie. ʻO ia hoʻi, hiki i nā hui holo mypy me ka ʻole o ke ʻano koʻikoʻi ke hōʻiliʻili i nā kakini o nā ipu i hoʻopaʻa ʻole ʻia e hana ana ma ke ʻano he puka pakele mai ka ʻōnaehana ʻano, e lanakila ana i kāna kumu.

Kekahi hana maʻalahi: mypy versions before to 0.990 infer some time list[Unknown] inside and then widen to list[Any] on assignment. Ma hope o 0.990, ua hoʻopaʻa ʻia ka inference, akā ua haki ka hoʻololi i kahi helu kahaha o nā codebase honua maoli e hilinaʻi nei i ka ʻae ʻana me ka ʻike ʻole. He kumumanaʻo hou kēia - ʻo nā hoʻololi i ka ʻike ʻana o ka ipu hao kekahi o nā mea hoʻopōʻino ʻano ʻano hōʻoia no ka mea he nui nā kumu.

Pyright: Manaʻo Koʻikoʻi a me ke ʻano "ʻike ʻole ʻia"

Pyright, hoʻomohala ʻia e Microsoft a me ka mana ʻo Pylance ma VS Code, he ʻano manaʻo noʻonoʻo ʻē aʻe. Ma mua o ka hā'ule malie 'ana i ka Any, ho'oka'awale ka pyright ma waena o Unknown (he 'ano i ho'oholo 'ole 'ia) a me Any (he koho 'oko'a no ka nānā 'ana i ke 'ano). Ke kākau ʻoe i x = [] ma ke ʻano koʻikoʻi o ka pyright, ʻike ʻo ia i papa inoa [Unknown] a hōʻike i kahi diagnostic, e koi ana iā ʻoe e hāʻawi i kahi hōʻike.

ʻOi aku ka ikaika o Pyright e pili ana i ka hōʻemi i loko o ka laulā. Inā kākau ʻoe:

• x = [] a ukali ʻia e x.append("hello") — pyright infers list[str]
• x = [] a ukali ʻia e x.append(1) a laila x.append("hello") — pyright infers list[int | str]
• x = [] i hele pololei i kahi hana e manaʻo ana papa inoa[int] — hoʻokomo ka pyright i papa inoa[int] mai ka pōʻaiapili kahua kelepona
• x = [] i hoʻi mai kahi hana me ka ʻole o ka hōʻike hōʻike ʻano hoʻihoʻi — hōʻike ʻo pyright i kahi hewa ma mua o ka wānana

ʻO kēia manaʻo ʻelua (e hoʻohana ana i ka hoʻohana ʻana ma hope a me nā ʻano i manaʻo ʻia mai nā pūnaewele kelepona) ʻoi aku ka pololei o ka pyright ma mua o ka mypy no nā ipu kaʻawale. He verbosity ka tradeoff: hae 'ano ko'iko'i o pyright ma kahi o30-40% hou aku pilikiama ​​kahi codebase unannotated ma'amau i ho'ohālikelike 'ia me ke 'ano ko'iko'i o mypy, e like me ka nānā 'ana mai kekahi mau mo'olelo ne'e 'ana. No nā hui e kūkulu ana i nā ʻōnaehana hope paʻakikī - e ʻōlelo, he paepae e mālama ana i 207 mau modula pili e pili ana i ka CRM, ka uku uku, a me ka ʻikepili - ʻo ke koʻikoʻi o ka pyright e hopu i nā ʻokoʻa maʻalahi e hiki ʻole ke ʻike ʻia.

Pytype a me Pyre: ʻO nā alanui i hele ʻole ʻia

Maikaʻi paha ka pytype o Google i ke ala kūpono loa. Ma kahi o ke koi ʻana i nā hōʻike a i ʻole e hāʻule i hope i Kekahi, hoʻohana ʻo pytype i hoʻoponopono papahana holoʻokoʻae nānā i ke ʻano o ka hoʻohana ʻia ʻana o kahi ipu ma nā palena hana. Inā hana ʻoe i kahi papa inoa ʻole i hoʻokahi hana a hāʻawi iā ia i kekahi e hoʻopili ai i nā helu helu, hiki i ka pytype ke hoʻomaopopo pinepine i ka list[int] me ka ʻole o nā hōʻike. ʻOi aku ke kumukūʻai o kēia manaʻo cross-function - ʻoi aku ka lohi o ka pytype ma mua o ka mypy a i ʻole pyright ma nā codebases nui - akā ʻoi aku ka liʻiliʻi o nā hopena maikaʻi ʻole ma ke code ʻike ʻole ʻia.

Hoʻopuka pū ʻo Pytype i ka manaʻo o "ʻano hapa" no nā ipu ʻole. Loaʻa i kahi [] kahi ʻano ʻāpana i hoʻomaʻemaʻe ʻia i ka wā e loaʻa ai ka hoʻohana hou ʻana o ka mea nānā. He nani kēia i ka manaʻo akā hiki ke hoʻopuka i nā memo kuhi hewa inā ʻaʻole hiki ke hoʻoholo piha ʻia ke ʻano hapa, e like me ke kahe ʻana o kahi pahu hakahaka ma nā hana he nui ʻole me ka piha ʻole ʻia.

ʻO ka pyre a Meta, ʻo ia hoʻi, e ʻoki kokoke ana i ka hana a mypy akā me ka paʻa paʻa. Hana ʻo Pyre i ka x = [] ma ke ʻano he papa inoa[ʻike ʻole] a koi ʻia i ka wehewehe ʻana ma ka hapa nui o nā pōʻaiapili. ʻO kahi e hoʻokaʻawale ai ʻo pyre iā ia iho ma kāna lawelawe ʻana i kanā puke wehewehe ʻōlelo hakahaka i hoʻohana ʻia ma ke ʻano he kwargsʻo ia ke ʻano maʻamau i nā frameworks pūnaewele. Loaʻa iā Pyre ka manaʻo noʻonoʻo no ka hoʻokaʻawale ʻana i nā ʻano puke wehewehe ʻōlelo mai nā pōʻaiapili hoʻopaʻapaʻa huaʻōlelo, e hōʻemi ana i ke kaumaha hōʻike ma nā codebase kaumaha. ʻOiai ʻo ka hapa nui o nā palapala noi pūnaewele hou e pili ana i ka hoʻohana koʻikoʻi o ka wehe ʻana i ka puke wehewehe ʻōlelo no ka hoʻonohonoho ʻana a me ka lawelawe ʻana i nā noi, ʻo kēia pragmatism e uku i nā ʻāpana.

Ka hopena o ka honua maoli: i ka nahu ʻana o ka ʻokoʻa hoʻohālikelike

Me he mea hoʻonaʻauao paha nā ʻokoʻa ma waena o nā mea nānā ʻano ʻano a hiki i kou ʻike ʻana iā lākou ma kahi codebase hana. E noʻonoʻo i kahi ʻano maʻamau i nā noi ʻoihana: ka hoʻomaka ʻana i kahi hoʻolālā ʻikepili i hoʻopiha ʻia me ke kūlana.

ʻAʻole ʻo nā pahu pahu kaʻa ʻino loa ka hae nānā - ʻo ia ka mea e hele mālie me ka ʻano ʻano Kekahi i manaʻo ʻia, e ʻae ana i ka ʻikepili like ʻole e hōʻiliʻili me ka ʻōlelo ʻole a hiki i ka wā e holo ai ka hana i lalo me kahi TypeError aneane hiki ʻole ke huli i kona kumu.

He laʻana koʻikoʻi: ua hōʻike ʻia kahi hui ma kahi hoʻomaka fintech e hoʻohana ana ʻekolu mau lā e hoʻopau ana i kahi pilikia hana kahi papa inoa ʻole, i hoʻomaka ʻia ma kahi hana hoʻoili uku, ua ʻike ʻia ʻolist[Any]e mypy. Ua manaʻo ʻia ka papa inoa he mau mea Decimal no nā huina kālā, akā ua hoʻopili ʻia kahi ala code i nā waiwai float. Ua ʻae mālie ka manaʻo ʻoluʻolu a Mypy. Ua puka wale ka ʻino i ka wā o ka hoʻopuni ʻana i nā hewa i ka helu lana i hoʻohālikelike ʻia he $0.01 ma kahi pūʻulu o 12,000 invoice. Inā ua hoʻohana lākou i ka pyright ma ke ʻano koʻikoʻi, a i ʻole e hōʻike wale i ka papa inoa ʻole ma ke ʻano he papa inoa [Decimal], inā ua hopu ʻia ka pahu i ka manawa hoʻomohala.

Ma Mewayz, kahi e kaʻina ai ke kahua no ka hoʻopiʻi ʻana, ka helu ʻana i ka uku, a me ka ʻikepili kālā ma waena o 138,000+ mau moʻokāki mea hoʻohana, ʻaʻole manaʻo kēia ʻano ʻano palekana palekana - ʻo ia ka ʻokoʻa ma waena o ka holo ʻana o ka uku uku a me ka helu hou ʻana. ʻO ke aʻo paʻi paʻa ʻana e pili ana i ka hoʻomaka ʻana o ka ipu hao kekahi o ia mau hana ʻenekinia "hōʻoluʻolu" e pale aku ai i nā hanana hana hoihoi.

Nā hoʻomaʻamaʻa maikaʻi loa no ka hoʻomaka ʻana o ka pahu pale

Ma ke ʻano o ke ʻano mea nānā i hoʻohana ʻia e kāu hui, aia nā hoʻolālā paʻa no ka hoʻopau ʻana i ka pohihihi pahu hakahaka. ʻO ka pahuhopu, ʻaʻole e hilinaʻi i ka manaʻo no nā ipu kaʻawale - e hoʻokaʻawale i ke ʻano i hiki ke lawe ʻia kāu code ma nā mea nānā āpau a pale ʻole i ka hoʻololi ʻana i ke ʻano o ka manaʻo ma waena o nā mana.

1. E hōʻike mau i nā mea hoʻololi pahu hakahaka. Kākau i nā hualoaʻa: list[int] = [] ma kahi o nā hualoaʻa = []. ʻAʻole liʻiliʻi ke kumukūʻai verbosity liʻiliʻi e hoʻohālikelike ʻia i ka manawa debugging i mālama ʻia. Hoʻopau kēia hana hoʻokahi ma kahi o 80% o nā pilikia hoʻopiʻi pahu hakahaka.
2. E hoʻohana i nā hana hale hana no nā ipu paʻakikī. Ma kahi o cache = {}, e kākau i kahi hana e like me def make_cache() -> dict[str, list[UserRecord]]: return {}. ʻO ka wehewehe ʻana i ke ʻano hoʻihoʻi e hoʻokaʻawale i ke ʻano i manaʻo ʻia a paʻa pono ʻia.
3. Makemake i nā mea hana i paʻi ʻia ma mua o ka literal no nā ʻano mea ʻole. Kākau i nā ikamu: set[int] = set() ma mua o ka hilinaʻi ʻana i ka manaʻo hoʻomaopopo hoʻonohonoho. No paʻamau a me Kakau, e hāʻawi mau i ke ʻano ʻano: helu helu: Counter[str] = Counter().
4. E hoʻopaʻa i ke ʻano koʻikoʻi o kāu mea nānā ʻano no ke code hou. Kākoʻo ka mypy a me ka pyright i kēlā me kēia faila a i ʻole ka hoʻonohonoho papa kuhikuhi. E ʻae i ka nānā pono ʻana i nā modula hou i ka neʻe ʻana i ke code hoʻoilina. ʻAʻole kēia i ka hōʻiliʻili ʻana o nā ipu ʻano implicitly-type hou.
5. Hoʻohui i ka hoʻohālikelike ʻano nānā i kāu paipu CI. ʻO ka holo ʻana i ka mypy a me ka pyright ma kāu codebase e hopu koke i ka ʻokoʻa inference. Inā hele kekahi mamana i hoʻokahi māka akā hāʻule kekahi, he hōʻailona ia no ka lawa ʻole o ke ʻano.

Ke Kiʻi Nui: Type Checking as a Team Practice

ʻO ka ʻike ʻana o ka pahu pahu he microcosm o kahi paʻakikī nui aʻe i ka ʻano ʻano ʻano Python: ʻo ka paʻakikī ma waena o ka maʻalahi a me ka palekana. ʻO ka manaʻo noʻonoʻo o Python "ʻae mākou a pau i nā mākua" e hana nani no ka prototyping a me nā palapala, akā pono nā ʻōnaehana hana e lawelawe ana i nā tausani o nā mea hoʻohana. ʻO ka ʻoiaʻiʻo o ka ʻae ʻole ʻana o nā mea nānā ʻano nui ʻehā i kekahi mea maʻamau e like me ke ʻano o [] e hōʻike ana i ke oʻo ʻana o ke kaiaola kikokiko kikokiko.

No nā hui ʻenekinia e kūkulu ana i nā paepae paʻakikī - inā ʻoe e hoʻokele nei i kahi liʻiliʻi o nā microservices a i ʻole kahi ʻōnaehana i hoʻohui ʻia me nā haneli o nā modula pili e like me Mewayz's business OS - pololei ka ʻōlelo aʻoaʻo kūpono: mai hilinaʻi i ka manaʻo no nā ipu kaʻawale, e koho i kahi mea nānā ʻano a hoʻonohonoho pono ʻia, a e mālama i nā ʻano hōʻike ma ke ʻano he mīkini. ʻO nā minuke ʻelima i hoʻohana ʻia i ke kākau ʻana papa inoa [Invoice] ma kahi o [] e mālama iā ʻoe i nā hola o ka hoʻopau ʻana i ka wā e hoʻonui ai kāu codebase.

Ke hoʻomau nei ka PEP 696 (nā ʻano ʻano paʻamau) a me ka PEP 695 (type parameter syntax) i nā mana Python hou, e hoʻomaikaʻi mau ana nā ergonomics o ka paʻi ʻana. E hōʻemi ka ʻokoʻa ma waena o "annotated" a me "unnotated" Python. Akā, a hiki i kēlā lā, e noho mau ana nā ʻano ipu ʻokoʻa i hoʻokahi o nā hana ROI kiʻekiʻe loa i loko o ka pahu hana a ka mea hoʻomohala Python - kahi aʻo liʻiliʻi e uku i ka uku paneʻe ma kēlā me kēia module, kēlā me kēia sprint, a me kēlā me kēia hoʻolālā hana.

Nīnau pinepine

No ke aha i hiki ʻole ai i nā mea nānā ke ʻae i ke ʻano o ka papa inoa ʻole?

Ke kākau ʻoe iā `x = []`, pono e hoʻomaopopo ka mea nānā ʻano i kahi ʻano me ka ʻole o nā ʻōlelo hōʻike. Hoʻohana nā mea nānā like ʻole i nā hoʻolālā ʻokoʻa: ʻike kekahi i ka `papa inoa [Kekahi]` (kahi papa inoa o nā mea a pau), aʻo nā mea ʻē aʻe e hoʻomaopopo i kahi ʻano kikoʻī akā pololei ʻole e like me `list[None]`. ʻO kēia hemahema o ka pae honua holoʻokoʻa ke kumu o ko lākou ʻae ʻole. No nā papahana e ho'ohana ana i nā mea nānā he nui, hiki i kēia kū'oko'a ke lilo i po'o po'o nui, e uha'i ana i ka nānā 'ana i kekahi mea hana i hala ma kekahi.

He aha ke ala maʻalahi loa e hoʻoponopono i nā hewa pahu pahu?

ʻO ka hāʻina maʻalahi loa ʻo ka hāʻawi ʻana i kahi hōʻike kikoʻī ʻano. Ma kahi o `my_list = []`, e kākau iā `my_list: list[str] = []` e haʻi maopopo i ke ʻano i manaʻo ʻia. Hoʻopau kēia i nā ʻokoʻa a pau no ka mea nānā ʻano, e hōʻoia i ka ʻano kūlike ma waena o nā mea hana like ʻole e like me mypy, Pyright, a me Pyre. Manaʻo ʻia kēia hana no ka hoʻomaka ʻana o ka pahu hakahaka no ka pale ʻana i nā hewa kuhi.

Pehea wau e mālama ai i nā ipu kaʻawale i loko o nā wehewehe papa?

He pilikia maʻamau kēia no ka mea e pono ana nā hōʻike i loko o nā papa i ka lawelawe kūikawā. Pono ʻoe e hoʻohana i ka `mai __future__ import annotations` hoʻokomo a i ʻole he `ClassVar` hōʻike inā manaʻo ʻia ka papa inoa he ʻano papa. No ka laʻana, `papa MyClass: my_list: ClassVar[list[str]] = []`. Inā ʻaʻole kēia, paʻakikī paha ka mea nānā ʻano e hoʻomaopopo pololei i ke ʻano, e alakaʻi ana i nā hewa.

Aia nā mea hana e kōkua ai i ka hoʻoponopono ʻana i kēia mau pilikia paʻi ʻana i nā papahana nui?

ʻAe, ʻoi aku ka maikaʻi o nā mākaʻikaʻi ʻano kiʻekiʻe e like me Pyright (ʻo ia ka mana Pylance ma VS Code) i ka lawelawe ʻana i ka inference paʻakikī. No nā codebases nui, hiki i nā paepae e like me Mewayz (hāʻawi ʻana i 207 mau modula kānana no $19/mahina) hiki ke hāʻawi i ka nānā ʻana i ka hohonu hohonu a me ka paʻa ʻana a kōkua i ka hoʻokō ʻana i nā hana hōʻike ma kāu hui holoʻokoʻa, e hoʻēmi ana i nā kūlike ʻole i kūkākūkā ʻia ma ka ʻatikala.