Python 開発ガイド

コードスタイル

• PEP 8 に従う (Ruff で強制)
• すべてのパブリック関数に型ヒントを使用する
• .format() や % よりも f-strings を優先する

一般的なパターン

• データ構造には dataclasses または Pydantic を使用する
• リソース管理にはコンテキストマネージャーを使用する
• os.path よりも pathlib を優先する

テスト

• pytest を使用し、わかりやすいテスト関数名を付ける
• テストのセットアップにはフィクスチャーを使用する
• 複数のテストケースには parametrize を使用する

エラーハンドリング

• 適切なベースクラスを継承したカスタム例外を作成する
• raise ... from e を使用してスタックトレースを保持する
• ドキュメント文字列に例外を記載する

型チェック

• コミット前に mypy --ignore-missing-imports . を実行する
• null 許容値には Optional[T] を使用する
• ジェネリック関数には TypeVar を使用する