Pythonでの列挙型(enum)の使い方とは？識別子の集合について紹介！

.NET開発者のためのブログメディア

SE: enumの特徴と使い方について教えてください。

PM: 列挙型とも呼ばれ、決められた複数の選択肢から値を指定する際に利用します。

Pythonでの列挙型(enum)の使い方とは？

今回は、Pythonでの列挙型(enum)の使い方について説明します。
enumとは、識別子の集合です。通常、意味のある集合体として定義します。

ここでは、Enumクラス、IntEnumクラス、Flagクラス、unique、auto関数
について紹介します。
Pythonでのenumの使い方に興味のある方はぜひご覧ください。

Enumクラス

Pythonにおけるenumの基底クラスであるEnumクラスの使い方を紹介します。

実際のソースコードを見てみましょう。

from enum import Enum
class Fruits(Enum):
    APPLE= 1
    BANANA = 2
    CHERRY = 3

print(Fruits.APPLE) # Fruits.APPLE
print(repr(Fruits.BANANA)) # <Fruits.BANANA: 2>
print(type(Fruits.CHERRY)) # <enum 'Fruits'>

from enum import Enum

class Fruits(Enum):

APPLE= 1

BANANA = 2

CHERRY = 3

print(Fruits.APPLE) # Fruits.APPLE

print(repr(Fruits.BANANA)) # <Fruits.BANANA: 2>

print(type(Fruits.CHERRY)) # <enum 'Fruits'>

実行結果は以下のようになります。

Fruits.APPLE
<Fruits.BANANA: 2>
<enum 'Fruits'>

Fruits.APPLE

<Fruits.BANANA: 2>

enumの比較は以下のように記述します。

print(isinstance(Fruits.APPLE, Fruits)) # True
print(Fruits.BANANA == Fruits.BANANA)   # True
print(Fruits.BANANA == Fruits.CHERRY)   # False
print(Fruits.APPLE == 1)                # False

print(isinstance(Fruits.APPLE, Fruits)) # True

print(Fruits.BANANA == Fruits.BANANA) # True

print(Fruits.BANANA == Fruits.CHERRY) # False

print(Fruits.APPLE == 1) # False

実行結果は以下のようになります。

True
True
False
False

True

False

enumの識別子や値を確認するには、以下のように記述します。

print(Fruits.APPLE.name)   # APPLE
print(Fruits.BANANA.value) # 2

1 2	print(Fruits.APPLE.name) # APPLE print(Fruits.BANANA.value) # 2

実行結果は以下のようになります。

APPLE
2

APPLE

enumはfor文で全要素を処理できます。

for fruits in Fruits:
    print(fruits, fruits.name, fruits.value)

1 2	for fruits in Fruits: print(fruits, fruits.name, fruits.value)

実行結果は以下のようになります。

Fruits.APPLE APPLE 1
Fruits.BANANA BANANA 2
Fruits.CHERRY CHERRY 3

Fruits.APPLE APPLE 1

Fruits.BANANA BANANA 2

Fruits.CHERRY CHERRY 3

配列のように要素にアクセスすることもできます。

print(Fruits(1))             # Fruits.APPLE
print(Fruits['BANANA'])      # Fruits.BANANA
print(Fruits(2).value)       # 2
print(Fruits['CHERRY'].name) # CHERRY

print(Fruits(1)) # Fruits.APPLE

print(Fruits['BANANA']) # Fruits.BANANA

print(Fruits(2).value) # 2

print(Fruits['CHERRY'].name) # CHERRY

実行結果は以下のようになります。

Fruits.APPLE
Fruits.BANANA
2
CHERRY

Fruits.APPLE

Fruits.BANANA

CHERRY

要素が重複すると、コンパイルエラーになります。

from enum import Enum
class Fruits(Enum):
    APPLE= 1
    BANANA = 2
    BANANA = 3

from enum import Enum

class Fruits(Enum):

APPLE= 1

BANANA = 2

BANANA = 3

コンパイル結果は以下のようになります。

TypeError: Attempted to reuse key: 'BANANA'

1	TypeError: Attempted to reuse key: 'BANANA'

Pythonでは、このようにenumを使用します。

IntEnumクラス

EnumクラスおよびintのサブクラスでもあるIntEnumクラスを紹介します。PythonのIntEnumクラスはint型と比較できます。

実際のソースコードを見てみましょう。

from enum import Enum, IntEnum
class Fruits(Enum):
    APPLE = 1
    BANANA = 2
    CHERRY = 3

class Color(IntEnum):
    RED = 1
    GREEN = 2
    BLUE = 3

class OS(IntEnum):
    WINDOWS = 1
    LINUX = 2
    MAC = 3

# Enumはintと比較できない
print(Fruits.APPLE == 1)       # False
# IntEnumはintと比較できる
print(Color.RED == 1)          # True
print(Color.RED == OS.WINDOWS) # True
print(int(Color.GREEN))        # 2

from enum import Enum, IntEnum

class Fruits(Enum):

APPLE = 1

BANANA = 2

CHERRY = 3

class Color(IntEnum):

RED = 1

GREEN = 2

BLUE = 3

class OS(IntEnum):

WINDOWS = 1

LINUX = 2

MAC = 3

# Enumはintと比較できない

print(Fruits.APPLE == 1) # False

# IntEnumはintと比較できる

print(Color.RED == 1) # True

print(Color.RED == OS.WINDOWS) # True

print(int(Color.GREEN)) # 2

実行結果は以下のようになります。

False
True
True
2

False

True

