midgard.collections.enums

Framework for working with enumerations

Description:

Custom enumerations used for structured names.

LogLevel

LogLevel(value, names=None, *, module=None, qualname=None, type=None, start=1)

Levels used when deciding how much log output to show

LogLevel.all (LogLevel)

all = <LogLevel.all: 1>

LogLevel.check (LogLevel)

check = <LogLevel.check: 7>

LogLevel.debug (LogLevel)

debug = <LogLevel.debug: 2>

LogLevel.dev (LogLevel)

dev = <LogLevel.dev: 4>

LogLevel.error (LogLevel)

error = <LogLevel.error: 8>

LogLevel.fatal (LogLevel)

fatal = <LogLevel.fatal: 9>

LogLevel.info (LogLevel)

info = <LogLevel.info: 5>

LogLevel.none (LogLevel)

none = <LogLevel.none: 10>

LogLevel.time (LogLevel)

time = <LogLevel.time: 3>

LogLevel.warn (LogLevel)

warn = <LogLevel.warn: 6>

enums()

enums() -> List[str]

Return a list of available enums

Returns:

Names of available enums.

get_enum()

get_enum(name:str) -> enum.EnumMeta

Return a named Enumeration

Names are defined by the @register_enum-decorator. If the name-parameter is not a valid enum, the function will raise an UnknownEnumError and list the available enumerations.

Args:

Returns:

Enumeration with the given name.

get_value()

get_value(name:str, value:str) -> enum.Enum

Return the value of a named Enumeration

Names are defined by the @register_enum-decorator.

Args:

Returns:

Value of enumeration with the given name.

register_enum()

register_enum(name:str) -> Callable[[enum.EnumMeta], enum.EnumMeta]

Register a named Enumeration

This allows for getting Enumerations with the get_enum-function.

Args:

Returns:

Decorator that registers an Enumeration.