介紹幾款 Python 類型檢查工具

来源:https://www.cnblogs.com/pythonista/archive/2019/03/27/10604929.html
-Advertisement-
Play Games

近日,微軟在 Github 上開源了一個 Python 靜態類型檢查工具:pyright ,引起了社區內的多方關註。 微軟在開源項目上的參與力度是越來越大了,不說收購 Github 這種大的戰略野心,只說它家開源的 VS Code 編輯器,在猿界已經割粉無數,連我們 Python 圈的紅人 Kenn ...


 

近日,微軟在 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 的文檔宣稱它有如下特點:

  • 速度快。相較於 mypy 及其它用 Python 寫的檢查工具,它的速度是 5 倍甚至更多。

  • 不依賴 Python 環境。它用 TypeScript 寫成,運行於 node 上,不依賴 Python 環境或第三方包。

  • 可配置性強。支持自由地配置,支持指定不同的運行環境(PYTHONPATH 設置、Python 版本、平臺目標)。

  • 檢查項齊全。支持類型檢查及其它語法項的檢查(如 PEP-484、PEP-526、PEP-544),以及函數返回值、類變數、全局變數的檢查,甚至可以檢查條件迴圈語句

  • 命令行工具。它包含兩個 VS Code 插件:一個命令行工具和一個語言伺服器協議(Language Server Protocol)

  • 內置 Stubs 。使用的是 Typeshed 的副本。(註:使用靜態的 pyi 文件,檢查內置模塊、標準庫和三方件 )

  • 語言服務特性。懸停提示信息、符號定義的跳轉、實時的編輯反饋

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

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

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

接著看谷歌的 pytype ,據文檔描述,它可以:

  • 標記常見錯誤,如拼寫錯誤、函數調用錯誤

  • 加強自定義的類型註解

  • 支持對 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

 

公眾號【Python貓】, 專註Python技術、數據科學和深度學習,力圖創造一個有趣又有用的學習分享平臺。本號連載優質的系列文章,有喵星哲學貓系列、Python進階系列、好書推薦系列、優質英文推薦與翻譯等等,歡迎關註哦。PS:後臺回覆“愛學習”,免費獲得一份學習大禮包。

 

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 一、前三次作業內容分析總結 前言 前三次作業,我提交了三次,但是有效作業只有兩次,最後一次作業沒能實現多項式求導的基本功能因此無疾而終,反思留給後文再續,首先我介紹一下這三次作業,三次作業圍繞著多項式求導展開,輸出目的都是一致的,即對輸入的多項式進行求導,將求導結果列印到顯示屏,作業難度遞增,每一次 ...
  • 記得比較早使用手機掃碼登錄是網頁版微信,這種免去輸入繁瑣的賬號密碼,拿起手機掃一掃就可以登錄的方式一開始還是比較驚艷的,確實使用起來很方便。 那它是如何實現的呢?我們來簡單研究下。(以淘寶網二維碼登錄為例) 首先,任何一個二維碼表示的都是一串字元串。 我們打開淘寶登錄頁面: "https://log ...
  • 第一次作業 第一次作業需要完成的任務為簡單多項式導函數的求解。 思路 因為僅僅是簡單多項式的求導,所以求導本身沒有什麼可說的,直接套用冪函數的求導公式就行了,主要的精力是花在了正則表達式上。這裡推薦兩個網站: https://github.com/ziishaned/learn regex http ...
  • 第一單元總結 作業總結 一 程式結構分析 ​ 因為在此之前並沒有接觸過 java 語言或者是與之相似的語言, 而不用說 OO 的概念, 所以一切都是全新的. 開始的時候腦子並沒有任何面向對象的概念, 類這個概念僅僅建立在 C 語言的某個 .c 文件之上, 簡單地認為 java 中的類就是 C 中的 ...
  • 目錄 homework & class & trainning : 兩次上機、三次作業、四周課堂 code analysis & review : 為什麼我沒有bug 黑盒測試和白盒測試 OO 設計感言 Scanning: Creational Pattern & Multithreading 一、 ...
  • 背景 應該是在去年的時候,刷知乎看到一個問題,大概是說怎麼刷網易雲音樂個人累計聽歌數,然後有一個高贊回答,貼了一段js代碼,直接在瀏覽器console執行就可以了。當時試了下,直接一下子刷了有好幾萬。悲劇的是,第二天又回到原來的樣子了,很明顯這種方式被網易雲音樂發現封掉了。而且後續網易雲還針對累計聽 ...
  • 如果你對 Spring Cloud 體系還不是很瞭解,可以先讀一下 "Spring Cloud 都有哪些模塊" Eureka 是 Netflix 開源的服務註冊發現組件,服務發現可以說是微服務架構的核心功能了,微服務部署之後,一定要有服務註冊和發現的能力,Eureka 就是擔任這個角色的。如果你用過 ...
  • 對於同餘式 $$x^2 \equiv n \pmod p$$ 若對於給定的$n, P$,存在$x$滿足上面的式子,則乘$n$在模$p$意義下是二次剩餘,否則為非二次剩餘 我們需要計算的是在給定範圍內所有滿足條件的$x$,同時為了方便,我們只討論$p$是奇質數的情況 前置定理 $x^2 \equiv ...
