MENU
  1. ホーム
  2. Python
  3. 基礎構文
  4. 変数
  5. 【Python】よくある変数名の命名規則一覧

【Python】よくある変数名の命名規則一覧

変数

Pythonプログラミングを始めるとき、変数名の付け方はとても重要です。

この記事では、変数名の命名規則について詳しく説明します。

命名規則を守ることで、コードが読みやすくなり、バグを防ぎ、チームでの開発がスムーズになります。

目次から探す

命名規則の重要性

プログラミングにおいて、変数名の命名規則は非常に重要です。

適切な命名規則を守ることで、コードの可読性が向上し、バグの防止やチーム開発での一貫性が保たれます。

ここでは、命名規則の重要性について詳しく解説します。

コードの可読性向上

コードの可読性は、プログラムの品質を左右する重要な要素です。

適切な変数名を使用することで、コードを読む人がその変数の役割や意味を直感的に理解しやすくなります。

例えば、以下のようなコードを考えてみましょう。

# 悪い例
a = 10
b = 20
c = a + b
# 良い例
num_apples = 10
num_oranges = 20
total_fruits = num_apples + num_oranges

悪い例では、変数名が短く意味が不明瞭であるため、コードの意図を理解するのが難しくなります。

一方、良い例では、変数名が具体的で意味が明確なため、コードの意図が一目でわかります。

バグの防止

適切な命名規則を守ることで、バグの発生を防ぐことができます。

例えば、変数名が似ていると、誤って別の変数を使用してしまう可能性があります。

以下の例を見てみましょう。

# 悪い例
total = 100
totla = 200  # タイプミス
# 良い例
total_sales = 100
total_expenses = 200

悪い例では、変数名のタイプミスにより、意図しない値が使用される可能性があります。

一方、良い例では、変数名が明確で異なるため、タイプミスによるバグの発生を防ぐことができます。

チーム開発での一貫性

チーム開発において、一貫した命名規則を守ることは非常に重要です。

チーム全体で同じ命名規則を使用することで、コードの一貫性が保たれ、他のメンバーがコードを理解しやすくなります。

以下の例を見てみましょう。

# 悪い例
def calc_area(w, h):
    return w * h
def calculate_perimeter(width, height):
    return 2 * (width + height)
# 良い例
def calculate_area(width, height):
    return width * height
def calculate_perimeter(width, height):
    return 2 * (width + height)

悪い例では、関数名や引数名が一貫していないため、コードの理解が難しくなります。

一方、良い例では、関数名や引数名が一貫しているため、コードの理解が容易になります。

以上のように、命名規則を守ることは、コードの可読性向上、バグの防止、チーム開発での一貫性を保つために非常に重要です。

次のセクションでは、具体的な命名規則について詳しく解説します。

基本的な命名規則

Pythonで変数名を付ける際には、いくつかの基本的なルールがあります。

これらのルールを守ることで、コードの可読性が向上し、バグの発生を防ぐことができます。

以下に、Pythonの基本的な命名規則について詳しく説明します。

英数字とアンダースコアのみ使用

Pythonの変数名には、英数字(a-z、A-Z、0-9)とアンダースコア(_)のみを使用することができます。

