VS Codeとの連携

ここまで、ターミナルからコマンドを実行して静的解析を行ってきました。しかし、毎回コマンドを手動で実行するのは手間がかかります。VS Codeの拡張機能を使うことで、コードを編集・保存するたびに自動的にチェックやフォーマットが実行されるようになります。

1. 拡張機能のインストール

以下の4つの拡張機能をVS Codeにインストールします。VS Codeの左側のサイドバーから「拡張機能」アイコン(四角が4つ並んだアイコン)をクリックし、検索バーに拡張機能名を入力してインストールしてください。

拡張機能名 説明
Python(Microsoft) Python開発の基本拡張機能。他の3つの拡張機能が動作するために必要
Flake8(Microsoft) Flake8をVS Codeに統合し、コードのスタイル違反をエディタ上にリアルタイム表示する
Black Formatter(Microsoft) BlackをVS Codeに統合し、コードの自動フォーマットをエディタから実行できるようにする
Mypy Type Checker(Microsoft) mypyをVS Codeに統合し、型の不整合をエディタ上にリアルタイム表示する

拡張機能をインストールすると、Flake8やmypyのチェック結果がエディタ上に波線で表示されるようになります。波線にマウスカーソルを合わせると、エラーの内容が確認できます。

💡 ポイント
拡張機能をインストールした後、VS Codeを再起動すると確実に反映されます。また、プロジェクトで使用しているPythonインタプリタが正しく選択されているか確認してください。VS Code下部のステータスバーに表示されているPythonバージョンをクリックすると、インタプリタを切り替えることができます。

2. 保存時の自動フォーマット設定

Black Formatter拡張機能をインストールしただけでは、自動フォーマットは有効になりません。ファイルを保存するたびにBlackで自動フォーマットされるように設定を行います。

VS Codeのコマンドパレットを使ってsettings.jsonを開きます。Windowsの場合はCtrl + Shift + P、Macの場合はCmd + Shift + Pのキーボードショートカットでコマンドパレットを開いてください。

コマンドパレットが開いたら、Preferences: Open User Settings (JSON)と入力し、表示された候補を選択します。settings.jsonファイルが開きます。

settings.jsonを初めて編集する場合は、ファイルの内容が{}のみになっています。その場合は、以下の内容をそのまま記述してください。

{
    "[python]": {
        "editor.defaultFormatter": "ms-python.black-formatter",
        "editor.formatOnSave": true
    }
}

すでに他の設定が記述されている場合は、既存の設定を消さないように注意してください。以下の例のように、既存の設定の最後の行にカンマを追加し、その後に[python]の設定を追記します。

{
    "editor.minimap.enabled": false,
    "git.confirmSync": false,
    "[python]": {
        "editor.defaultFormatter": "ms-python.black-formatter",
        "editor.formatOnSave": true
    }
}

この例では、"git.confirmSync": falseの末尾にカンマを追加し、その後に"[python]"の設定ブロックを追記しています。

📝 JSON形式の注意点
settings.jsonはJSON形式のため、設定項目の間にはカンマが必要です。カンマが不足していたり、最後の項目の後にカンマがあるとエラーになります。追記した後、ファイル内に赤い波線が表示されていないか確認してください。

各設定項目の意味は以下のとおりです。

  • "editor.defaultFormatter": "ms-python.black-formatter" は、PythonファイルのフォーマッタとしてBlack Formatterを使用する設定です
  • "editor.formatOnSave": true は、ファイルを保存するたびに自動的にフォーマットを実行する設定です

この設定により、今後Pythonファイルを保存するたびにBlackによるフォーマットが自動的に実行されます。先ほどのハンズオンではターミナルからblack src/コマンドを手動で実行しましたが、この設定を行うことでコマンドを実行する手間がなくなり、常にフォーマットされた状態を保つことができます。