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

近日，微軟在 Github 上開源了一個 Python 靜態類型檢查工具：pyright ，引起了社區內的多方關注。

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

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

眾所周知，Python 是一門動態類型語言，在運行期才知道變量的實際類型。這本就是動態語言的特色，然而在團隊合作或大型項目上，維護的代價也不可避免，俗話說的是：“動態一時爽，重構火葬場 ”。

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

類型檢查的好處是及早檢查，提前發現類型的錯誤，增強代碼的一致性與可維護性。（還有防止脫發，喵）

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

如上例所示，增加檢查后，可以在編譯期就判斷入參和返回值是否是字符串類型。例如下圖：

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

pyright 的文檔宣稱它有如下特點：

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

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

接著看官方的 mypy ，它由“Python 之父” Guido van Rossum 親自參與開發，是最主流的選擇，推出得早，用戶基數大，文檔與社區經驗也最豐富。

在集成 IDE 方面，所有主流的編輯器都支持：PyCharm、Vim、Emacs、Sublime Text、VS Code、Atom……在業界經驗上，Instagram 和 Dropbox 的項目從 py2 遷移到 py3 ，就是用的它來做保障。

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

1. 標記常見錯誤，如拼寫錯誤、函數調用錯誤
2. 加強自定義的類型注解
3. 支持對 pyi 文件生成類型注解

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

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

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

基本的功能點大同小異，不過它也是有亮點的。pyre-check 可集成Watchman 模塊，該“觀察者”會監聽代碼文件，跟蹤所做的修改。微軟的 pyright 有個 watch 模式，應該是吸收了這點，而且更加好用（因為不需要額外安裝 Watchman 和其它依賴）。

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

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

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

 項目地址：

https://github.com/python/mypy

https://github.com/Microsoft/pyright

https://github.com/google/pytype

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

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持億速云。