快捷導(dǎo)航

介紹一款python類型檢查工具pyright(推薦)

更新時(shí)間：2019年07月03日 10:36:48 作者：Liu-YanLin

這篇文章主要介紹了介紹一款python類型檢查工具pyright(推薦)，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

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

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

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

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

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

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

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

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

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

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

速度快。相較于 mypy 及其它用 Python 寫的檢查工具，它的速度是 5 倍甚至更多。
不依賴 Python 環(huán)境。它用 TypeScript 寫成，運(yùn)行于 node 上，不依賴 Python 環(huán)境或第三方包。
可配置性強(qiáng)。支持自由地配置，支持指定不同的運(yùn)行環(huán)境（PYTHONPATH 設(shè)置、Python 版本、平臺目標(biāo)）。
檢查項(xiàng)齊全。支持類型檢查及其它語法項(xiàng)的檢查（如 PEP-484、PEP-526、PEP-544），以及函數(shù)返回值、類變量、全局變量的檢查，甚至可以檢查條件循環(huán)語句
命令行工具。它包含兩個(gè) VS Code 插件：一個(gè)命令行工具和一個(gè)語言服務(wù)器協(xié)議（Language Server Protocol）
內(nèi)置 Stubs 。使用的是 Typeshed 的副本。（注：使用靜態(tài)的 pyi 文件，檢查內(nèi)置模塊、標(biāo)準(zhǔn)庫和三方件）
語言服務(wù)特性。懸停提示信息、符號定義的跳轉(zhuǎn)、實(shí)時(shí)的編輯反饋

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

接著看官方的 mypy ，它由“Python 之父” Guido van Rossum 親自參與開發(fā)，是最主流的選擇，推出得早，用戶基數(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 ，就是用的它來做保障。

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

標(biāo)記常見錯(cuò)誤，如拼寫錯(cuò)誤、函數(shù)調(diào)用錯(cuò)誤
加強(qiáng)自定義的類型注解
支持對 pyi 文件生成類型注解

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

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

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

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

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

4 種類型檢查工具介紹完畢，下面是一份概要對比：