pyrightの使い方

https://github.com/microsoft/pyright

pyrightとは？

• microsoft製のpython静的型チェックツール
• python組み込みのtypehintをベースに静的型検査を行ってくれる

pyrightの使用方法

以下のコマンドでインストール.npmは必要.

npm install -g pyright

その後以下のコマンドでチェックを実施.

pyright -p

ファイルの変更を検知して自動でチェックすることもできる.

pyright -w

外部ライブラリのためのstubファイルの生成

外部ライブラリを使用するときそのライブラリに型がつけられていないとpyrightに怒られる.
そのときにstubファイルというものが配布されていれば怒られないのだが、ない場合が多い.
pyrightはstubファイルのドラフト版を自動生成することができるので、それらのファイル内の使用したいメソッドに型をつけてあげれば良い.

以下のコマンドでstubのドラフトが自動生成される.
作成されるディレクトリは何も指定しないとtypings以下。

pyright --createstub <library-name>

NOTE
library-nameはpipでinstallするときの名前ではなく、source codeでimportするときの名前

設定ファイル

• プロジェクト直下にpyrightconfig.jsonという名前で設定ファイルを用意する

sample

{
  "pythonVersion": "3.7",
  "ignore": ["raspi_submodule/**", "typings/**", "tests/**"],
  "strict": ["**"]
}

設定項目

• pythonVersion: 指定したpythonのversionで互換性のある書き方かチェックしてくれる
• strict: チェックが厳しくなる(これが全部onになる)、ディレクトリ、ファイルを配列で指定する
• ignore: チェックを無視する、ディレクトリ、ファイルを配列で指定する