Pythonの開発において、コードの品質を保つためにはフォーマッターとリンターの設定が重要です。今回は、VSCodeでPythonの開発を行う際に、人気のあるフォーマッターであるblack
とリンターのflake8
を設定する方法について解説します。
blackとflake8のインストール
まずは、black
とflake8
をインストールしましょう。以下のコマンドを実行します。
pip install black
pip install flake8
VSCodeの設定
次に、VSCodeの設定を行います。設定内容の概要としては以下になります。
- ファイル保存時のFormatter, Linterの適用
- black, flake8の有効化
- pylintの無効化 (VSCodeのPython拡張機能で有効化されていなければ不要)
- flake8の設定ファイルのパス指定
具体的な設定内容は以下のようになります。
"[Python]": {
"editor.formatOnSave": true,
},
"python.linting.enabled": true,
"python.linting.lintOnSave": true,
"python.linting.pylintEnabled": false,
"python.linting.flake8Enabled": true,
"python.linting.flake8Args": [
"--config=${workspaceFolder}/.flake8"
],
"python.formatting.provider": "black",
まとめ
以上が、VSCodeでPythonのblackとflake8を設定する方法です。これらの設定を行うことで、Pythonファイルの保存時にblackとflake8が適用され、コードの品質を一定に保つことができます。開発効率の向上とコードレビュー時の労力削減等に効果があると期待しています。