PEP8(命名方法)
一番知りたかったところ。実装時にここに最も頭を使います。
原則
- 公開されている API の一部としてユーザーに見える名前は、実装よりも使い方を反映した名前にすべきです。
- l(小文字L),O(大文字O),I(大文字I)を変数に利用しない。
実践されている命名方法
CapWords(CamelCase・StudlyCaps)
- 各単語の先頭のみ大文字
- 文字が凸凹に見える
- 先頭が頭字語の場合は全て大文字にする!!
mixedCase
- 先頭単語が小文字で2単語目以降は1文字目のみ大文字
# CapWordsの例 CapitalizedWords # 先頭が頭字語の場合 HttpServerError (誤) HTTPServerError (正) # mixedCaseの例 mixedCase
パッケージとモジュール名
- モジュール名は全て小文字の短い名前で、_は利用OK。
- パッケージ名は全て小文字の短い名前で、_は非推奨。
クラス
- CapWords方式推奨。
関数や変数の名前
全部mixedCaseを使っていた。ゲホッ!!
関数の名前は小文字のみにすべきです。また、読みやすくするために、必要に応じて単語をアンダースコアで区切るべきです。 変数の名前についても、関数と同じ規約に従います。 mixedCase が既に使われている (例: threading.py) 場合にのみ、互換性を保つために mixedCase を許可します。
メソッド名とインスタンス変数名
関数や変数の名前と同じ。
当然だけど...
パッケージはinit.pyというファイルが存在するディレクトリで、モジュールは.pyファイル。