peterjc/flake8-black

これは何？

主な機能

• 01blackが再フォーマットするファイルを、flake8のBLK100違反として報告します。
• 02pyproject.tomlからline_lengthやtarget_versionなどのblack設定を読み込みます。
• 03共有設定ファイルを指定する--black-configオプションに対応しています。
• 04読み取り不能なファイルや不正なTOMLなどの内部エラーを、BLK9xxコードで報告します。
• 05PyPIまたはconda-forgeからインストールできます。

ユースケース

• CIでblackのスタイルチェックを他のflake8ルールと合わせて実行する。
• gitのpre-commitフックで一貫したフォーマットを徹底する。
• 複数のPythonプロジェクトでblackの設定を共有する。

クイックスタート

1. 1

   pip を使って PyPI からプラグインをインストールします

   pip install flake8-black
2. 2

   Python ファイルに対して flake8 を実行し、BLK コードを確認します

   flake8 example.py

使う前に知っておきたいこと

• !black の include および exclude 設定は反映されないため、該当ファイルは flake8 側で個別に除外する必要があります。
• !README に記載のとおり、バージョン 0.3.7 以降は black 25.9.0 では動作しません。この問題を修正する v0.4.0 はリリース待ちです。

収録されている特集

トピック

よくある質問

flake8-black とは？

blackのチェックモードを実行し、フォーマットの差異をflake8のBLK違反として報告するプラグイン。 flake8-blackは、flake8によるlintの一環としてblackをチェックモードで実行するflake8プラグインです。blackが再フォーマットするファイルはBLK100違反として報告されるため、他のlintルールと同じflake8コマンドでblackのスタイルチェックも実行できます。

flake8-black は無料で使えますか？ライセンスは？

flake8-black は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

flake8-black は今もメンテナンスされていますか？

活発にメンテナンス中。flake8-black の最終コミットは 2026年11月3日 です。

flake8-black は何に使えますか？

CIでblackのスタイルチェックを他のflake8ルールと合わせて実行する。 gitのpre-commitフックで一貫したフォーマットを徹底する。 複数のPythonプロジェクトでblackの設定を共有する。

flake8-black のインストール方法は？

pip を使って PyPI からプラグインをインストールします: pip install flake8-black Python ファイルに対して flake8 を実行し、BLK コードを確認します: flake8 example.py

flake8-black はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/peterjc/flake8-black