頑張らないために頑張る

ゆるく頑張ります

Pythonの命名規約

Posted at — Apr 12, 2019

命名規約のメモ

PEP8に準拠。何番煎じかわからないけども自学用に。

推奨される命名規約

命名対象 ルール 備考
パッケージ、モジュール すべて小文字で短く flask, os アンダースコアの利用は非推奨
クラス (アッパー)キャメルケース MyClass
型変数 (アッパー)キャメルケース MyClass
例外 (アッパー)キャメルケース、最後に「Error」 MyExcepError 例外はクラスであるべき、とのこと
グローバル変数 すべて小文字でアンダースコア区切り、2つアンダースコアを付与 __all__ グローバル変数をエクスポートするのを防ぐ
関数、変数 すべて小文字でアンダースコア区切り my_function
メソッド、インスタンス変数 すべて小文字でアンダースコア区切り my_method
定数 すべて大文字でアンダースコア区切り MY_CONST

ポピュラーな命名

上記の基本的なルールに準拠して、実際にはどんな感じで命名をされているか、について。

1文字のみ

b

小文字1文字。

B

大文字1文字。

複数文字列

lowercase

または

lower_case_with_underscores

小文字たちとアンダースコア。

UPPERCASE

または

UPPER_CASE_WITH_UNDERSCORES

大文字たちとアンダースコア。

その他

CapitalizedWords

キャメルケース。

Capitalized_Words_With_Underscores

大文字小文字とアンダースコア。ただし、これはPEP8の命名に関するドキュメント中でも「いまいち」扱いされている。

Capitalized_Words_With_Underscores (ugly!)
comments powered by Disqus