摘要：近日，微軟在上開(kāi)源了一個(gè)靜態(tài)類(lèi)型檢查工具，引起了社區(qū)內(nèi)的多方關(guān)注。在微軟推出之前，主流的靜態(tài)檢查工具有三款官方的出的出的。微軟的有個(gè)模式，應(yīng)該是吸收了這點(diǎn)，而且更加好用因?yàn)椴恍枰~外安裝和其它依賴(lài)。

近日，微軟在 Github 上開(kāi)源了一個(gè) Python 靜態(tài)類(lèi)型檢查工具：pyright ，引起了社區(qū)內(nèi)的多方關(guān)注。

微軟在開(kāi)源項(xiàng)目上的參與力度是越來(lái)越大了，不說(shuō)收購(gòu) Github 這種大的戰(zhàn)略野心，只說(shuō)它家開(kāi)源的 VS Code 編輯器，在猿界已經(jīng)割粉無(wú)數(shù)，連我們 Python 圈的紅人 Kenneth Reitz （多個(gè)開(kāi)源項(xiàng)目的作者，包括 requests、requests-html、responder等）都對(duì)它贊不絕口。

如今開(kāi)源的 Pyright ，口碑還不錯(cuò)，那我們就來(lái)看看它有啥本事，順便再介紹其它幾款類(lèi)型檢查工具。

眾所周知，Python 是一門(mén)動(dòng)態(tài)類(lèi)型語(yǔ)言，在運(yùn)行期才知道變量的實(shí)際類(lèi)型。這本就是動(dòng)態(tài)語(yǔ)言的特色，然而在團(tuán)隊(duì)合作或大型項(xiàng)目上，維護(hù)的代價(jià)也不可避免，俗話(huà)說(shuō)的是：“動(dòng)態(tài)一時(shí)爽，重構(gòu)火葬場(chǎng) ”。

早在 2006 年的 PEP-3107，Python 就推出了函數(shù)注解的功能，最終落在 3.0 版本實(shí)現(xiàn)。而到了 3.5 版本，Python 繼續(xù)引入了靜態(tài)類(lèi)型檢查的語(yǔ)法（即 PEP-484，type hints）。2014 年的 PEP-483 更是以《The Theory of Type Hints》為題，做出了理論上的歸納。后來(lái)，又陸續(xù)提出了 PEP-526、PEP-544，類(lèi)型檢查的規(guī)范逐漸豐富。

類(lèi)型檢查的好處是及早檢查，提前發(fā)現(xiàn)類(lèi)型的錯(cuò)誤，增強(qiáng)代碼的一致性與可維護(hù)性。（還有防止脫發(fā)，喵）

# 不加檢查
def greeting(name):
    return "Hello " + name

# 添加檢查
def greeting(name: str) -> str:
    return "Hello " + name

如上例所示，增加檢查后，可以在編譯期就判斷入?yún)⒑头祷刂凳欠袷亲址?lèi)型。

在微軟推出 pyright 之前，主流的靜態(tài)檢查工具有三款：官方的mypy 、Google 出的pytype 、Facebook 出的pyre-check 。三足鼎立的局面要被打破了。

pyright 的文檔宣稱(chēng)它有如下特點(diǎn)：

速度快。相較于 mypy 及其它用 Python 寫(xiě)的檢查工具，它的速度是 5 倍甚至更多。

不依賴(lài) Python 環(huán)境。它用 TypeScript 寫(xiě)成，運(yùn)行于 node 上，不依賴(lài) Python 環(huán)境或第三方包。

可配置性強(qiáng)。支持自由地配置，支持指定不同的運(yùn)行環(huán)境（PYTHONPATH 設(shè)置、Python 版本、平臺(tái)目標(biāo)）。

檢查項(xiàng)齊全。支持類(lèi)型檢查及其它語(yǔ)法項(xiàng)的檢查（如 PEP-484、PEP-526、PEP-544），以及函數(shù)返回值、類(lèi)變量、全局變量的檢查，甚至可以檢查條件循環(huán)語(yǔ)句

命令行工具。它包含兩個(gè) VS Code 插件：一個(gè)命令行工具和一個(gè)語(yǔ)言服務(wù)器協(xié)議（Language Server Protocol）

