Python コードレビュー

クイックリファレンス

問題タイプ	参照
インデント、行の長さ、空白、命名	references/pep8-style.md
不足/不正な型ヒント、Any の使用	references/type-safety.md
async での ブロッキング呼び出し、await の不足	references/async-patterns.md
裸の except、コンテキストの欠落、ログ	references/error-handling.md
ミュータブルなデフォルト、print ステートメント	references/common-mistakes.md

レビューチェックリスト

PEP8 スタイル

• 4 スペースインデント（タブなし）
• 行の長さ ≤79 文字（ドキュメント文字列/コメント ≤72）
• トップレベル定義の前後に 2 つの空行、クラス内は 1 つ
• インポートのグループ化：stdlib → サードパーティ → ローカル（グループ間に空行）
• 括弧内またはコロン/カンマの前に空白なし
• 命名規則：関数/変数は snake_case、クラスは CamelCase、定数は UPPER_CASE
• インラインコメントは最低でも 2 スペース区切り

型安全性

• すべての関数パラメータと戻り値に型ヒント
• 必要な場合を除き Any なし（理由を説明するコメント付き）
• 正しい T | None 構文（Python 3.10+）

Async パターン

• async 関数内にブロッキング呼び出し（time.sleep、requests など）なし
• すべてのコルーチンに対して正しく await

エラーハンドリング

• 裸の except: 句なし
• コンテキスト付きの特定の例外タイプ
• スタックトレースを保持するために raise ... from を使用

一般的な間違い

• ミュータブルなデフォルト引数なし
• 出力には logger を使用、print() でなく
• .format() または % ではなく f-strings を推奨

有効なパターン（フラグを立てない）

これらのパターンは意図的で正しいため、問題として報告しないでください：

• 型アノテーションと型アサーション - アノテーションは型を宣言しますが、実行時アサーションではありません。不足している検証と混同しないでください
• 型なしライブラリと相互作用する場合の Any 使用 - 外部ライブラリに型スタブがない場合は必須です
• 空の __init__.py ファイル - パッケージ構造として有効、コード不要
• noqa コメント - 特定のケースにリンタルールが適用されない場合は有効
• 実行時型チェック後の cast() 使用 - 絞り込まれた型を型チェッカーに通知するための正しいパターン

コンテキスト依存ルール

これらの問題は特定の条件が適用される場合のみフラグを立てます：

問題	フラグ対象
一般的な例外処理	特定の例外タイプが利用可能で意味がある場合
未使用の変数	変数に _ プレフィックスがなく、f-strings、ログ、またはデバッグで使用されていない場合

ゲート（レポーティングワークフロー）

順序通りに完了してください。各合格条件が満たされるまで進まないでください。

1. スコープ — 合格： この実行で検査したすべての .py パス（または明示的なグロブ）を列挙します。
2. 誤検知スクリーン — 合格： 報告する予定の각 問題について、上記の有効なパターンとコンテキスト依存ルールをチェックしました。これらのセクションがフラグを立てないと言っている場合、検出結果を削除または絞り込みます。
3. エビデンス — 合格： 残りの検出結果には [FILE:LINE]（または境界のある行範囲）が含まれています。シンボルまたは短い逐語的スニペットが場所アンカーを補うことはできますが、置き換えることはできません。
4. 検証プロトコル — 合格： review-verification-protocol を読み込み、ユーザーに見える書き込み前に報告される各問題の必須ステップを完了します。
5. リリース — 合格： ユーザーに見える出力は、そのプロトコルが要求する構造に一致します（そのチェックをスキップする問題のみのダンプではありません）。

参照を読み込む時期

• コードフォーマット/スタイルをレビューする場合 → pep8-style.md
• 関数シグネチャをレビューする場合 → type-safety.md
• async def 関数をレビューする場合 → async-patterns.md
• try/except ブロックをレビューする場合 → error-handling.md
• 一般的な Python レビュー → common-mistakes.md

レビュー質問

1. コードは PEP8 フォーマット（インデント、行の長さ、空白）に従っていますか？
2. インポートは正しくグループ化されていますか（stdlib → サードパーティ → ローカル）？
3. 名前は規則に従っていますか（snake_case、CamelCase、UPPER_CASE）？
4. すべての関数シグネチャは完全に型付けされていますか？
5. async 関数は本当にブロッキングされていませんか？
6. 例外は有意義なコンテキストを含んでいますか？
7. ミュータブルなデフォルト引数はありますか？

報告前に：上記の**ゲート（レポーティングワークフロー）**を完了してください（特にゲート 4）。