Utilities and Decorators

PythonのData TypesにおけるUtilities and Decorators (enum)解説

enum は、Python 3.4で導入された標準ライブラリであり、列挙型と呼ばれるデータ型を定義するためのモジュールです。列挙型は、数値や文字列の集合を名前付きの定数として定義するもので、コードの可読性と保守性を向上させることができます。

enumの利点

• コードの可読性向上: 数値や文字列の代わりに分かりやすい名前を使用できる
• コードの保守性向上: 型エラーを防ぎ、コードの意図を明確にできる
• 安全性の向上: 定義されていない値を使用することを防げる

enumの基本的な使い方

from enum import Enum

# 動物の種類を定義
class Animal(Enum):
    DOG = 1
    CAT = 2
    BIRD = 3

# 定数の使用
dog = Animal.DOG
print(dog.name)  # 出力: DOG
print(dog.value)  # 出力: 1

# すべての定数を取得
animals = list(Animal)
print(animals)  # 出力: [<Animal.DOG: 1>, <Animal.CAT: 2>, <Animal.BIRD: 3>]

enumの応用例

• 状態を表す定数を定義
• 許容される値の範囲を定義
• フラグを表す定数を定義

Utilities and Decorators

enum モジュールには、列挙型を扱うためのいくつかのユーティリティ関数とデコレータが用意されています。

• auto(): 各メンバーに自動的に値を割り当てるデコレータ
• unique(): 同じ名前を持つメンバーが定義されていないことを確認するデコレータ
• IntEnum: メンバーの値が整数である列挙型
• StrEnum: メンバーの値が文字列である列挙型

まとめ

enum モジュールは、Pythonで列挙型を定義するための便利なツールです。コードの可読性と保守性を向上させるために、ぜひ活用しましょう。

Python enum サンプルコード集

基本的な使い方

from enum import Enum

# 動物の種類を定義
class Animal(Enum):
    DOG = 1
    CAT = 2
    BIRD = 3

# 定数の使用
dog = Animal.DOG
print(dog.name)  # 出力: DOG
print(dog.value)  # 出力: 1

# すべての定数を取得
animals = list(Animal)
print(animals)  # 出力: [<Animal.DOG: 1>, <Animal.CAT: 2>, <Animal.BIRD: 3>]

auto() デコレータ

from enum import Enum, auto

# 状態を表す列挙型
class State(Enum):
    INITIALIZED = auto()
    RUNNING = auto()
    STOPPED = auto()

# 使用例
state = State.RUNNING
print(state.name)  # 出力: RUNNING

unique() デコレータ

from enum import Enum, unique

# 色を表す列挙型
@unique
class Color(Enum):
    RED = 1
    GREEN = 2
    BLUE = 3

# 同じ名前を持つメンバーを定義しようとするとエラーが発生
try:
    class Color(Enum):
        RED = 1
        GREEN = 2
        BLUE = 3
        RED = 4  # エラーが発生
except ValueError:
    print("エラーが発生しました")

IntEnum

from enum import IntEnum

# 曜日を表す列挙型
class Weekday(IntEnum):
    SUNDAY = 0
    MONDAY = 1
    TUESDAY = 2
    WEDNESDAY = 3
    THURSDAY = 4
    FRIDAY = 5
    SATURDAY = 6

# 使用例
today = Weekday.FRIDAY
print(today.value)  # 出力: 5

StrEnum

from enum import StrEnum

# ファイル拡張子を

Python enum を使う他の方法

メタクラスを使用する

from enum import Enum, MetaEnum

class Animal(Enum, metaclass=MetaEnum):
    DOG = "dog"
    CAT = "cat"
    BIRD = "bird"

# メタクラスを使用することで、以下のような追加機能を利用できる
# - メンバーの値を文字列として定義できる
# - メンバーの名前と値を反転した辞書を取得できる

# メンバーの値を文字列として取得
dog_name = Animal.DOG.value  # 出力: "dog"

# メンバーの名前と値を反転した辞書を取得
name_to_value = Animal._member_map_  # 出力: {"dog": <Animal.DOG: 1>, "cat": <Animal.CAT: 2>, "bird": <Animal.BIRD: 3>}

フラグを表す列挙型

from enum import Flag, auto

# フラグを表す列挙型
class Permissions(Flag):
    READ = auto()
    WRITE = auto()
    EXECUTE = auto()

# 使用例
permissions = Permissions.READ | Permissions.WRITE
print(permissions.has_flag(Permissions.READ))  # 出力: True
print(permissions.has_flag(Permissions.EXECUTE))  # 出力: False

値のエイリアス

from enum import Enum

# 値のエイリアス
class Color(Enum):
    RED = 1
    GREEN = 2
    BLUE = 3

    # エイリアスの定義
    SCARLET = RED
    EMERALD = GREEN
    SAPPHIRE = BLUE

# 使用例
color = Color.SCARLET
print(color.name)  # 出力: RED

カスタム属性

from enum import Enum

# カスタム属性
class Animal(Enum):
    DOG = 1
    CAT = 2
    BIRD = 3

    # カスタム属性の定義
    def __init__(self, sound):
        self.sound = sound

# 使用例
dog = Animal.DOG
print(dog.sound)  # 出力: "bark"

# すべてのメンバーのカスタム属性を取得
sounds = {animal.name: animal.sound for animal in Animal}
print(sounds)  # 出力: {"DOG": "bark", "CAT": "meow", "BIRD": "chirp"}