はじめに
pythonのコードフォーマッターとして「Black」について、特徴や使い方などの基本を理解したいと思い、「Black」について調べてみました。
Blackとは
特徴
・BlackはPythonコードフォマッター：2024/07/02現在、最新versionは24.4.2。
・BlackはPEP8に準拠：PEP8はPython自体の標準ライブラリなどに対するコーディング規約で、「インデント」や「1行の長さ」などに関するルールを適用します。
インストール方法とフォーマット方法
・インストール方法：以下コマンドでインストールし、実行するにはPython 3.8以降が必要です。
pip install black
・フォーマット方法：特定のファイルをフォーマットする際は、以下のように使用します。
black black_sample.py
Blackの利点
様々なツールと統合できる
Emacs、Vim、Visual Studio Code、Sublime Textなどのエディタに統合して使用できます。
Github Actionsのワークフロー内でもBlackを使用できます。
豊富なコマンドラインオプション
-lオプションで1行あたりの長さを指定したり、-diffオプションでファイルを書き換えずにBlackが行う変更をdiffとして出力するなど、様々なオプションがあります。
参考文献
本記事は以下情報を参考にして執筆しました。
・Blackのドキュメント
・BlackのpypiのWebサイト
・PEP8を読み解く