環境
- Windows 10
- Python 3.10.1
- VSCode
動作イメージ
静的解析ができるようになると、例えば、関数の返り値の型を指定しないとエラーが表示されたり、
型の指定が誤っているとエラーを表示してくれる
設定手順
mypy
標準ライブラリではないので、インストールが必要
※Python3.6以降であることが条件です
pip install mypy
vscode
ms-python.pythonで検索して出てくる「Python」をインストールする
コマンドパレット(ctrl + shift + P)を開き、vscodeのselect linterでmypyを選択する
これだけで最低限の設定は完了です。あとは必要に応じて、設定ファイルを調整します
設定ファイルは、プロジェクトのルートディレクトリに、mypy.ini (あるいはsetup.cfg)という名称 で作成し、配置します。詳細な設定値はドキュメントを参照してください。
https://mypy.readthedocs.io/en/stable/config_file.html
Tips
特定箇所の型チェックエラーを無視したい場合
該当箇所に# type: ignoreとコメントすることでlinterから除外可能
# type: ignore
def get_path(self):
return self.path
まとめ
いかがでしたでしょうか。本記事では、vscodeの拡張機能を使用して、mypyでPythonスクリプトの静的解析を行う方法について紹介しています。ぜひ参考にしてみてください。