內(nèi)置 Stubs 。使用的是 Typeshed 的副本。（注：使用靜態(tài)的 pyi 文件，檢查內(nèi)置模塊、標(biāo)準(zhǔn)庫(kù)和三方件 ）

語(yǔ)言服務(wù)特性。懸停提示信息、符號(hào)定義的跳轉(zhuǎn)、實(shí)時(shí)的編輯反饋

就此而言，不可謂不強(qiáng)大。事實(shí)上，pyright 是“站在了巨人的肩膀上”，它的各項(xiàng)功能似乎都繼承自其它幾位前輩。

接著看官方的 mypy ，它由“Python 之父” Guido van Rossum 親自參與開(kāi)發(fā)，是最主流的選擇，推出得早，用戶(hù)基數(shù)大，文檔與社區(qū)經(jīng)驗(yàn)也最豐富。

在集成 IDE 方面，所有主流的編輯器都支持：PyCharm、Vim、Emacs、Sublime Text、VS Code、Atom......在業(yè)界經(jīng)驗(yàn)上，Instagram 和 Dropbox 的項(xiàng)目從 py2 遷移到 py3 ，就是用的它來(lái)做保障。

接著看谷歌的 pytype ，據(jù)文檔描述，它可以：

標(biāo)記常見(jiàn)錯(cuò)誤，如拼寫(xiě)錯(cuò)誤、函數(shù)調(diào)用錯(cuò)誤

加強(qiáng)自定義的類(lèi)型注解

支持對(duì) pyi 文件生成類(lèi)型注解

查看文檔，我發(fā)現(xiàn)它有個(gè)功能還挺人性化的，即“錯(cuò)誤降噪 ”，對(duì)于那些不必修改的錯(cuò)誤，可以添加注釋?zhuān)瑏?lái)消除類(lèi)型檢查。

此外，還有一個(gè)考慮也不錯(cuò)，為了寫(xiě)類(lèi)型檢查，模塊中可能會(huì)額外引入其它的模塊，對(duì)于后者，pytype 有辦法隱藏它，只在做類(lèi)型檢查時(shí)才加載。

最后，要介紹的是臉書(shū)的 pyre-check，它是去年開(kāi)源的，也曾收獲一片好評(píng)（說(shuō)不定正是因?yàn)樗?，微軟才上馬了 pyright 項(xiàng)目也說(shuō)不定）。

基本的功能點(diǎn)大同小異，不過(guò)它也是有亮點(diǎn)的。pyre-check 可集成Watchman 模塊，該“觀(guān)察者”會(huì)監(jiān)聽(tīng)代碼文件，跟蹤所做的修改。微軟的 pyright 有個(gè) watch 模式，應(yīng)該是吸收了這點(diǎn)，而且更加好用（因?yàn)椴恍枰~外安裝 Watchman 和其它依賴(lài)）。

pyre-check 還有個(gè)亮點(diǎn)，它有個(gè)query 參數(shù)，可以對(duì)源碼做局部區(qū)域性的檢查，例如查詢(xún)某行中一個(gè)表達(dá)式的類(lèi)型、查詢(xún)一個(gè)類(lèi)的全部方法并返回成列表，等等，這樣可以避免做全面的檢查。

4 種類(lèi)型檢查工具介紹完畢，下面是一份概要對(duì)比：

至于它們的性能如何，是否真如 pyright 所說(shuō)，它的速度是其它幾個(gè)的 5 倍呢？感興趣的同學(xué)們可以去試試。有什么使用體會(huì)，歡迎留言與我交流。

項(xiàng)目地址：

https://github.com/python/mypy

https://github.com/Microsoft/pyright

https://github.com/google/pytype

https://github.com/facebook/pyre-check

公眾號(hào)【Python貓】， 專(zhuān)注Python技術(shù)、數(shù)據(jù)科學(xué)和深度學(xué)習(xí)，力圖創(chuàng)造一個(gè)有趣又有用的學(xué)習(xí)分享平臺(tái)。本號(hào)連載優(yōu)質(zhì)的系列文章，有喵星哲學(xué)貓系列、Python進(jìn)階系列、好書(shū)推薦系列、優(yōu)質(zhì)英文推薦與翻譯等等，歡迎關(guān)注哦。PS：后臺(tái)回復(fù)“愛(ài)學(xué)習(xí)”，免費(fèi)獲得一份學(xué)習(xí)大禮包。