piglet

piglet

One Python Craftsman のパターンを用いた、Python コードの作成とレビューのための簡潔なガイドです。

目的と利用タイミング

• Python（.py）コードの作成、リファクタリング、コードレビューに使用します。
• 命名、制御フロー、データ処理、エラー処理、ループ、デコレーター、インポート、ファイル入出力、エッジケース、ウォルラス演算子に関するコード品質の問題に使用します。
• 明瞭さと保守性を優先します。パフォーマンスの最適化は、実際に制約となる場合にのみ行います。
• $friendly-python が利用可能な場合は、より幅広い Python のスタイルおよびレビューチェックリストとして、併用を提案してください。

判断の優先順位

1. 正確性と明示的な動作
2. 読みやすさと保守性
3. 拡張コストと変更の分離
4. パフォーマンスとマイクロ最適化

ワークフロー

1. 以下の表からトピックを特定します。
2. ガイダンスを適用し、Bad および Good の例と比較します。
3. $friendly-python が利用可能な場合は、このスキルと併用するよう推奨します。
4. 新たなエッジケースや読みやすさの低下がないか、再確認します。

トピック

トピック	ガイダンス	参照先
変数と命名	説明的な名前を付け、暗黙のマジックを避け、変数のスコープを使う場所の近くに保ちます	references/variables-and-naming.md
分岐と条件	深いネストを避け、複雑な条件をカプセル化します	references/if-else-and-branches.md
数値、文字列、コンテナー	マジックリテラルを置き換え、適切なコンテナーを選びます	references/values-and-containers.md
関数と戻り値	安定した戻り値の型を保ち、エラータプルを避けます	references/functions-and-returns.md
例外処理	対処できる例外だけを捕捉し、スコープを小さく保ちます	references/exceptions-handling.md
ループと反復処理	ネストしたループより、イテレーターのヘルパーを優先します	references/loops-and-iteration.md
デコレーター	シグネチャを保持し、デコレーターの落とし穴を避けます	references/decorators.md
インポートと依存関係	ローカルインポートと境界を使って循環を防ぎます	references/imports-and-structure.md
ルールとファイル入出力	適切なデータ構造と pathlib を使用します	references/rules-and-file-io.md
Python における SOLID	継承の置換可能性を保ち、動作を明示します	references/solid-python.md
エッジケース	メインパスを明瞭に保てる場合は EAFP を優先します	references/edge-cases.md
ウォルラス演算子	代入式を使って繰り返しをなくします	references/walrus-operator.md

参照先

• 各参照ファイルのフロントマター urls に、ソース URL が記載されています。