psf/black

これは何？

主な機能

• 01少数の固定されたスタイル設定で、Pythonファイルをその場で整形します。
• 02差分を最小限に抑え、コードレビューで内容に集中できるようにします。
• 03デフォルトで、整形後のコードが元のコードとAST上で同等であることを確認します。
• 04jupyter extraを指定してインストールすると、Jupyter Notebooksを整形できます。
• 05プロジェクト設定をpyproject.tomlから読み込みます。

ユースケース

• Pythonチームやリポジトリ全体で、一貫したコードスタイルを徹底する。
• pre-commitフックやCIで自動実行し、フォーマットをチェックする。
• 通常のソースファイルとあわせて、Jupyter Notebooks内のPythonコードを整形する。

クイックスタート

1. 1

   pipでBlackをインストールする

   pip install black
2. 2

   ファイルまたはディレクトリをフォーマットする

   black {source_file_or_directory}

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

• !実行にはPython 3.10以降が必要です。

トピック

よくある質問

black とは？

Blackは、ファイルをその場で書き換え、差分を最小限に抑える、独自の方針を持つ決定論的なPythonコードフォーマッターです。 Blackは、独自の方針を持つPythonコードフォーマッターです。スタイル設定を意図的に少数に絞り、ファイル全体をその場で整形することで、プロジェクト間でコードの見た目を統一し、フォーマットをめぐる議論を避けられます。差分を可能な限り小さくするよう設計されているため、コードレビューでは内容に集中できます。

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

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

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

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

black は何に使えますか？

Pythonチームやリポジトリ全体で、一貫したコードスタイルを徹底する。 pre-commitフックやCIで自動実行し、フォーマットをチェックする。 通常のソースファイルとあわせて、Jupyter Notebooks内のPythonコードを整形する。

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

pipでBlackをインストールする: pip install black ファイルまたはディレクトリをフォーマットする: black {source_file_or_directory}

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

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