【Python】VSCodeにBlack Formatterを導入する

2024年2月18日Python,エンジニアリングPython,VSCode,フォーマッタ

チームで開発をするとき、一般的にソースコードにはフォーマッタをかけることが多い。

特に、コードに一貫性を持たせるのに役立ち、チームで同一のスタイルで書くためにフォーマッタを導入する。
また、手動でコードを整理する手間も省けるので、開発者はコードの論理的な構造の作成に集中できる。

仮にチームで開発しなくても、同一プロジェクトなのにファイルごとに書き方が違って統一感がなかったり、過去のコードを見て読みづらかったりするので、個人でも導入すべきである。

Black Formatterの導入

Pythonにはいくつかメジャーなフォーマッタが存在するが、ここではBlackを紹介する。

拡張機能のインストール

拡張機能の検索で「Black Formatter」と検索する。

Black Formatterをインストールする。

Blackフォーマッタの設定

VSCode上の設定は、ワークスペースに.vscodeというフォルダを作成し、settings.jsonというファイルに以下を記入する。

{
    "[python]": {
        "editor.defaultFormatter": "ms-python.black-formatter",
        "editor.formatOnSave": true
    },
    "black-formatter.args": [
        "--line-length=88"
    ]
}

3行目でBlackフォーマッタの使用を宣言し、4行目で保存時にフォーマッタが適用されるようになる。

また、7行目の–line-lenghtで1行の長さを決めている。
PEP8の規約上は79文字となっているが、79文字だと短すぎて逆に可読性が下がるので、コーディング規約のゆるい開発現場では、100文字や120文字などに設定することもある。
ちなみに、Blackフォーマッタのデフォルトは79文字ではなく88文字となっている。(なので、この場合はこのパラメータを設定する必要はない)