スペースや特殊文字(例：@、#、$、%)は使用できません。

以下に例を示します。

# 正しい変数名
user_name = "Alice"
age = 30
total_amount = 100.50
# 間違った変数名(スペースや特殊文字を含む)
user name = "Alice"  # スペースが含まれている
total-amount = 100.50  # ハイフンが含まれている

数字で始めない

変数名は数字で始めることができません。

数字で始まる変数名は構文エラーとなります。

以下に例を示します。

# 正しい変数名
user1 = "Alice"
amount2 = 100.50
# 間違った変数名(数字で始まる)
1user = "Alice"  # 構文エラー
2amount = 100.50  # 構文エラー

大文字と小文字の区別

Pythonでは、大文字と小文字が区別されます。

つまり、同じ文字列でも大文字と小文字の違いによって異なる変数として扱われます。

以下に例を示します。

# 大文字と小文字の区別
name = "Alice"
Name = "Bob"
print(name)  # 出力: Alice
print(Name)  # 出力: Bob

このように、nameとNameは異なる変数として扱われます。

変数名を付ける際には、この点に注意して一貫性を持たせることが重要です。

以上が、Pythonの基本的な命名規則です。

これらのルールを守ることで、コードの可読性が向上し、バグの発生を防ぐことができます。

次に、具体的な命名規則のスタイルについて詳しく見ていきましょう。

スネークケース(snake_case)

スネークケースの特徴

スネークケース(snake_case)は、単語と単語の間をアンダースコア(_)で区切る命名規則です。

Pythonでは、変数名や関数名にこの形式がよく使われます。

スネークケースの特徴は以下の通りです。

  • 単語の区切りが明確で、読みやすい
  • 一貫性があり、コードの可読性が向上する
  • PythonのPEP 8スタイルガイドで推奨されている

使用例

スネークケースの具体的な使用例をいくつか見てみましょう。

# 変数名の例
user_name = "Taro"
user_age = 25
# 関数名の例
def calculate_area(width, height):
    return width * height
# 使用例
area = calculate_area(5, 10)
print(area)  # 出力: 50

上記の例では、変数名 user_name や user_age、関数名 calculate_area がスネークケースで命名されています。

これにより、コードが読みやすくなっています。

いつ使うべきか

スネークケースは、以下のような場合に使用するのが一般的です。

  • 変数名
  • 関数名
  • モジュール名

PythonのPEP 8スタイルガイドでは、変数名や関数名にスネークケースを使用することが推奨されています。

これにより、コードの一貫性が保たれ、他の開発者がコードを理解しやすくなります。

例えば、以下のような場合にスネークケースを使用します。

# 変数名の例
file_path = "/path/to/file"
max_value = 100
# 関数名の例
def get_user_info(user_id):
    # ユーザー情報を取得する処理
    pass
# モジュール名の例
import my_module

スネークケースを使用することで、コードの可読性が向上し、バグの発生を防ぐことができます。

また、チーム開発においても一貫性が保たれるため、他の開発者がコードを理解しやすくなります。

キャメルケース(camelCase)

キャメルケースの特徴

キャメルケースは、単語の区切りを大文字で表現する命名規則です。

最初の単語は小文字で始まり、次の単語の最初の文字を大文字にします。

例えば、 myVariableName や calculateTotalPrice などがキャメルケースの例です。

この命名規則は、単語の区切りが視覚的にわかりやすく、読みやすいという特徴があります。

使用例

キャメルケースは、特にJavaScriptやJavaなどのプログラミング言語でよく使われますが、Pythonでも特定の場面で使用されることがあります。

以下はキャメルケースを使ったPythonのサンプルコードです。

# キャメルケースを使った変数名の例
userName = "Taro"
totalPrice = 1500
isAvailable = True
# キャメルケースを使った関数名の例
def calculateTotalPrice(price, tax):
    return price + (price * tax)
# 関数の呼び出し
total = calculateTotalPrice(1000, 0.08)
print(total)  # 出力: 1080.0

この例では、変数名や関数名にキャメルケースを使用しています。

変数名 userName 、 totalPrice 、 isAvailable や関数名 calculateTotalPrice がキャメルケースの例です。

いつ使うべきか

Pythonでは、PEP 8という公式のスタイルガイドが推奨されています。

PEP 8では、変数名や関数名にはスネークケース(snake_case)を使用することが推奨されていますが、キャメルケースが全く使われないわけではありません。

以下のような場合にキャメルケースを使用することがあります。

  1. 外部ライブラリやAPIとの統一: 外部ライブラリやAPIがキャメルケースを使用している場合、そのライブラリやAPIと統一するためにキャメルケースを使用することがあります。
  2. 既存のコードベースとの一貫性: 既存のコードベースがキャメルケースを使用している場合、新しいコードもそれに合わせてキャメルケースを使用することがあります。
  3. 個人やチームのコーディングスタイル: 個人やチームのコーディングスタイルとしてキャメルケースを採用している場合、そのスタイルに従うことがあります。

ただし、Pythonの公式スタイルガイドであるPEP 8に従うことが推奨されるため、特別な理由がない限りはスネークケースを使用する方が良いでしょう。

パスカルケース(PascalCase)

パスカルケースの特徴

パスカルケース(PascalCase)は、各単語の最初の文字を大文字にし、それ以外の文字を小文字にする命名規則です。

単語間にスペースやアンダースコアを使用せず、単語の区切りを大文字で示します。

例えば、 MyVariableName や UserProfile などがパスカルケースの例です。

パスカルケースは、特にクラス名や型名などに使用されることが多いです。

Pythonの標準ライブラリや多くのフレームワークでも、クラス名にパスカルケースが採用されています。

使用例

以下に、パスカルケースを使用したクラス名の例を示します。

class MyClass:
    def __init__(self, value):
        self.value = value
    def display_value(self):
        print(self.value)
# クラスのインスタンス化
my_instance = MyClass(10)
my_instance.display_value()  # 出力: 10

この例では、クラス名 MyClass がパスカルケースで命名されています。

また、メソッド名や変数名はスネークケースを使用しています。

いつ使うべきか

パスカルケースは、主に以下のような場合に使用されます。

  • クラス名: クラス名はパスカルケースで命名するのが一般的です。

これにより、クラスと他の変数や関数を区別しやすくなります。

  • 型名: 型名や列挙型(Enum)の名前もパスカルケースで命名されることが多いです。
  • モジュール名: 一部のプロジェクトでは、モジュール名やパッケージ名にもパスカルケースを使用することがありますが、Pythonの標準ライブラリではスネークケースが一般的です。

パスカルケースを使用することで、コードの可読性が向上し、他の開発者がコードを理解しやすくなります。

また、命名規則を統一することで、チーム開発における一貫性も保たれます。

定数の命名規則

全て大文字でアンダースコア区切り

Pythonでは、定数(変更されることがない値)を定義する際に、全て大文字でアンダースコアで区切る命名規則が一般的です。

これにより、コードを読む人がその変数が定数であることを一目で理解できるようになります。

例えば、円周率を表す定数を定義する場合、以下のように書きます。

PI = 3.14159

また、最大接続数を定義する場合は以下のようになります。

MAX_CONNECTIONS = 100

このように、定数は全て大文字で書き、単語の区切りにはアンダースコアを使用します。

使用例

具体的な使用例を見てみましょう。

以下のコードは、定数を使って計算を行う例です。

# 定数の定義
PI = 3.14159
RADIUS = 5
# 円の面積を計算
area = PI * RADIUS ** 2
# 結果を表示
print(f"半径{RADIUS}の円の面積は{area}です。")

このコードを実行すると、以下のような結果が得られます。

半径5の円の面積は78.53975です。

このように、定数を使うことでコードの可読性が向上し、値が変更されることがないことを明示できます。

定数の定義場所

定数は通常、モジュールの先頭やクラスの定義の直後にまとめて定義します。

これにより、定数がどこに定義されているかが明確になり、コードのメンテナンスが容易になります。

例えば、以下のようにモジュールの先頭に定数を定義します。

# 定数の定義
PI = 3.14159
MAX_CONNECTIONS = 100
def calculate_circle_area(radius):
    return PI * radius ** 2
def main():
    print(f"最大接続数は{MAX_CONNECTIONS}です。")
    print(f"半径5の円の面積は{calculate_circle_area(5)}です。")
if __name__ == "__main__":
    main()

また、クラス内で定数を定義する場合は、クラスの定義の直後に定義します。

class Circle:
    # 定数の定義
    PI = 3.14159
    def __init__(self, radius):
        self.radius = radius
    def area(self):
        return self.PI * self.radius ** 2
circle = Circle(5)
print(f"半径5の円の面積は{circle.area()}です。")

このように、定数を適切な場所に定義することで、コードの可読性とメンテナンス性が向上します。

特殊な変数名

Pythonでは、特定の目的で使用される特殊な変数名があります。

これらの変数名は、特定の意味や機能を持ち、コードの可読性や機能性を向上させるために使用されます。

ここでは、単一のアンダースコア(_)とダブルアンダースコア(__)について詳しく解説します。

単一のアンダースコア(_)

単一のアンダースコアは、Pythonで特別な意味を持つ変数名です。

主に以下の2つの用途で使用されます。

一時変数としての使用

一時変数としての単一のアンダースコアは、特定の値を一時的に保持するために使用されます。

例えば、ループ内で一時的に値を保持する場合などです。

# リスト内の各要素をループで処理するが、値は使用しない
for _ in range(5):
    print("Hello, World!")

この例では、range(5)によって生成される値は使用されず、単に5回ループを実行するために使用されています。

無視する値としての使用

無視する値としての単一のアンダースコアは、関数やメソッドの戻り値の一部を無視する場合に使用されます。

# 関数が複数の値を返すが、一部の値を無視する
def get_coordinates():
    return (10, 20, 30)
x, _, z = get_coordinates()
print(x, z)  # 出力: 10 30

この例では、get_coordinates関数が3つの値を返しますが、2番目の値は無視されています。

ダブルアンダースコア(__)

ダブルアンダースコアは、Pythonのクラス内で特別な意味を持つ変数名です。

主に名前マングリングのために使用されます。

名前マングリング

名前マングリングとは、クラス内の変数名を一意にするための仕組みです。

これにより、サブクラスで同じ名前の変数が定義されても、衝突を避けることができます。

ダブルアンダースコアで始まる変数名は、自動的にクラス名で修飾されます。

class MyClass:
    def __init__(self):
        self.__private_var = 42
    def get_private_var(self):
        return self.__private_var
obj = MyClass()
print(obj.get_private_var())  # 出力: 42
# print(obj.__private_var)  # エラー: AttributeError: 'MyClass' object has no attribute '__private_var'

この例では、__private_varは名前マングリングによって_MyClass__private_varに変換されます。

そのため、クラス外から直接アクセスすることはできません。

使用例

名前マングリングは、クラスの内部でのみ使用されるべき変数やメソッドを隠すために便利です。

これにより、クラスの外部からの不正なアクセスを防ぐことができます。

class BaseClass:
    def __init__(self):
        self.__hidden_var = "Base"
    def get_hidden_var(self):
        return self.__hidden_var
class SubClass(BaseClass):
    def __init__(self):
        super().__init__()
        self.__hidden_var = "Sub"
base_obj = BaseClass()
sub_obj = SubClass()
print(base_obj.get_hidden_var())  # 出力: Base
print(sub_obj.get_hidden_var())   # 出力: Base

この例では、BaseClassとSubClassの両方に__hidden_varが定義されていますが、名前マングリングによってそれぞれ_BaseClass__hidden_varと_SubClass__hidden_varに変換されるため、衝突が避けられます。

以上が、Pythonにおける特殊な変数名の使い方です。

これらの命名規則を理解し、適切に使用することで、コードの可読性や保守性を向上させることができます。

Pythonの組み込み関数やモジュール名との衝突を避ける

Pythonには多くの組み込み関数やモジュールが用意されており、これらはプログラムを書く際に非常に便利です。

しかし、変数名や関数名がこれらの組み込み関数やモジュール名と衝突すると、予期しない動作を引き起こす可能性があります。

ここでは、組み込み関数の一覧と、それらとの衝突を避けるための工夫について解説します。

組み込み関数の一覧

Pythonには以下のような組み込み関数があります。

これらの名前を変数名や関数名として使用すると、元の組み込み関数が上書きされてしまうため注意が必要です。

組み込み関数組み込み関数組み込み関数組み込み関数
abs()all()any()bin()
bool()chr()dict()float()
int()len()list()max()
min()open()print()range()
str()sum()type()zip()

これらは一部の例ですが、Pythonの公式ドキュメントには全ての組み込み関数がリストアップされています。

プログラムを書く際には、これらの名前を避けるようにしましょう。

衝突を避けるための工夫

組み込み関数やモジュール名との衝突を避けるためには、以下のような工夫が有効です。

1. プレフィックスやサフィックスを付ける

変数名や関数名にプレフィックス(接頭辞)やサフィックス(接尾辞)を付けることで、組み込み関数との衝突を避けることができます。

例えば、listという名前を使いたい場合は、my_listやlist_varといった名前に変更します。

# 組み込み関数のlistと衝突しないようにする
my_list = [1, 2, 3, 4, 5]
print(my_list)

2. 名前空間を利用する

モジュールやクラスを使って名前空間を分けることで、名前の衝突を避けることができます。

例えば、mathモジュールのsum関数を使いたい場合は、math.sumとすることで、組み込み関数のsumと区別できます。

import math
# mathモジュールのsum関数を使用
result = math.fsum([1.1, 2.2, 3.3])
print(result)

3. 命名規則を徹底する

チーム開発では、命名規則を徹底することが重要です。

例えば、変数名はスネークケース、クラス名はパスカルケース、定数は全て大文字でアンダースコア区切りといったルールを設けることで、名前の衝突を避けることができます。

# 命名規則を徹底する例
MAX_VALUE = 100
class MyClass:
    def __init__(self, value):
        self.value = value
my_instance = MyClass(10)
print(my_instance.value)

これらの工夫を取り入れることで、組み込み関数やモジュール名との衝突を避け、より安全で可読性の高いコードを書くことができます。

命名規則のベストプラクティス

Pythonプログラミングにおいて、変数名の命名規則はコードの可読性や保守性に大きな影響を与えます。

ここでは、命名規則のベストプラクティスについて解説します。

一貫性の重要性

命名規則において最も重要なのは一貫性です。

一貫性のある命名規則を守ることで、コードの可読性が向上し、他の開発者がコードを理解しやすくなります。

例えば、スネークケースを使用する場合は、全ての変数名に対してスネークケースを適用するようにしましょう。

# 一貫性のある例
user_name = "Alice"
user_age = 30
# 一貫性のない例
userName = "Alice"
user_age = 30

一貫性のない命名規則は、コードを読む人に混乱を招き、バグの原因にもなりかねません。

チームでの命名規則の共有

チーム開発においては、命名規則をチーム全体で共有することが重要です。

プロジェクトの初期段階で命名規則を決定し、ドキュメントとして残しておくと良いでしょう。

これにより、新しいメンバーがプロジェクトに参加した際にもスムーズにコードを理解し、開発に貢献できるようになります。

# 命名規則ドキュメントの例
## 変数名
- スネークケースを使用する
  - 例: `user_name`, `user_age`
## 定数名
- 全て大文字でアンダースコア区切り
  - 例: `MAX_USERS`, `DEFAULT_TIMEOUT`
## クラス名
- パスカルケースを使用する
  - 例: `UserProfile`, `OrderManager`

コードレビューでのチェックポイント

コードレビューは、命名規則が守られているかを確認する絶好の機会です。

以下のチェックポイントを参考に、コードレビューを行いましょう。

  • 一貫性の確認: 変数名、関数名、クラス名が一貫した命名規則に従っているか。
  • 意味のある名前: 変数名がその役割や意味を適切に表しているか。
  • 衝突の回避: Pythonの組み込み関数やモジュール名と衝突していないか。 
# コードレビューのチェックポイント例
# 一貫性の確認
user_name = "Alice"  # OK
userAge = 30         # NG: スネークケースに統一する
# 意味のある名前
x = 10               # NG: 変数名が意味を持たない
user_count = 10      # OK: 変数名が意味を持つ
# 衝突の回避
list = [1, 2, 3]     # NG: 組み込み関数名と衝突
user_list = [1, 2, 3] # OK: 衝突を避ける

命名規則を守ることで、コードの品質が向上し、開発効率も上がります。

チーム全体で命名規則を共有し、コードレビューでしっかりとチェックすることが大切です。

目次に戻る

当サイトはリンクフリーです。出典元を明記していただければ、ご自由に引用していただいて構いません。

変数

関連記事

目次から探す