【VSCode対応】PythonのBlackフォーマッタを使う方法

BlackはPythonのコードを整形してくれるツールです。

例えば次のような汚いコードがあったとします。

def calculate_sum(a,b): return a+b
def multiply(x,y):return x*y
def main():
 x = 10
 y = 20
 sum_result=calculate_sum(x,y)
 product =multiply(x,y)
 print(f"Sum: {sum_result}, Product: {product}")
main()

Blackを適用すると、この通り。

def calculate_sum(a, b):
    return a + b


def multiply(x, y):
    return x * y


def main():
    x = 10
    y = 20
    sum_result = calculate_sum(x, y)
    product = multiply(x, y)
    print(f"Sum: {sum_result}, Product: {product}")


main()

Visual Studio Code（VSCode）でBlackを設定しておけば、保存のたびに整形してます。

便利すぎるので、僕は真っ先に導入します。

本記事では、Blackの導入方法を解説します。

Visual Studio CodeでBlackを設定する2つの方法

VSCodeでBlackを設定する方法は、以下の2つです。

2つとも設定した場合には、settings.jsonで設定した内容が優先されます。

0. 事前準備

VSCodeでBlackを使うには、プラグインのインストールをしましょう。

» 参考：Black Formatter – Visual Studio Marketplace

Installボタンをクリックするとポップアップが開くので、Continueをクリックしてインストールを進めて下さい。

Microsoftが提供するプラグインなので安心です。

1. settings.jsonを使う方法

まずは以下のコマンドでコマンドパレットを表示させます。

すると、以下のようなコマンドパレットが表示されます。

そこに、以下を入力してEnterを押しましょう。

Preferences: Open User Settings (JSON)

以下をsettings.jsonに追加すればOKです。

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

これにより、Pythonファイルを保存するたびにBlackが適用されます。

2. pyproject.tomlを使う方法

pyproject.tomlでBlackの設定を管理したい場合は、以下のようにVSCodeに指示を追加します。

"black-formatter.args": ["--config", "pyproject.toml"]

その上で、Blackの設定が適用されているかどうか、下記コマンドを実行して確認してください。

black --config pyproject.toml .

コマンドライン上から実行したい場合は？

コマンドラインから実行したい場合の手順は以下の通り。

順番に解説します。

pip install black

black .

black manage.py

まとめ

BlackはPythonの超強力なフォーマッタです。

特に今回ご紹介したようなVisual Studio Codeとの組み合わせで使うと、飛躍的にコーディングの効率が上がります。

ぜひ、本記事を参考に導入を進めてみて下さい！