Python の命名規則
ここでは Python の命名規則についてご紹介します。
命名規則というのは、プログラムを書くときに、変数や関数、クラスなどに名前をつける時のルールのことです。
名前付けのルールに従わなくてもプログラムは動くことが多いですが、できるだけ Python が推奨している命名規則にしたがった方が良いと思います。
命名規則につかわれる用語
Python の命名規則の前に、覚えておいて損はないので、プログラミングの命名規則で共通に使われる用語について確認しておきましょう。
パスカルケース(アッパーキャメルケース)
単語をつなげた時に、最初の一文字と、各単語の最初の文字を大文字にする命名規則です。 例: GetCurrentState
キャメルケース(ローワーキャメルケース)
単語をつなげた時に、各単語の最初の文字を大文字にする点はパスカルケースと同じですが、最初の一文字は小文字ではじめる命名規則です。 例: getCurrentState
スネークケース
単語をつなげた時に、全部小文字で書き、単語と単語の間をアンダースコア _ でつなげた命名規則です。 例: get_current_state
ケバブケース
単語をつなげた時に、全部小文字で書き、単語と単語の間をハイフン - でつなげた命名規則です。 例: get-current-state
パスカルケース(アッパーキャメルケース)とキャメルケース(ローワーキャメルケース)は単語ごとの最初の大文字がらくだのこぶのようなので、キャメル(らくだ)ケースという名前になったそうです。
ケバブケースは単語がが串刺しにされたように見えますし、スネークケースは地をはっている感じが出ていますし、覚えやすいですね!
Python の命名規則
Python の名前付けルールは以下のものが推奨されています。
名前をつけるもの | 命名規則 | 例 |
---|---|---|
変数 | スネークケース | variable_name |
定数 | 全部大文字のスネークケース | CONSTANT_NAME |
グローバル変数 | スネークケース | global_variable_name |
関数 | スネークケース | function_name |
関数の引数 | スネークケース | function_parameter_name |
クラス | パスカルケース | ClassName |
インスタンス変数 | スネークケース | instance_variable_name |
メソッド | スネークケース | method_name |
パッケージ | スネークケース | package_name |
モジュール | スネークケース | module_name |
Python のファイル名は、拡張子は .py で、できるだけ短いほうがよく、単語をつなげるときはスネークケースを使います。ハイフン - は使ってはいけません。
以上、Python の命名規則についてご紹介しました。