Source code for embutils.utils.enum

#!/usr/bin/python
# -*- coding: utf-8 -*-
"""
Enumeration utilities.

:date:      2021
:author:    Christian Wiche
:contact:   cwichel@gmail.com
:license:   The MIT License (MIT)
"""
# -------------------------------------

import enum


# -->> Tunables <<---------------------


# -->> Definitions <<------------------


# -->> API <<--------------------------
class IntEnum(enum.IntEnum):
    """
    Integer enumeration class.
    Extends the functionalities of the base integer enumeration definition.
    """
    def __repr__(self) -> str:
        """
        Representation string.
        """
        return f"{self.__class__.__name__}({self.__str__()})"

    def __str__(self) -> str:
        """
        Class object as string.
        """
        return f"{self.name}(0x{self.value:X})"

    @classmethod
    def from_int(cls, value: int) -> "IntEnum":
        """
        Converts, if possible, the input value to an enum object.

        :param int value: Value to be converted.

        :returns: Enumeration object.
        :rtype: IntEnum

        :raises ValueError: Value is not contained on the enum.
        """
        if cls.has_value(value=value):
            return cls(value)
        raise ValueError(f"Value 0x{value:02X} is not defined.")

    @classmethod
    def has_value(cls, value: int) -> bool:
        """
        Checks if the input value exist on the enum definition.

        :param int value: Value to be checked.

        :returns: True if exists, false otherwise.
        :rtype: bool
        """
        # pylint: disable=E1101
        return value in getattr(cls, "_value2member_map_")


# -->> Export <<-----------------------
__all__ = [
    "IntEnum",
    ]