8.4.6. pymodaq_utils.enums module

class pymodaq_utils.enums.BaseEnum(new_class_name, /, names, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enum to be used within pymodaq with some utility methods

classmethod names() → List[str]

Returns all the names of the enum

classmethod to_dict()

Returns the enum in form of a dict with names os keys

New in 4.0.2

classmethod to_dict_value()

Returns the enum in form of a dict with values os keys

New in 4.0.2

classmethod values() → List[str]

Returns all the names of the enum

class pymodaq_utils.enums.StrEnum(new_class_name, /, names, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: StrEnum

classmethod names() → List[str]

Returns all the names of the enum

classmethod values() → List[str]

Returns all the names of the enum

pymodaq_utils.enums.enum_checker(enum: BaseEnum, item: BaseEnum | str)

Check if the item parameter is a valid enum or at least one valid string name of the enum

If a string, transforms it to a valid enum (case not important)

Parameters:

• enum (BaseEnum class or one of its derivated class)

• item (str or BaseEnum instance)

Return type:

BaseEnum class or one of its derivated class