Python開発環境　Linter, Formatterの設定

VSCodeでPythonを使っていると右下にやたらとLinterやFormatterのポップアップが表示されます。
適当に流していましたが、最近、本格的にPythonを使用することも多くなったので、LinterとFormatterについて調べました。

Formatterの導入

今回はblackを使用します。PEP8というPythonのコーディング規約に準拠しているそうです。
blackはデメリットとして、カスタマイズがほとんどできないという点があります。
こだわりはないので、今回はblackを使用します。

以下の拡張機能をインストールすることで設定が完了します。

Linterの導入

flake8を使用します。PythonのLinterの中では有名なもののひとつです。
pipでインストールします。

pip install flake8

Pythonのデフォルトの拡張機能を入れておけば、Linterは適応されるようになります。

VSCodeの設定

以下に設定しておきます。

setting.json

{
  "[python]": {
    "editor.defaultFormatter": "ms-python.black-formatter"
  },
  "python.linting.enabled": true,
  "python.linting.flake8Enabled": true,
  "python.linting.flake8Args": [
    "--max-line-length=88",
    "--ignore=E203"
  ],
  "python.formatting.provider": "black",
}

blackのFormatはflakeのmax-line-lengthとE203に引っかかるので、flakeの設定を変更しています。エラーとして表示させないように設定を上書きしています。

参考