【VSCode】拡張機能「Black Formatter」の使い方

VSCodeの拡張機能「Black Formatter」の使い方を解説します。

拡張機能「Black Formatter」の導入と基本操作
関連ページ

拡張機能「Black Formatter」の導入と基本操作

Pythonのコーディング規約（PEP 8）に準拠した自動整形を行ってくれます。コーディング規約とは、プロジェクトやチーム全体で「コードを書くときのルールや推奨事項」をまとめたドキュメントです。PEP 8はPython公式のコーディング規約です。以下は、Black Formatterで整形したときの実行例です。

【整形前】

def foo(bar,  baz=  None):
    x= [1,2,3,
4,5 ]
    if(bar and  baz):
       return{x:bar+baz}
    return    x

【整形後】

def foo(bar, baz=None):
    x = [1, 2, 3, 4, 5]
    if bar and baz:
        return {x: bar + baz}
    return x

引数のスペース、リスト要素のカンマ区切り＆改行、インデント幅や波括弧周りの一貫性などが「Black Formatter」によって自動的に修正されています。「Black Formatter」の導入と設定方法は以下のとおりです。

① VSCodeの左サイドバー拡張機能から拡張機能「GitHub Copilot」を検索してインストールします。

② ショートカット「Ctrl + Shift + P」でコマンドパレットを表示し、以下を入力してEnterを押しましす。

Preferences: Open User Settings (JSON)

③ 以下をsettings.jsonに追加します。

{
    "[python]": {
        // BlackをPythonのデフォルトフォーマッターに指定
        "editor.defaultFormatter": "ms-python.black-formatter",
        // 保存時にBlackを適用
        "editor.formatOnSave": true
    },
    // 1行の文字数の上限を120文字に設定
    "black-formatter.args": ["--line-length=120"]
}

④ これにより、Pythonファイルを保存するたびにPEP-8に準拠した自動整形が適用されます。