pyright - Python 的靜態型別檢查器

Contents

Pyright 是由微軟所維護的開源專案，它是一個快速的型別檢查器，可以在 “觀察 “模式下執行，並支援配置檔案，提供對設定的細化控制，以及支援型別檢查功能，如型別推斷、型別守衛和 VS Code 擴充套件，提供許多語言功能，如智慧型別完成、自動插入匯入語句、簽名完成提示等，並支援Vim、Emac、Sublime等編輯器，VS Code 建議使用 Pylance 擴充套件而不是 Pyright。

工具特色

速度
Pyright 是一個快速的型別檢查器，用於大型 Python 原始碼庫。它可以在 “觀察 “模式下執行，並在檔案被修改時執行快速增量更新。

可配置性
Pyright 支援配置檔案，提供對設定的細化控制。不同的 “執行環境 “可以與原始碼庫中的子目錄相關聯。每個環境可以指定不同的模組搜索路徑、python語言版本和平台目標。

型別檢查功能

PEP 484 type hints including generics
PEP 487 simpler customization of class creation
PEP 526 syntax for variable annotations
PEP 544 structural subtyping
PEP 561 distributing and packaging type information
PEP 563 postponed evaluation of annotations
PEP 570 position-only parameters
PEP 585 type hinting generics in standard collections
PEP 586 literal types
PEP 589 typed dictionaries
PEP 591 final qualifier
PEP 593 flexible variable annotations
PEP 604 complementary syntax for unions
PEP 612 parameter specification variables
PEP 613 explicit type aliases
PEP 635 structural pattern matching
PEP 646 variadic generics
PEP 647 user-defined type guards
PEP 655 required typed dictionary items
PEP 673 Self type
PEP 675 arbitrary literal strings
PEP 681 dataclass transform
PEP 692 (draft) TypedDict for kwargs typing
PEP 695 (draft) Type parameter syntax
PEP 696 (draft) Type defaults for TypeVarLikes
PEP 698 (draft) Override decorator for static typing
Type inference for function return values, instance variables, class variables, and globals
Type guards that understand conditional code flow constructs like if/else statements

VS Code 整合
Pyright 既是一個命令列工具，也是一個 VS Code 擴充套件，它提供了許多強大的功能，有助於提高程式設計效率。

VS Code 擴充套件功能
VS Code 擴充套件支援許多節省時間的語言功能，包括：

編輯時出現關鍵字、符號和匯入名稱的智慧型別完成
必要時自動插入匯入語句，進行型別補全
簽名完成提示在填寫呼叫的參數時提供幫助
將滑鼠懸停在符號上以提供型別資訊和文件字串
查詢定義以快速找到一個符號的定義的位置
查詢引用以查詢程式碼庫中對一個符號的所有引用
重新命名符號，重新命名程式碼庫中對一個符號的所有引用
查詢目前文件或整個工作區中的符號
檢視呼叫層次資訊–在一個函式中進行的呼叫和一個函式被呼叫的地方
組織進口命令，根據 PEP8 規則自動排序 import 。
為第三方程式庫產生型別存根

VS Code 擴充套件

對於大多數 VS Code 使用者來說，建議使用 Pylance 擴充套件而不是 Pyright。Pylance 結合了Pyright的型別檢查器，但具有額外的功能，如IntelliCode和語義標記高亮。你可以直接從 VS Code 中安裝最新發布的 Pylance VS Code 擴充套件。只需打開擴充套件面板並搜索 “Pylance”。

還有支援 Vim 和 Emac 與 Sublime 等編輯器