Python入門 (13) - black

Pythonのフォーマッター「black」の使い方をまとめました。

前回

1. blackの使い方

「black」は、Pythonコードをコーディング規約(PEP)準拠に自動修正するフォーマッターです。

自動フォーマッターには、「autopep8」「yapf」などありますが、「black」はより制限が強く、PEP8で規定されていない、改行やシングルクォートやダブルクォートなどの書き方も統一してくれます。

GitHub - psf/black: The uncompromising Python code formatter

◎ インストール
Pythonの仮想環境で、以下のコマンドを実行します。

$ pip install black

◎ 使い方
使い方は、次のとおりです。

$ black <対象ファイル>

例えば、以下のコード「hello.py」をチェックします。

import os

str  =     'Hello black!'

print(    str)

シングルクォートやダブルクォートも含めて自動修正できていることがわかります。

import os

str = "Hello black!"

print(str)

2. VSCodeの設定

VSCodeで「Flake8」「black」を利用するには、次のように設定します。

    "python.linting.enabled": true, // Lintの有効化
    "python.linting.pylintEnabled": false, // pylintの無効化
    "python.linting.flake8Enabled": true, // flake8の有効化
    "python.linting.lintOnSave": true, // ファイル保存時のlint実行
    "python.formatting.provider": "black", // フォーマッタにblack
    "editor.formatOnSave": true, // ファイル保存時にフォーマッタ実行
    "python.linting.flake8Args": ["--ignore=E501"], // 1行の文字数制限を無視

次回