mcore-linting-and-formatting

リントとフォーマット

---

フォーマッターの実行

PR を作成する前に実行してください：

# Check mode (no changes applied)
BASE_REF=main CHECK_ONLY=true SKIP_DOCS=false bash tools/autoformat.sh

# Fix mode
BASE_REF=main CHECK_ONLY=false bash tools/autoformat.sh

実行されるツール：black、isort、pylint、ruff、mypy。

---

インポートの順序

Python ファイルのインポートを編集した後は、コミットする前に必ず対象ファイルに対して uv run isort を実行してください：

uv run isort <file1>.py <file2>.py

---

リント用グループのセットアップ

コンテナ内で：

uv sync --locked --only-group linting

これにより、tools/autoformat.sh と CI の linting ジョブで使用されるものと同じツールである ruff、black、isort、pylint がインストールされます。

---

コードスタイルのルール

• 型ヒント：すべての公開 API 関数に必須です。Optional[X] ではなく X | None を使用してください。
• ドキュメント文字列：すべての公開クラスと関数に Google スタイルを使用してください。
• 命名：Python の慣例に従い、関数と変数には snake_case、クラスには PascalCase を使用してください。
• 行の長さ：119 文字です（pyproject.toml で設定されています）。
• 裸の except の禁止：必ず特定の例外型を捕捉してください。