Python 命名規則 関数、変数、クラス、定数の名前の付け方のコツ!

Python 命名規則 関数、変数、クラス、定数の名前の付け方

今回は、Pythonの命名規則について解説していきます。

また、「Python 変数やメソッドの命名で使う英単語を紹介!」も合わせてご覧いただくと理解が深まります。

目次

命名規則とは

イメージアート画像

命名規則とは

命名規則とは、Pythonのプログラムを書くときに、変数や関数、クラスなどに名前を付けるときに決められているルールのことです。

命名規則のルールに従わなくても、プログラムは動くことも多いのですが、エラーの原因になってしまうことも多いので、
命名規則に従ってプログラムを書いていくことを基本的にお勧めします。

命名規則で共通に使われる用語

イメージアート画像

命名規則で共通に使われる用語

命名規則に従って名前を付けるときに使われる共通宇の用語については以下の通りです。

パスカルケース(アッパーキャメルケース)

単語をつなげたときに、最初の一文字と、単語の最初の文字を大文字にします。
(例): GetName

キャメルケース(ローワーキャメルケース)

単語をつなげたときに、単語の最初の文字を大文字にする点はパスカルケースと同じですが、最初の一文字は小文字で始めます。
(例): getName

ケバブケース

単語をつなげたときに、全てを小文字で書き、単語と単語の間をハイフンでつなげます。
(例): get-name

スネークケース

単語をつなげたときに、全てを小文字で書き、単語と単語の間をアンダースコアでつなげます。
(例): get_name

Python 命名規則一覧

イメージアート画像

Python 命名規則一覧

名前を付ける対象の、Python命名規則については以下のようになります。

名前をつける対象命名規則
変数スネークケースget_name
関数スネークケースget_name
定数全て大文字のスネークケースGET_NAME
グローバル変数スネークケースget_name
関数の引数スネークケースget_name
クラスパスカルケースGetName
インスタンス変数スネークケースget_name
メソッドスネークケースget_name
モジュールスネークケースget_name
パッケージスネークケースget_name

※ Pythonのファイル名については、できるだけ短い名前を付けます。
単語をつなげる場合はアンダースコアでつなげるスネークケースを使います。

  • 拡張子は「 .py」となります。
  • C/C++ のモジュールはアンダースコアで開始します。
  • 自クラス内のみで使用する内部変数と内部メソッドについてはアンダースコアで開始します。

プログラミングで良い変数名を付けるコツ

イメージアート画像

プログラミングで良い変数名を付けるコツ

プログラミングで良い変数名を付けるコツは、決して難しく考える必要はありません。
ソースコードを他人に読んでもらうつもりで書くということを意識することが一番のコツになります。
読み手に分かりやすい名前を心掛けて付けるようにしましょう。

変数の定義は、なるべく使う直前にする

変数の定義を関数やメソッド内のどこに書いても問題がない場合は、なるべく、その変数を使う直前に定義しましょう。

変数のスコープは、なるべく小さくする

スコープとは、その変数を使える範囲のことですが、この範囲が大きくなるほど、変数の存在を長時間意識しておく必要があるため、プログラムとしては読みづらくなります。

クラス変数やグローバル変数を使うよりも、関数やメソッド内でのみ有効なローカル変数として定義するとよいでしょう。

複数のものを表す変数名は複数形にする

変数が配列やリストなど、代入する値が複数になる場合には、変数名も複数形にすることで、配列やリストであることを区別することができます。

よく使われる単語を使用する

変数名には、よく使われる単語が決まっています。
他人にも理解できるように、変数名には、よく使われる単語を使うようにしましょう。

変数名が長い場合は、略称(短縮語)を使用する

1つの単語や複数の単語の組合せが長い場合は、分かりやすくするために略称(短縮語)を使うようにしましょう。

変数名のスコープが大きいものは長めに、小さいものは短めにする

変数のスコープが大きいものは、参照する回数も多くなることから、他の変数と区別しやすくするために、3~4つの単語を組合せて変数名を作ります。

また、変数のスコープが小さいものは、1~2つの単語で短く変数名を作ります。

プロジェクトで使用している単語を出来る限り使用する

業界や業務などにより固有の単語があり、プロジェクトで扱っている単語は極力使用するようにしましょう。

プログラミング初心者でも即戦力エンジニアへ!
転職型プログラミングスクールで学びませんか!

DMM WEBCAMP 学習コース

現役エンジニアから学べ、確実に上達できる独自メソッド
プログラミングスクール
無料カウンセリング実施中!

↓↓詳細をご覧になるには画像をクリックしてください↓↓

よかったらシェアしてください!
目次