このように、PythonのIntEnumクラスはint型と比較できます。

Flagクラス

ビット演算子 (&, |, ^, ~) が使用可能なenumである、Flagクラスを紹介します。

実際のソースコードを見てみましょう。

from enum import Flag, auto
class Fruits(Flag):
    APPLE = auto()
    BANANA = auto()
    CHERRY = auto()
    MIX1 = APPLE | BANANA
    MIX2 = APPLE | BANANA | CHERRY

for fruits in Fruits:
    print(fruits, fruits.name, fruits.value)

print(Fruits.MIX1 == (Fruits.APPLE | Fruits.BANANA)) # True
print(Fruits.APPLE in Fruits.MIX1)  # True
print(Fruits.BANANA in Fruits.MIX1) # True
print(Fruits.CHERRY in Fruits.MIX1) # False

from enum import Flag, auto

class Fruits(Flag):

APPLE = auto()

BANANA = auto()

CHERRY = auto()

MIX1 = APPLE | BANANA

MIX2 = APPLE | BANANA | CHERRY

for fruits in Fruits:

print(fruits, fruits.name, fruits.value)

print(Fruits.MIX1 == (Fruits.APPLE | Fruits.BANANA)) # True

print(Fruits.APPLE in Fruits.MIX1) # True

print(Fruits.BANANA in Fruits.MIX1) # True

print(Fruits.CHERRY in Fruits.MIX1) # False

実行結果は以下のようになります。

Fruits.APPLE APPLE 1
Fruits.BANANA BANANA 2
Fruits.CHERRY CHERRY 4
Fruits.MIX1 MIX1 3
Fruits.MIX2 MIX2 7
True
True
True
False

Fruits.APPLE APPLE 1

Fruits.BANANA BANANA 2

Fruits.CHERRY CHERRY 4

Fruits.MIX1 MIX1 3

Fruits.MIX2 MIX2 7

True

False

このように、PythonのFlagクラスはビット演算子が使用できます。

unique

識別子が重複しないことを保証するデコレーターである、uniqueを紹介します。

実際のソースコードを見てみましょう。

from enum import Enum, unique
@unique
class Fruits(Enum):
    APPLE= 1
    BANANA = 2
    CHERRY = 2

from enum import Enum, unique

@unique

class Fruits(Enum):

APPLE= 1

BANANA = 2

CHERRY = 2

以下のようなコンパイルエラーが発生します。

ValueError: duplicate values found in <enum 'Fruits'>: CHERRY -> BANANA

1	ValueError: duplicate values found in <enum 'Fruits'>: CHERRY -> BANANA

@uniqueをコメントアウトするとコンパイルエラーにはなりません。

from enum import Enum, unique
#@unique
class Fruits(Enum):
    APPLE= 1
    BANANA = 2
    CHERRY = 2

for fruits in Fruits:
    print(fruits, fruits.name, fruits.value)

from enum import Enum, unique

#@unique

class Fruits(Enum):

APPLE= 1

BANANA = 2

CHERRY = 2

for fruits in Fruits:

print(fruits, fruits.name, fruits.value)

実行結果は以下のようになります。

Fruits.APPLE APPLE 1
Fruits.BANANA BANANA 2

1 2	Fruits.APPLE APPLE 1 Fruits.BANANA BANANA 2

このようにPythonでは、識別子を重複させたくない場合はuniqueを使用します。

auto関数

値をプログラマが指定する必要がない場合、auto関数が使用できます。

実際のソースコードを見てみましょう。

from enum import Enum, auto
class Fruits(Enum):
    APPLE = auto()
    BANANA = auto()
    CHERRY = auto()

for fruits in Fruits:
    print(fruits, fruits.name, fruits.value)

from enum import Enum, auto

class Fruits(Enum):

APPLE = auto()

BANANA = auto()

CHERRY = auto()

for fruits in Fruits:

print(fruits, fruits.name, fruits.value)

実行結果は以下のようになります。

Fruits.APPLE APPLE 1
Fruits.BANANA BANANA 2
Fruits.CHERRY CHERRY 3

Fruits.APPLE APPLE 1

Fruits.BANANA BANANA 2

Fruits.CHERRY CHERRY 3

このようにPythonでは、値をプログラマが指定する必要がない場合、auto関数が使用できます。

SE: 選択肢にない値を指定してしまう不具合を抑制してくれるのですね。

PM: enum以外の値を指定すると不具合を指摘してくれます。

まとめ

いかがでしたでしょうか。Pythonでの列挙型(enum)の使い方について説明しました。

enumとは、識別子の集合です。通常、意味のある集合体として定義します。
ここでは、Enumクラス、IntEnumクラス、Flagクラス、unique、auto関数
について紹介しました。

ぜひご自身でソースコードを書いて、理解を深めてください。

.NET分野でのキャリアアップをお考えの方は、現在募集中の求人情報をご覧ください。

求人一覧

また、直接のエントリーも受け付けております。

エントリー（応募フォーム）

Pythonでの列挙型(enum)の使い方とは？識別子の集合について紹介！

Pythonでの列挙型(enum)の使い方とは？

Enumクラス

IntEnumクラス

Flagクラス

unique

auto関数

まとめ

.NET Framework 3.5をWindows10にインストールする方法

【VB.NET入門】DataGridViewの使い方まとめ

VB.NETとは？特徴や他言語と比べておすすめできる理由も解説！

【VB.NET入門】学ぶメリット・知識ゼロから始める手順全まとめ！

EdgeとChromeはどう違う？それぞれのスペック7つを比較解説！