mcpField
P
python-expert-best-practices-code-review

python-expert-best-practices-code-review

github.com/wispbit-ai開発8676 回インストール37 週間前に更新
リポジトリ

python-expert-best-practices-code-review について

Python 3.14 以降で本番コードを書く、レビューする、リファクタリングする開発者向けの簡潔なルール集です。優先度別に整理され、各ルールの詳しい説明と例にリンクしています。

主な機能

  1. 01優先度別のルール分類
  2. 02辞書キーのエラー処理
  3. 03ミュータブルなデフォルト値の回避
  4. 04例外と演算子の指針
  5. 05明瞭さとスタイルの規則
  6. 06例を含むルールファイル

活用シーン

  1. 01Python のエラー処理レビュー
  2. 02関数のデフォルト値と演算子のリファクタリング
  3. 03API 境界コードの検証
  4. 04Python モジュールの可読性問題の発見

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/wispbit-ai/skills --skill python-expert-best-practices-code-review

インストール後、Claude Code で/python-expert-best-practices-code-reviewを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

rules/
avoid-explanatory-comments.md
dict-required-keys.md
listcomp-no-side-effects.md
no-generic-except.md
no-inline-imports.md
no-mutable-defaults.md
operators-return-notimplemented.md
unnecessary-else-blocks.md

詳細

Python 3.14+ のベストプラクティス

シンプルで実践的、かつ明確な方針に基づいています。本番品質の Python コードを書くうえで重要なことだけを扱います。

適用する場面

次のような場面で、これらのガイドラインを参照してください。

  • Python の関数、クラス、モジュールを作成するとき
  • エラー処理に問題がないか Python コードをレビューするとき
  • 既存の Python コードベースをリファクタリングするとき
  • データ検証と API の境界を実装するとき
  • エラー検出とデバッグのパターンを最適化するとき

優先度別のルールカテゴリ

優先度カテゴリ影響度プレフィックス
1エラー処理重大dict-, operators-
2よくあるバグ重大〜高no-mutable-, no-generic-
3コードの明瞭さ高〜中listcomp-, no-inline-
4コードスタイル低avoid-, unnecessary-

クイックリファレンス

  • dict-required-keys - 必須の辞書キーには d[key] を使い、KeyError をすばやく発生させます
  • no-mutable-defaults - 関数やメソッドの引数に可変のデフォルト値を使いません
  • operators-return-notimplemented - サポートされていないオペランド型には NotImplemented を返し、+ と += の動作を意図的に設計します
  • no-generic-except - 予期しないエラーを隠さないよう、汎用的な except 節を避けます
  • listcomp-no-side-effects - リスト内包表記では、使用する値を生成する必要があります(副作用だけを目的としたリスト内包表記は使いません)
  • no-inline-imports - すべての import 文をファイルの先頭に配置します
  • avoid-explanatory-comments - 自己説明的なコードには不要なコメントを避けます
  • unnecessary-else-blocks - return、break、continue 文の後に不要な else ブロックを置きません

使用方法

詳しい説明とコード例については、各ルールファイルを参照してください。

rules/dict-required-keys.md
rules/no-mutable-defaults.md
rules/operators-return-notimplemented.md
rules/no-generic-except.md
rules/listcomp-no-side-effects.md
rules/no-inline-imports.md
rules/avoid-explanatory-comments.md
rules/unnecessary-else-blocks.md

各ルールファイルには、次の内容が含まれています。

  • 重要である理由の簡潔な説明
  • このパターンを使う場合と使わない場合
  • 実装要件
  • 説明付きの誤ったコード例
  • 説明付きの正しいコード例
  • 追加の背景情報と参考資料

コメント