コードをリントする

目次

コードをリントする#

poetry run ruff check
Found 66 errors.
[*] 25 fixable with the `--fix` option (6 hidden fixes can be enabled with the `--unsafe-fixes` option).
  • poetry run ruff check でソースコードをリント(静的解析)できます

  • ruffはPEP8に準拠し、pycodestyleisortpyflakesなど複数のツールを統合した超高速な静的解析ツールです

  • --fixオプションでスタイル違反の一部を自動修正できます

  • --unsafe-fixesでさらに多くの自動修正が可能ですが、注意が必要です

  • ruff の設定は /pyproject.toml[tool.ruff.*] セクションで確認・変更できます

目的#

  • ruffを導入することで、PEPに準拠したスタイルの統一、ミスの早期検出、CIでの自動検査が実現できます

  • (実はまだCIには導入できておらず、開発者自身が手動でチェックする必要があります)

注釈

formatterとlinterの違い

  • ruff formatはコードの見た目を整えるフォーマッタ

  • ruff checkは構文や構造の問題を指摘するリンター

それぞれの役割が異なるため、両方の実行を推奨します