一周排行
    -Advertisement-
    Play Games
  • 前言 本文介紹一款使用 C# 與 WPF 開發的音頻播放器,其界面簡潔大方,操作體驗流暢。該播放器支持多種音頻格式(如 MP4、WMA、OGG、FLAC 等),並具備標記、實時歌詞顯示等功能。 另外,還支持換膚及多語言(中英文)切換。核心音頻處理採用 FFmpeg 組件,獲得了廣泛認可,目前 Git ...
  • OAuth2.0授權驗證-gitee授權碼模式 本文主要介紹如何筆者自己是如何使用gitee提供的OAuth2.0協議完成授權驗證並登錄到自己的系統,完整模式如圖 1、創建應用 打開gitee個人中心->第三方應用->創建應用 創建應用後在我的應用界面,查看已創建應用的Client ID和Clien ...
  • 解決了這個問題:《winForm下,fastReport.net 從.net framework 升級到.net5遇到的錯誤“Operation is not supported on this platform.”》 本文內容轉載自:https://www.fcnsoft.com/Home/Sho ...
  • 國內文章 WPF 從裸 Win 32 的 WM_Pointer 消息獲取觸摸點繪製筆跡 https://www.cnblogs.com/lindexi/p/18390983 本文將告訴大家如何在 WPF 裡面,接收裸 Win 32 的 WM_Pointer 消息,從消息裡面獲取觸摸點信息,使用觸摸點 ...
  • 前言 給大家推薦一個專為新零售快消行業打造了一套高效的進銷存管理系統。 系統不僅具備強大的庫存管理功能,還集成了高性能的輕量級 POS 解決方案,確保頁面載入速度極快,提供良好的用戶體驗。 項目介紹 Dorisoy.POS 是一款基於 .NET 7 和 Angular 4 開發的新零售快消進銷存管理 ...
  • ABP CLI常用的代碼分享 一、確保環境配置正確 安裝.NET CLI: ABP CLI是基於.NET Core或.NET 5/6/7等更高版本構建的,因此首先需要在你的開發環境中安裝.NET CLI。這可以通過訪問Microsoft官網下載並安裝相應版本的.NET SDK來實現。 安裝ABP ...
  • 問題 問題是這樣的:第三方的webapi,需要先調用登陸介面獲取Cookie,訪問其它介面時攜帶Cookie信息。 但使用HttpClient類調用登陸介面,返回的Headers中沒有找到Cookie信息。 分析 首先,使用Postman測試該登陸介面,正常返回Cookie信息,說明是HttpCli ...
  • 國內文章 關於.NET在中國為什麼工資低的分析 https://www.cnblogs.com/thinkingmore/p/18406244 .NET在中國開發者的薪資偏低,主要因市場需求、技術棧選擇和企業文化等因素所致。歷史上,.NET曾因微軟的閉源策略發展受限,儘管後來推出了跨平臺的.NET ...
  • 在WPF開發應用中,動畫不僅可以引起用戶的註意與興趣,而且還使軟體更加便於使用。前面幾篇文章講解了畫筆(Brush),形狀(Shape),幾何圖形(Geometry),變換(Transform)等相關內容,今天繼續講解動畫相關內容和知識點,僅供學習分享使用,如有不足之處,還請指正。 ...
  • 什麼是委托? 委托可以說是把一個方法代入另一個方法執行,相當於指向函數的指針;事件就相當於保存委托的數組; 1.實例化委托的方式: 方式1:通過new創建實例: public delegate void ShowDelegate(); 或者 public delegate string ShowDe ...