【Visual Studio Code】Pythonのコードフォーマッター設定を行う

はじめに

Visual Studio CodeでPythonの開発を行う際のコードフォーマット設定を行います。

参考

dev.classmethod.jp

事前準備

Visual Studio Codeの統合ターミナルで以下を実行します。

$ pip install flake8
$ pip install yapf

settings.jsonの設定変更

Visual Studio Codeの設定を変更します。 以下のタブを開きます。

• ファイル
  • 基本設定
    • 設定
      • ユーザー設定

ユーザー設定に以下を追加します。 pythonのインテンドは4の倍数であることを推奨しているため、インテンドは4を指定します。

"[python]": {
    # 以下追加
    "editor.tabSize": 4,
    "python.linting.flake8Enabled": true,
    "python.formatting.provider": "yapf"
},

コードフォーマットの実行

該当のソースを開き、右クリック→ドキュメントのフォーマットをクリックするとコードフォーマットが行われます。

また、settings.jsonに以下を追加することで、タイピング時、ペースト時、保存時にもコードフォーマットが行われるようになります。

"[python]": {
    "editor.formatOnType": true,
    "editor.formatOnPaste": true,
    "editor.formatOnSave": true,
},

おわりに

コードフォーマットを行わない場合は、flake8の静的解析チェックで、E111 indentation is not a multiple of four等のエラーが頻発すると思います。コードフォーマットを行い、きれいなソースにすることをお勧めします。