データ型

[Python] Enumの使い方 – 列挙型の定義・使用方法を解説

PythonのEnumは、列挙型を定義するためのクラスで、関連する定数をグループ化して扱う際に便利です。

Enumを使用するには、enumモジュールをインポートし、クラスを定義します。

各メンバーは一意の名前と値を持ちます。

例えば、Colorという列挙型を定義し、Color.REDのようにアクセスできます。

比較は名前で行われ、==やisでメンバー同士を比較可能です。

列挙型は可読性や保守性を向上させます。

目次から探す

Enumとは何か
Enumの基本的な使い方
Enumの応用的な使い方
Enumの特殊な使い方
Enumの使用例
Enumの注意点
まとめ

Enumとは何か

Enum(列挙型)は、Pythonにおいて定数の集合を定義するための特別なクラスです。

これにより、関連する定数をグループ化し、コードの可読性と保守性を向上させることができます。

Enumを使用することで、数値や文字列の代わりに意味のある名前を使って値を表現できるため、プログラムの意図が明確になります。

例えば、曜日や状態、色などの固定された選択肢を持つ場合にEnumを利用することで、誤った値の使用を防ぎ、エラーを減少させることができます。

Enumは、Pythonの標準ライブラリであるenumモジュールに含まれており、簡単に定義・使用することができます。

これにより、プログラマーはより安全で理解しやすいコードを書くことが可能になります。

Enumの基本的な使い方

Enumクラスのインポート方法

Enumを使用するためには、まずenumモジュールからEnumクラスをインポートする必要があります。

以下のようにインポートします。

from enum import Enum

Enumの定義方法

Enumを定義するには、Enumクラスを継承した新しいクラスを作成し、その中にメンバーを定義します。

以下は、曜日を表すEnumの例です。

from enum import Enum
class Weekday(Enum):
    MONDAY = 1
    TUESDAY = 2
    WEDNESDAY = 3
    THURSDAY = 4
    FRIDAY = 5
    SATURDAY = 6
    SUNDAY = 7

Enumメンバーへのアクセス方法

Enumメンバーには、クラス名とメンバー名を使ってアクセスできます。

以下の例では、WeekdayクラスのMONDAYメンバーにアクセスしています。

print(Weekday.MONDAY)

Weekday.MONDAY

Enumメンバーの比較方法

Enumメンバーは、通常のオブジェクトと同様に比較することができます。

以下の例では、MONDAYとTUESDAYを比較しています。

if Weekday.MONDAY == Weekday.TUESDAY:
    print("同じ曜日です")
else:
    print("異なる曜日です")

異なる曜日です

Enumメンバーの列挙

Enumのメンバーを列挙するには、list()関数を使ってEnumクラスをリスト化することができます。

以下の例では、Weekdayのすべてのメンバーを列挙しています。

for day in Weekday:
    print(day)

Weekday.MONDAY
Weekday.TUESDAY
Weekday.WEDNESDAY
Weekday.THURSDAY
Weekday.FRIDAY
Weekday.SATURDAY
Weekday.SUNDAY

このように、Enumを使うことで、定数を簡単に定義し、アクセスや比較、列挙が可能になります。

Enumの応用的な使い方

Enumメンバーにカスタム値を設定する

Enumメンバーには、デフォルトの整数値の代わりにカスタム値を設定することができます。

以下の例では、曜日に対応する日本語の名前をカスタム値として設定しています。

from enum import Enum
class Weekday(Enum):
    MONDAY = "月曜日"
    TUESDAY = "火曜日"
    WEDNESDAY = "水曜日"
    THURSDAY = "木曜日"
    FRIDAY = "金曜日"
    SATURDAY = "土曜日"
    SUNDAY = "日曜日"
print(Weekday.MONDAY.value)  # 月曜日

月曜日

Enumメンバーにメソッドを追加する

Enumメンバーにメソッドを追加することも可能です。

以下の例では、曜日に関連するメソッドを追加しています。

from enum import Enum
class Weekday(Enum):
    MONDAY = 1
    TUESDAY = 2
    WEDNESDAY = 3
    THURSDAY = 4
    FRIDAY = 5
    SATURDAY = 6
    SUNDAY = 7
    def is_weekend(self):
        return self in (Weekday.SATURDAY, Weekday.SUNDAY)
print(Weekday.SATURDAY.is_weekend())  # True

True

Enumの自動値割り当て

Enumでは、auto()を使用して自動的に値を割り当てることができます。

以下の例では、曜日に自動的に整数値を割り当てています。

from enum import Enum, auto
class Weekday(Enum):
    MONDAY = auto()
    TUESDAY = auto()
    WEDNESDAY = auto()
    THURSDAY = auto()
    FRIDAY = auto()
    SATURDAY = auto()
    SUNDAY = auto()
