Skip to content

enums

ItemUserBasedEnum

Bases: StrEnum

Enum class for item and user based properties.

Enum class to indicate if the function or logic is based on item or user.

Source code in src/recnexteval/matrix/enums.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
class ItemUserBasedEnum(StrEnum):
    """Enum class for item and user based properties.

    Enum class to indicate if the function or logic is based on item or user.
    """

    ITEM = "item"
    """Property based on item"""
    USER = "user"
    """Property based on user"""

    @classmethod
    def has_value(cls, value: str) -> bool:
        """Check valid value for ItemUserBasedEnum

        :param value: String value input
        :type value: str
        """
        return value in ItemUserBasedEnum

ITEM = 'item' class-attribute instance-attribute

Property based on item

USER = 'user' class-attribute instance-attribute

Property based on user

has_value(value) classmethod

Check valid value for ItemUserBasedEnum

:param value: String value input :type value: str

Source code in src/recnexteval/matrix/enums.py 
15
16
17
18
19
20
21
22
@classmethod
def has_value(cls, value: str) -> bool:
    """Check valid value for ItemUserBasedEnum

    :param value: String value input
    :type value: str
    """
    return value in ItemUserBasedEnum