【mypy】vscodeの拡張機能でPythonスクリプトの静的解析を行う方法

環境

  • Windows 10
  • Python 3.10.1
  • VSCode

使用するソースコード

以下の公開リポジトリに置いています

GitHub - masayan1126/tao-py-py: pythonリポジトリ
pythonリポジトリ. Contribute to masayan1126/tao-py-py development by creating an account on GitHub.

動作イメージ

静的解析ができるようになると、例えば、関数の返り値の型を指定しないとエラーが表示されたり、

型の指定が誤っているとエラーを表示してくれる

設定手順

mypy

標準ライブラリではないので、インストールが必要

Python3.6以降であることが条件です

pip install mypy

vscode

ms-python.pythonで検索して出てくる「Python」をインストールする

コマンドパレット(ctrl + shift + P)を開き、vscodeのselect linterでmypyを選択する

これだけで最低限の設定は完了です。あとは必要に応じて、設定ファイルを調整します

設定ファイルは、プロジェクトのルートディレクトリに、mypy.ini (あるいはsetup.cfg)という名称 で作成し、配置します。詳細な設定値はドキュメントを参照してください。

The mypy configuration file — Mypy 0.941 documentation

Tips

特定箇所の型チェックエラーを無視したい場合

該当箇所に# type: ignoreとコメントすることでlinterから除外可能

# type: ignore
def get_path(self):
  return self.path

Python学習におすすめの書籍

独習Python/山田祥寛【3000円以上送料無料】
bookfan 1号店 楽天市場店
¥ 3,300(2022/02/05 17:20時点)
タイトルとURLをコピーしました