for day in Weekday:
    print(f"{day.name}: {day.value}")

MONDAY: 1
TUESDAY: 2
WEDNESDAY: 3
THURSDAY: 4
FRIDAY: 5
SATURDAY: 6
SUNDAY: 7

Enumのメンバー名と値の取得

Enumメンバーの名前や値を取得するには、name属性とvalue属性を使用します。

以下の例では、メンバー名と値を取得しています。

day = Weekday.FRIDAY
print(f"メンバー名: {day.name}, 値: {day.value}")

メンバー名: FRIDAY, 値: 5

Enumのメンバーをループで処理する

Enumのメンバーをループで処理することができます。

以下の例では、すべての曜日を表示しています。

for day in Weekday:
    print(f"{day.name} ({day.value})")

MONDAY (1)
TUESDAY (2)
WEDNESDAY (3)
THURSDAY (4)
FRIDAY (5)
SATURDAY (6)
SUNDAY (7)

このように、Enumを使うことで、より柔軟で強力な定数の管理が可能になります。

Enumの特殊な使い方

IntEnumの使い方

IntEnumは、Enumのサブクラスで、整数値を持つEnumメンバーを定義するために使用されます。

IntEnumを使用すると、Enumメンバーは整数としても扱うことができ、他の整数と比較することが可能です。

以下の例では、IntEnumを使って曜日を定義しています。

from enum import IntEnum
class Weekday(IntEnum):
    MONDAY = 1
    TUESDAY = 2
    WEDNESDAY = 3
    THURSDAY = 4
    FRIDAY = 5
    SATURDAY = 6
    SUNDAY = 7
print(Weekday.MONDAY + 1)  # 2
print(Weekday.MONDAY == 1)  # True

2
True

FlagとIntFlagの使い方

FlagとIntFlagは、ビットフラグを使用して複数の値を組み合わせるための特別なEnumです。

Flagは通常のEnumメンバーをビット演算で組み合わせることができ、IntFlagは整数としても扱うことができます。

以下の例では、Flagを使ってアクセス権を定義しています。

from enum import Flag, auto
class Permissions(Flag):
    READ = auto()
    WRITE = auto()
    EXECUTE = auto()
# 複数の権限を組み合わせる
user_permissions = Permissions.READ | Permissions.WRITE
print(user_permissions)  # Permissions.READ|WRITE
print(Permissions.READ in user_permissions)  # True

Permissions.READ|WRITE
True

Enumの継承

Enumは他のクラスと同様に継承することができます。

これにより、共通のメンバーを持つ複数のEnumを作成することが可能です。

以下の例では、基本の曜日Enumを継承して、特定の曜日を追加しています。

from enum import Enum
class Weekday(Enum):
    MONDAY = 1
    TUESDAY = 2
    WEDNESDAY = 3
    THURSDAY = 4
    FRIDAY = 5
class ExtendedWeekday(Weekday):
    SATURDAY = 6
    SUNDAY = 7
print(list(ExtendedWeekday))  # [<ExtendedWeekday.MONDAY: 1>, <ExtendedWeekday.TUESDAY: 2>, ...]

[<ExtendedWeekday.MONDAY: 1>, <ExtendedWeekday.TUESDAY: 2>, <ExtendedWeekday.WEDNESDAY: 3>, <ExtendedWeekday.THURSDAY: 4>, <ExtendedWeekday.FRIDAY: 5>, <ExtendedWeekday.SATURDAY: 6>, <ExtendedWeekday.SUNDAY: 7>]

Enumのメタクラスを使った高度なカスタマイズ

Enumのメタクラスを使用することで、Enumの動作をカスタマイズすることができます。

以下の例では、メタクラスを使ってEnumメンバーの名前を自動的に大文字に変換しています。

from enum import Enum, EnumMeta
class UppercaseEnumMeta(EnumMeta):
    def __new__(cls, name, bases, attrs):
        for key in attrs:
            if not key.startswith('_'):
                attrs[key] = key.upper()
        return super().__new__(cls, name, bases, attrs)
class UppercaseEnum(Enum, metaclass=UppercaseEnumMeta):
    MONDAY = 1
    TUESDAY = 2
print(UppercaseEnum.MONDAY)  # UppercaseEnum.MONDAY
print(UppercaseEnum.TUESDAY)  # UppercaseEnum.TUESDAY

UppercaseEnum.MONDAY
UppercaseEnum.TUESDAY

このように、Enumの特殊な使い方を活用することで、より柔軟で強力な定数の管理が可能になります。

Enumの使用例

状態管理にEnumを使う

Enumは、状態管理に非常に便利です。

