フォーマッタしたい(black

$ black .

blackはPEP8準拠したフォーマッタです。 初期設定不要なことが特徴で、インストールしてすぐに使うことができます。

注釈

Pythonのフォーマッターはいろいろありますが、 それぞれ初期設定が必要で初心者にはとっつきにくい面がありました。 2018年に登場したblackは「フォーマッターを導入してみようかな」という 気持ちにさせてくれるツールでした。

インストールしたい(black

$ pip3 install black
$ pip3 install "black[jupyter]"

Jupyter Notebookもフォーマット対象にしたい場合は black[jupyter]のオプションをつけてインストールします。

フォーマットしたい

$ black .

カレントディレクトリの下にある対象ファイルを修正します。

フォーマットを確認したい

$ black --check .

--checkオプションで、修正が必要なファイルがあるかを確認します。

部分的に除外したい(fmt: skip / fmt: on / fmt: off

1skip_line = True # fmt: skip
2
3# fmt: off
4def skip_block():
5    pass
6# fmt: on

# fmt:skipを行末に追加すると、その1行をスキップできます。 # fmt:off# fmt:onで囲むと、ブロックごとスキップできます。

blackは細かな設定ができませんが、このようにして 部分的に除外できるようになっています。