Black - コード自動フォーマット
Blackは、Pythonのコードフォーマッタです。Flake8がスタイル違反を「指摘」するのに対し、Blackはコードを自動的に「修正」します。Blackは「The Uncompromising Code Formatter」(妥協のないコードフォーマッタ)を謳っており、設定項目が少なく、チーム全体で統一されたスタイルを強制できます。
1. フォーマット前の確認
本節では、まずBlackがサンプルコードのどこを変更するかを、--checkオプションで確認します。
Windowsの場合:
black --check src/
Macの場合:
python3 -m black --check src/
以下のように、フォーマットが必要なファイルが表示されます。
would reformat src/calculator.py
would reformat src/user_service.py
Oh no! 💥 💔 💥
2 files would be reformatted.
calculator.pyとuser_service.pyにフォーマットが必要な箇所があることが検出されています。--checkオプションはコードを変更せず、確認のみを行います。
2. Blackの実行
以下のコマンドでBlackを実行し、コードを自動フォーマットします。
Windowsの場合:
black src/
Macの場合:
python3 -m black src/
以下のように、フォーマットが実行された結果が表示されます。
reformatted src/calculator.py
reformatted src/user_service.py
All done! ✨ 🍰 ✨
2 files reformatted.
calculator.pyとuser_service.pyの両方が自動フォーマットされたことが表示されています。
フォーマット後のsrc/calculator.pyを確認すると、スペースの問題が自動的に修正されていることがわかります。
import os
import sys
def add(a, b):
return a + b
def subtract(a, b):
return a - b
def multiply(a, b):
result = a * b
return result
def divide(a, b):
if b == 0:
return "error"
return a / b
unused_variable = "this is never used"
def evaluate_score(score):
if score >= 95:
return "S"
elif score >= 90:
return "A+"
elif score >= 85:
return "A"
elif score >= 80:
return "B+"
elif score >= 75:
return "B"
elif score >= 70:
return "C+"
elif score >= 65:
return "C"
elif score >= 60:
return "D+"
elif score >= 55:
return "D"
elif score >= 50:
return "E"
else:
return "F"
| 📝 Flake8とBlackの違い |
|---|
| Flake8は問題を「検出」し、Blackは問題を「自動修正」します。両方を併用することで、自動修正できない論理的な問題(未使用のインポートなど)もFlake8で検出できます。 |
3. Blackの設定
BlackもFlake8と同様に、プロジェクトに合わせた設定のカスタマイズができます。たとえば、Blackはデフォルトで1行の最大文字数が88文字に設定されていますが、Flake8の.flake8ファイルではmax-line-length = 120に設定しました。このままでは、Blackが88文字で折り返したコードをFlake8が問題なしと判定するなど、ツール間でルールが食い違う可能性があります。
Blackの設定はpyproject.tomlファイルに記述します。プロジェクトのルートにpyproject.tomlを作成します。Visual Studio Codeのエクスプローラーでpython-static-analysisフォルダを右クリックし、「新しいファイル」を選択してpyproject.tomlという名前で作成してください。
python-static-analysis
├── src
│ ├── __init__.py
│ ├── calculator.py
│ └── user_service.py
├── .flake8
├── pyproject.toml ← このファイルを作成
└── requirements.txt
作成したファイルに以下の内容を記述して保存します。
[tool.black]
line-length = 120
line-length = 120により、Blackが1行を折り返す基準を120文字に変更しています。これでFlake8のmax-line-length = 120と統一され、ツール間でルールが矛盾しなくなります。
Blackは「妥協のないフォーマッタ」を謳っており、意図的に設定項目が少なく設計されています。主な設定項目は以下のとおりです。
| 設定項目 | 説明 | デフォルト値 |
|---|---|---|
line-length |
1行の最大文字数 | 88 |
target-version |
対象のPythonバージョン(例: ["py312"]) |
自動検出 |
skip-string-normalization |
文字列のクォート統一(シングル→ダブル)を無効化 | false |
extend-exclude |
除外するファイル・フォルダのパターンを追加 | なし |
今回のハンズオンではline-lengthのみ設定していますが、必要に応じて他の設定も追加できます。