python-code-style

Python コードスタイル

機械的なスタイル調整にはツールを使い、名前、境界、ドキュメントには人の判断を活用してください。読みやすく、レビューと保守がしやすいコードを目指します。

具体的な設定例と docstring のテンプレートは、references/style-configs.md を参照してください。

デフォルト

• プロジェクトに別の標準がすでにある場合を除き、リンティング、インポートの並べ替え、フォーマットには ruff を使います。
• 公開 API と、意図が分かりにくい内部境界には型ヒントを付けます。
• 略語より、意味が明確な名前を優先します。
• インポートは標準ライブラリ、サードパーティ、ローカルの順にまとめます。
• 行の折り返しはフォーマッターに任せます。

レビュー用チェックリスト

次の点を確認します。

• 名前がドメイン上の意味を表していること。
• 関数の役割が明確に一つであること。
• 公開関数／クラスに型注釈が付いていること。
• docstring で動作、入力、出力、重要な副作用を説明していること。
• エラーが明示的で、役に立つこと。
• インポートが整理されていること。
• 不要なコードやコメントアウトされたコードが削除されていること。

命名

• 関数／変数：snake_case。
• クラス：PascalCase。
• 定数：SCREAMING_SNAKE_CASE。
• 非公開のヘルパー：真に内部向けの場合に限り、先頭にアンダースコアを付けます。
• 数学や局所的な用途など、限られた状況を除き、1 文字の名前は避けます。

ドキュメント

すべての行ではなく、理由と契約を説明します。公開 API、複雑な変換、将来の読者が誤用するおそれのあるものには docstring を追加します。

出力

次の内容を返します。

• スタイル／設定に関する推奨事項
• 命名上の問題
• 型付け／docstring の不足
• 可読性に関わるリスク
• 最小限のパッチ計画