Site Tools


import-enum

Table of Contents

import enum

import enum is a Python import that defines enumerations: fixed sets of symbolic names. Use Enum to create cleaner code than magic strings.

Example

# Python
# description: define and use enumerations
 
from enum import Enum, auto
 
class Status(Enum):
    PENDING = "pending"
    ACTIVE = "active"
    COMPLETED = "completed"
 
# Access enum members
print(Status.PENDING)  # Status.PENDING
print(Status.PENDING.value)  # pending
 
# Use in code
current_status = Status.ACTIVE
if current_status == Status.ACTIVE:
    print("Task is running")
 
# Auto-assign values
class Color(Enum):
    RED = auto()      # 1
    GREEN = auto()    # 2
    BLUE = auto()     # 3
 
# Iterate over enum members
for status in Status:
    print(status.name, status.value)
 
# Get member by value
status = Status("active")
print(status)  # Status.ACTIVE

Common classes

  • Enum: base class for enumerations
  • enum.auto(): auto-assign integer values
  • member.name: name of enum member
  • member.value: value of enum member
  • Enum["ACTIVE"]: get by name
  • Enum("active"): get by value
import-enum.md · Last modified: by 127.0.0.1