リンターしたい（`ruff`）

$ pip3 install ruff

Rustで書かれたPython用のリンター&フォーマッタです。これまでblack、isort、flake8を組み合わせてできたことをruffに集約できます。設定をpyproject.tomlに記述できるため、既存のPythonプロジェクトにも導入しやすいと思います。

注釈

Pythonのリンター＆フォーマッタの変遷は闇が深そうです。時代とともにベストプラクティスが移り変わっている感じで、これを使っておけばOKみたいな標準的なモジュールが存在しません。

数年前に「設定不要のフォーマッタ」を謳ったblackが登場しました。インストールしてそのまま使えるため、逆に導入しやすいと感じました。

リンターはflake8を使ってみようと思ったのですが、たしかpyproject.tomlに対応しておらず断念。型チェッカーにmypyを使ってみようと思ったのですが、そもそも型アノテーションをうまく設定できておらず、こちらも断念しました。

ruffの基本コマンドは簡単なので、今度こそ身につけられるのではと期待しています。

リンターしたい

$ ruff check ファイル名
$ ruff check ファイル名 --select カテゴリ記号

checkコマンドでリンターを実行します。引数にファイル名を指定したり、確認したいディレクトリでruff check .を指定したりできます。 --selectオプションを使って、チェックしたいカテゴリーやエラー番号などを指定できます。

修正箇所はターミナルに出力されます。ファイル内容は変更されないので、とりあえず--select ALLでチェックして、どのリンターを有効にするといいか検討してみるといいと思います。

$ ruff check . --select ALL

$ ruff format ファイル名

formatコマンドでフォーマッターとして利用できます。引数にファイル名を指定したり、確認したいディレクトリでruff format .を指定して実行します。

selectやignoreで設定できるカテゴリ記号は公式ドキュメントの「ルール」に書いてあります。どんなものがあるかなと思って書き写してみたら、なんと58種類もありました。