コードをフォーマットする

目次

コードをフォーマットする#

poetry run ruff format
3 files reformatted, 76 files left unchanged

  • poetry run ruff format でソースコードをフォーマット（整形）できます

  • ruffはPEP8に準拠しており、black互換のスタイルでコードを超高速に整形するフォーマッタです

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

説明#

  • PythonではPEP8 (Style Guide for Python Code)でコーディングルールが標準化されています

  • フォーマッターを導入することで、開発者は自身のコーディングのクセを気にする必要がなく、作業に集中できます

  • また、フォーマットの統一によりコードレビューがスムーズになり、内容そのもののレビューに集中しやすくなります

注釈

formatterとlinterの違い

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

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

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

目次