コンテンツにスキップ

Python/black

出典: フリー教科書『ウィキブックス(Wikibooks)』

blackは、Pythonコードの自動整形ツールです。コードのフォーマットを一貫性のあるスタイルに自動的に整えるために使われます。主にPEP 8(Pythonの公式スタイルガイド)に基づいていますが、blackはさらに独自のスタイルを持っており、コードの美しさや一貫性を保つために厳格なルールを適用します。

blackの特徴

[編集]
  1. 自動整形: blackは、コードのインデントやスペース、改行、並び順などを自動的に整形します。これにより、開発者が手動でスタイルを気にすることなく、チーム全体で一貫したコードスタイルを保つことができます。
  2. 無駄な設定なし: blackは、設定オプションを最小限にしており、特に設定しなくてもある程度のスタイルが自動的に適用されます。例えば、行の長さや改行の処理などに関して、一貫性を持たせることができます。
  3. 一貫性のあるコードスタイル: blackは、他のツールや手作業でコードを整形する際に起こりがちなスタイルのばらつきを防ぎます。これにより、コードレビューの際にスタイルに関する議論を減らし、ロジックや機能に集中できます。
  4. コマンドラインツール: blackはコマンドラインから簡単に実行でき、ディレクトリ内のすべてのPythonファイルを整形することができます。また、IDE(統合開発環境)やエディタと連携させて、コードを保存するたびに自動で整形することも可能です。
  5. 行の長さの制限: blackはデフォルトで行の長さを88文字に制限していますが、この長さもオプションで変更可能です。

blackの使用方法

[編集]

インストール:

pip install black

コード整形:

black <ファイル名またはディレクトリ>

例えば、プロジェクト内のすべてのPythonファイルを整形したい場合は、次のように実行します:

black .

例: black適用前と適用後

[編集]

変更前(整形されていないコード)

[編集]
def greet(name:str)->str:
  if name == 'Alice':return 'Hello Alice!'
  return 'Hello ' + name

変更後(blackによって自動整形されたコード)

[編集]
def greet(name: str) -> str:
    if name == "Alice":
        return "Hello Alice!"
    return "Hello " + name

まとめ

[編集]

blackは、コードのフォーマットを一貫して適用するための強力なツールであり、特に大規模なチームでの開発において役立ちます。コードスタイルに関する議論を最小限に抑え、コードの可読性と保守性を高めることができます。