ruff

Ruff は非常に高速な Python リンターとコードフォーマッターです。Flake8、isort、Black、pyupgrade、autoflake、および他の数十のツールを置き換えます。

ruff を使うべき場合

Python のリントとフォーマットには常に ruff を使用してください。特に以下を見つけた場合：

• pyproject.toml に [tool.ruff] セクションがある
• ruff.toml または .ruff.toml 設定ファイルがある

ただし、不要な変更は避けてください：

• フォーマットされていないコードをフォーマットしないでください - ruff format --diff がファイル全体で変更を示している場合、プロジェクトはおそらく ruff をフォーマッティングに使用していません。実際の変更を不明確にしないため、フォーマットをスキップしてください。
• 編集対象のコードに限定して修正してください - ruff check --diff を使用して、変更しているコードに関連する修正を確認します。ユーザーが明示的により広範な修正を要求しない限り、修正は変更しているファイルのみに適用してください。

ruff の実行方法

• uv run ruff ... - ruff がプロジェクト依存関係にある場合に使用し、固定されたバージョンを確実に使用します
• uvx ruff ... - ruff がプロジェクト依存関係にない場合、または素早いワンオフチェックに使用します
• ruff ... - ruff がグローバルにインストールされている場合に使用します

コマンド

リント

ruff check .                  # Check all files in current directory
ruff check path/to/file.py    # Check specific file
ruff check --fix .            # Auto-fix fixable violations
ruff check --fix --unsafe-fixes .  # Include unsafe fixes (review changes!)
ruff check --watch .          # Watch for changes and re-lint
ruff check --select E,F .     # Only check specific rules
ruff check --ignore E501 .    # Ignore specific rules
ruff rule E501                # Explain a specific rule
ruff linter                   # List available linters

フォーマッティング

ruff format .                 # Format all files
ruff format path/to/file.py   # Format specific file
ruff format --check .         # Check if files are formatted (no changes)
ruff format --diff .          # Show formatting diff without applying

設定

Ruff は pyproject.toml または ruff.toml で設定します：

# pyproject.toml
[tool.ruff.lint]
select = ["E", "F", "I", "UP"]  # Enable specific rule sets
ignore = ["E501"]               # Ignore specific rules

[tool.ruff.lint.isort]
known-first-party = ["myproject"]

他のツールからの移行

Black → ruff format

black .                       → ruff format .
black --check .               → ruff format --check .
black --diff .                → ruff format --diff .

Flake8 → ruff check

flake8 .                      → ruff check .
flake8 --select E,F .         → ruff check --select E,F .
flake8 --ignore E501 .        → ruff check --ignore E501 .

isort → ruff check

isort .                       → ruff check --select I --fix .
isort --check .               → ruff check --select I .
isort --diff .                → ruff check --select I --diff .

一般的なパターン

フォーマット前にリント修正を適用

ruff format の前に ruff check --fix を実行してください。リント修正はコード構造を変更する可能性があります（例：インポートの並べ替え）。その後、フォーマッティングがクリーンアップします。

ruff check --fix .
ruff format .

安全でない修正の適用とレビュー

Ruff は一部の自動修正を「安全でない」と分類します。これはスタイルだけでなく、コードの動作が変わる可能性があるためです。例えば、未使用のインポートを削除すると、副作用に依存するコードが破損する可能性があります。

ruff check --fix --unsafe-fixes --diff .  # Preview changes first
ruff check --fix --unsafe-fixes .         # Apply changes

--unsafe-fixes を適用する前に常に変更をレビューしてください：

• ruff rule <CODE> を使用して、修正がなぜ安全でないと考えられているかを理解します
• 修正がコード内のこれらの仮定に違反していないことを確認します

ドキュメント

詳細情報については、公式ドキュメントをお読みください：

• https://docs.astral.sh/ruff/