Skip to content

base_enum

A base class for Enum that allows checking if a value is in the Enum.

`BaseEnum` #

Bases: Enum

Base Enum class, allowing checking if a value is in the enum.

Example

from careamics.utils.base_enum import BaseEnum

Define a new enum#

class BaseEnumExtension(BaseEnum): ... VALUE = "value"

Check if value is in the enum#

"value" in BaseEnumExtension True

Source code in src/careamics/utils/base_enum.py

class BaseEnum(Enum, metaclass=_ContainerEnum):
    """Base Enum class, allowing checking if a value is in the enum.

    Example
    -------
    >>> from careamics.utils.base_enum import BaseEnum
    >>> # Define a new enum
    >>> class BaseEnumExtension(BaseEnum):
    ...     VALUE = "value"
    >>> # Check if value is in the enum
    >>> "value" in BaseEnumExtension
    True
    """

    pass