Pythonのコードを何も考えずにフォーマットする方法

Last updated at 2023-09-25Posted at 2019-09-24

2023/09 更新
black + ruff を使うようになりました。

2021/07 更新

pfnet/pysen を使うのが良いと思います。

ライブラリに任せる。

使うライブラリ

importのソートをしてくれる
$ isort -rc -sl .で、importをすべて1行のimportに変換してくれる。
$ isort -rc -m 3 .で、importをすべて複数行のimportに変換してくれる。

pyflakesによって報告された未使用のインポートと未使用の変数を削除する。
複数行importの未使用importは削除してくれないので、前後にisortで整える。

妥協のないPythonコードフォーマッター

$ pipenv install isort autoflake black

Makefile

fix:
	isort -rc -sl .
	autoflake -ri --remove-all-unused-imports --ignore-init-module-imports --remove-unused-variables .
	black .
	isort -rc -m 3 .

$ pipenv run make fix