Pythonの命名規則

Pythonでは、コードの可読性を高め、他の開発者とスムーズに協力するために、命名規則が重要です。命名規則に従うことで、コードが何を意図しているのかを明確にし、メンテナンスしやすくなります。この教材では、Pythonの命名規則について具体的な例を交えながら解説します。

1. 変数名の命名規則

1.1 基本的なルール

• 変数名は英数字とアンダースコア（_）を使用します。
• 数字で始めることはできません。
• 大文字と小文字は区別されます。
• 特殊文字（例: @, #, $, %, &, *, など）は使用できません。

1.2 スネークケース

Pythonでは、変数名や関数名にはスネークケース（単語をアンダースコアで区切る形式）が推奨されています。

# 良い例
user_age = 25
total_price = 100.50

# 悪い例
UserAge = 25
totalPrice = 100.50

2. 定数の命名規則

定数は、通常すべて大文字で表記し、単語をアンダースコアで区切ります。

# 定数の例
MAX_CONNECTIONS = 100
API_KEY = "your_api_key_here"

3. クラス名の命名規則

クラス名は、各単語の先頭を大文字にするキャメルケースを使用します。

class UserProfile:
    pass

class ShoppingCart:
    pass

4. 関数名の命名規則

関数名もスネークケースを使用し、動詞から始めることが望ましいです。これにより、関数が何をするのかが明確になります。

def calculate_total(price, tax):
    return price + tax

def get_user_info(user_id):
    # ユーザー情報を取得する処理
    pass

5. サンプルコード

以下に、命名規則を遵守したサンプルコードを示します。このコードは、簡単なショッピングカートの機能を持つクラスを定義しています。

class ShoppingCart:
    def __init__(self):
        self.items = []

    def add_item(self, item_name, item_price):
        item = {
            'name': item_name,
            'price': item_price
        }
        self.items.append(item)

    def calculate_total(self):
        total = 0
        for item in self.items:
            total += item['price']
        return total

    def display_items(self):
        for item in self.items:
            print(f"Item: {item['name']}, Price: {item['price']}")

# 使用例
cart = ShoppingCart()
cart.add_item('Apple', 0.5)
cart.add_item('Banana', 0.3)
cart.display_items()
print(f"Total Price: {cart.calculate_total()}")

コード解説

1. クラス定義: ShoppingCartというクラスを定義しています。クラス名はキャメルケースで、内容を表す名前が付けられています。

2. 初期化メソッド: __init__メソッドで、itemsというリストを初期化しています。このリストには、カートに追加されたアイテムを格納します。

3. メソッド:

   • add_item: アイテムの名前と価格を受け取り、辞書形式でitemsリストに追加します。
   • calculate_total: カート内のアイテムの合計価格を計算します。
   • display_items: カート内のすべてのアイテムを表示します。

4. 使用例: ShoppingCartクラスのインスタンスを作成し、アイテムを追加し、表示と合計価格の計算を行っています。

このように、命名規則を適切に使用することで、コードの可読性が向上し、他の開発者にとっても理解しやすいコードになります。