Python標準ライブラリのコーディング規約を整理します。Pythonのコーディング規約はPEP8-jaという文書にまとめられており、命名規則やインデントのルールが記載されています。
標準的なコーディングルールに準ずることでプログラムの可読性を向上させることができます。
インデント
- インデントは1レベルにつき4つ
- 複数行を継続する場合は4つでなくてもよい
- タブではなくスペースでインデントをつける
1行の長さ
- 最大79文字
- docstringやコメント等のテキストは最大72文字
- 2項演算子の前で改行する
命名規則
| 作成するもの | 命名規則 |
|---|---|
| パッケージ(ディレクトリ) | 全て小文字 アンダースコアは非推奨 |
| モジュール(ファイル) | 全て小文字 アンダースコアは可 |
| クラス名 | CapWords(頭文字が大文字, それ以降はキャメルケース) |
| 例外 | CapWords 名前の末尾に「Error」を付ける |
| 関数名 | 全て小文字・アンダースコアは可 非公開の場合先頭に_を1つつける |
| インスタンスメソッドの引数 | 第一引数は常にself |
| クラスメソッドの引数 | 第一引数は常にcls |
| 変数名 | 全て小文字・アンダースコアは可 |
| 定数 | 全て大文字 単語をアンダースコアで区切る |