PyCharm + Black によるソースコードの自動整形

PyCharm では Python のソースコードを Black で自動フォーマットさせる方法は２つあります。

1. ファイルウォッチャー（File Watchers）を使う方法
2. Black ツールを使う方法

本記事では Black ツールを使う方法 を紹介します。この方法のデメリットは isort のファイルウォッチャーと競争して、isort がうまく動作しない場合があります。（私の環境では何度も再現されています）、isort ファイルウォッチャーと併用したい場合はお勧めしません。

手順は下記の通りになります。この手順は Python のプロジェクトが作成済みを前提としています。

1. ⌘Сmd + , で 設定 ウィンドウを開き → プロジェクト：<プロジェクト名> | Python インタープリター

2. + アイコンをクリック

3. キーワード black で検索し、表示された検索結果から black を選択 → パッケージのインストール をクリック

4. インストール完了したら 閉じる ボタンをクリック

5. 再度 設定 ウィンドウに戻り、サイドメニューから ツール | Black に移動

6. 実行モード：パッケージ にして、Black フォーマッターの使用 は、保存時 にチェックを入れます

7. 適用 → OK ボタンを順番にクリック

8. プロジェクトルートディレクトリで pyproject.toml ファイルを作成して以下の内容を追記します。

   1[tool.black]
   2line-length = 88