Pythonのenumモジュールで学ぶ列挙型（Enum）の基礎と使い方

列挙型（Enumeration）とは、一意で不変の値が割り当てられた識別子（メンバー）の集合です。列挙型内では、メンバー同士を同一性（identity）に基づいて比較することができます。また、列挙オブジェクトは反復処理（イテレーション）にも対応しています。

enumモジュールで定義されている主なクラス

Enum：列挙定数を作成するための基底クラスです。

IntEnum：intクラスのサブクラスでもある列挙定数を作成するための基底クラスです。

列挙型の作成方法

列挙型は、通常のクラス構文を使って作成します。

# enumexample.py
from enum import Enum

class langs(Enum):
    Python = 1
    Java = 2
    Cpp = 3
    Ruby = 4

列挙型のメンバーには、人間が読みやすい文字列表現とrepr表現が用意されています。

>>> from enumexample import langs
>>> print(langs.Python)
langs.Python
>>> print(repr(langs.Python))
<langs.Python: 1>

各列挙メンバーは、nameプロパティとvalueプロパティを持っています。

>>> x = langs.Python
>>> x.name
'Python'
>>> x.value
1

全メンバーの反復処理

ループを使用すれば、すべてのメンバーを順番に取り出すことができます。

>>> for lang in langs:
...     print(lang.name, lang.value)
Python 1
Java 2
Cpp 3
Ruby 4

値や名前によるメンバーへのアクセス

メンバーには、値または名前を指定してアクセスできます。

>>> langs(3)
<langs.Cpp: 3>
>>> langs['Java']
<langs.Java: 2>

メンバーの比較

同一性演算子であるisおよびis notを使って、列挙メンバーを比較できます。

>>> x = langs(2)
>>> y = langs(4)
>>> x is y
False

エイリアス（別名）の扱い

同じ名前を持つ2つの列挙メンバーを定義することはできません。しかし、同じ値を持つ複数のメンバーは許容されています。enumexample.pyを次のように変更してみましょう。

from enum import Enum

class langs(Enum):
    Python = 1
    Java = 2
    Cpp = 3
    Ruby = 4
    Cplusplus = 3

>>> from enumexample import langs
>>> langs.Cpp
<langs.Cpp: 3>
>>> langs.Cplusplus
<langs.Cpp: 3>
>>> langs(3)
<langs.Cpp: 3>

デフォルトでは、列挙型は同じ値に対して複数の名前をエイリアス（別名）として持つことができます。値の一意性を保証したい場合は、列挙型専用のクラスデコレーター@enum.uniqueを使用します。