Black コードスタイル¶

Black は、PEP 8 に準拠した独自のスタイルを持つ意見の強いフォーマッターです。

リリース全体を通してスタイルを一定に保つことが常に目標でしたが、Black のコードスタイルは固定されたものではありません。Python 言語の新機能に対応するため、また、ユーザーからのフィードバックに応えて、進化します。 Black コードスタイルに示されている大規模なスタイルの好みは変更される可能性は低いですが、マイナーなスタイルの側面や詳細は、以下に示す安定性ポリシーに従って変更される可能性があります。継続的なスタイルの検討事項は、GitHub の style Issue ラベルで追跡されます。

安定性ポリシー¶

以下のポリシーは、Black の非プレリリースバージョンの Black コードスタイルに適用されます。

コードが Black でフォーマットされている場合、同じカレンダー年の他のリリースを使用して同じオプションでフォーマットした場合、変更されないままになります。

これは、プロジェクトが 2022 年にフォーマットの変更がプロジェクトを混乱させることを心配せずに、black ~= 22.0 を安全に使用できることを意味します。Black が一部のコードでクラッシュするバグを修正したり、フォーマットに影響を与えない他の改善を行う可能性はあります。

まれに、以前に Black でフォーマットされていないコードに影響を与える変更を行う場合があります。たとえば、一部のコメントを誤って削除してしまったバグがありました。このようなバグは、安定性ポリシーを破ることなく修正できます。
新しいカレンダー年の最初のリリースには、フォーマットの変更が含まれる可能性がありますが、可能な限り最小限に抑えられます。これは、新しい Python 言語構文によって有効になったフォーマットの改善と、フォーマットロジックの改善によるものです。
--preview および --unstable フラグはこのポリシーから免除されます。これらのフラグが Black に渡された場合の出力の安定性に関する保証はありません。これらは、Black コードスタイルに対する提案された変更の実験を可能にすることを目的としています。年末の --preview スタイルは、翌年の安定したスタイルとほぼ一致する必要がありますが、常に変更を加える可能性があります。

現在および将来のスタイルの両方のドキュメントは以下にあります。