例えば、タスクの状態を管理する場合、TaskStatusというEnumを定義することで、タスクの状態を明確に表現できます。

from enum import Enum
class TaskStatus(Enum):
    PENDING = "保留中"
    IN_PROGRESS = "進行中"
    COMPLETED = "完了"
    CANCELLED = "キャンセル"
# タスクの状態を設定
current_status = TaskStatus.PENDING
# 状態を変更
current_status = TaskStatus.IN_PROGRESS
print(current_status.value)  # 進行中

進行中

設定オプションにEnumを使う

設定オプションをEnumで定義することで、選択肢を明確にし、誤った値の使用を防ぐことができます。

以下の例では、アプリケーションのテーマ設定をEnumで管理しています。

from enum import Enum
class Theme(Enum):
    LIGHT = "ライト"
    DARK = "ダーク"
    BLUE = "青"
# 現在のテーマを設定
current_theme = Theme.LIGHT
print(f"現在のテーマ: {current_theme.value}")  # 現在のテーマ: ライト

現在のテーマ: ライト

エラーハンドリングにEnumを使う

エラーハンドリングにEnumを使用することで、エラーの種類を明確にし、処理を簡素化できます。

以下の例では、エラーコードをEnumで定義しています。

from enum import Enum
class ErrorCode(Enum):
    NOT_FOUND = 404
    UNAUTHORIZED = 401
    FORBIDDEN = 403
def handle_error(code):
    if code == ErrorCode.NOT_FOUND:
        return "リソースが見つかりません"
    elif code == ErrorCode.UNAUTHORIZED:
        return "認証が必要です"
    elif code == ErrorCode.FORBIDDEN:
        return "アクセスが禁止されています"
print(handle_error(ErrorCode.NOT_FOUND))  # リソースが見つかりません

リソースが見つかりません

データベースのフィールドにEnumを使う

データベースのフィールドにEnumを使用することで、データの整合性を保つことができます。

以下の例では、ユーザーの役割をEnumで定義し、データベースに保存する際に使用しています。

from enum import Enum
class UserRole(Enum):
    ADMIN = "管理者"
    USER = "一般ユーザー"
    GUEST = "ゲスト"
# ユーザーの役割を設定
current_user_role = UserRole.ADMIN
# データベースに保存する際の例
def save_user(role):
    print(f"ユーザーの役割: {role.value}")
save_user(current_user_role)  # ユーザーの役割: 管理者

ユーザーの役割: 管理者

このように、Enumを使用することで、さまざまな場面でコードの可読性と保守性を向上させることができます。

Enumの注意点

Enumメンバーの変更はできない

Enumメンバーは一度定義すると変更することができません。

これは、Enumの特性として、定数の集合を表すために設計されているためです。

以下の例では、Enumメンバーを変更しようとするとエラーが発生します。

from enum import Enum
class Color(Enum):
    RED = 1
    GREEN = 2
    BLUE = 3
# Enumメンバーの変更を試みる
try:
    Color.RED = 4  # エラーが発生
except AttributeError as e:
    print(e)

can't set attribute

Enumのメンバー名は一意である必要がある

Enumのメンバー名は一意でなければなりません。

同じ名前のメンバーを複数定義しようとすると、エラーが発生します。

以下の例では、同じ名前のメンバーを定義しようとした場合のエラーを示しています。

from enum import Enum
class Fruit(Enum):
    APPLE = 1
    BANANA = 2
    APPLE = 3  # エラーが発生
try:
    print(Fruit.APPLE)
except ValueError as e:
    print(e)

duplicate values found in <enum 'Fruit'>: APPLE -> 1

Enumのメンバーは再定義できない

Enumメンバーは一度定義したら再定義することができません。

再定義を試みると、エラーが発生します。

以下の例では、既存のEnumメンバーを再定義しようとした場合のエラーを示しています。

from enum import Enum
class Vehicle(Enum):
    CAR = 1
    TRUCK = 2
# Enumメンバーの再定義を試みる
try:
    class Vehicle(Enum):
        CAR = 3  # エラーが発生
except TypeError as e:
    print(e)

duplicate values found in <enum 'Vehicle'>: CAR -> 1

このように、Enumを使用する際には、メンバーの変更や再定義ができないこと、メンバー名が一意である必要があることに注意が必要です。

これらの特性を理解しておくことで、Enumを効果的に活用することができます。

まとめ

この記事では、PythonのEnumについて、その基本的な使い方から応用的な利用方法、特殊な使い方、使用例、注意点まで幅広く解説しました。

Enumは、定数の集合を明確に定義するための強力なツールであり、コードの可読性や保守性を向上させるために非常に役立ちます。

これを機に、Enumを活用して、より安全で効率的なプログラミングを実践してみてはいかがでしょうか。