Create better_enum module with extended enums.

This commit is contained in:
Joshua Lucas
2026-10-14 21:20:38 -05:00
parent cdcb2af3c3
commit 0aaa9492b9

65
src/AuDaGe/better_enum.py Normal file
View File

@@ -0,0 +1,65 @@
import enum
class BetterEnumType(enum.EnumType):
"""Extensions for enum.EnumType."""
def contains(cls, name):
"""Shorthand for `name in enum.__members__`."""
return name in cls.__members__
def keys(cls):
"""Shorthand for `enum.__members__.keys()`."""
return cls.__members__.keys()
def values(cls):
"""Shorthand for `enum.__members__.values()`."""
return cls.__members__.values()
class AliasEnumType(BetterEnumType):
"""Override some of the EnumType methods so that they include aliases."""
def __contains__(cls, name):
"""Check for existence of `name` in enum members including aliases."""
return name in cls.__members__
def __getitem__(cls, name):
"""Retrieve an enum member (including aliases) by name."""
return cls.__members__[name]
def __iter__(cls):
"""Iterate through enum members including aliases."""
return iter(cls.__members__)
class BetterEnum(enum.Enum, metaclass=BetterEnumType):
"""Enum that uses BetterEnumType as its metaclass."""
class BetterIntEnum(enum.IntEnum, metaclass=BetterEnumType):
"""IntEnum that uses BetterEnumType as its metaclass."""
class BetterIntFlag(enum.IntFlag, metaclass=BetterEnumType):
"""IntFlag that uses BetterEnumType as its metaclass."""
class BetterStrEnum(enum.StrEnum, metaclass=BetterEnumType):
"""StrEnum that uses BetterEnumType as its metaclass."""
class AliasEnum(enum.Enum, metaclass=AliasEnumType):
"""Enum that uses AliasEnumType as its metaclass."""
class AliasIntEnum(enum.IntEnum, metaclass=AliasEnumType):
"""IntEnum that uses AliasEnumType as its metaclass."""
class AliasIntFlag(enum.IntFlag, metaclass=AliasEnumType):
"""IntFlag that uses AliasEnumType as its metaclass."""
class AliasStrEnum(enum.StrEnum, metaclass=AliasEnumType):
"""StrEnum that uses AliasEnumType as its metaclass."""