Constants Module

class LANGUAGES:
    """The main anonipy supported languages.

    Attributes:
        DUTCH (Tuple[Literal["nl"], Literal["Dutch"]]): The Dutch language.
        ENGLISH (Tuple[Literal["en"], Literal["English"]]): The English language.
        FRENCH (Tuple[Literal["fr"], Literal["French"]]): The French language.
        GERMAN (Tuple[Literal["de"], Literal["German"]]): The German language.
        GREEK (Tuple[Literal["el"], Literal["Greek"]]): The Greek language.
        ITALIAN (Tuple[Literal["it"], Literal["Italian"]]): The Italian language.
        SLOVENIAN (Tuple[Literal["sl"], Literal["Slovenian"]]): The Slovenian language.
        SPANISH (Tuple[Literal["es"], Literal["Spanish"]]): The Spanish language.
        UKRAINIAN (Tuple[Literal["uk"], Literal["Ukrainian"]]): The Ukrainian language.

    Methods:
        supported_languages():
            Return a list of supported languages.

    """

    DUTCH = ("nl", "Dutch")
    ENGLISH = ("en", "English")
    FRENCH = ("fr", "French")
    GERMAN = ("de", "German")
    GREEK = ("el", "Greek")
    ITALIAN = ("it", "Italian")
    SLOVENIAN = ("sl", "Slovenian")
    SPANISH = ("es", "Spanish")
    UKRAINIAN = ("uk", "Ukrainian")

    @classmethod
    def supported_languages(cls) -> List[str]:
        """Return a list of supported languages.

        Returns:
            The list of supported languages.

        """
        languages = [
            cls.DUTCH[0],
            cls.ENGLISH[0],
            cls.FRENCH[0],
            cls.GERMAN[0],
            cls.GREEK[0],
            cls.ITALIAN[0],
            cls.SLOVENIAN[0],
            cls.SPANISH[0],
            cls.UKRAINIAN[0],
        ]
        return languages

class ENTITY_TYPES:
    """The anonipy supported entity types.

    Attributes:
        CUSTOM (Literal["custom"]): The custom entity type.
        STRING (Literal["string"]): The string entity type.
        INTEGER (Literal["integer"]): The integer entity type.
        FLOAT (Literal["float"]): The float entity type.
        DATE (Literal["date"]): The date entity type.
        EMAIL (Literal["email"]): The email entity type.
        WEBSITE_URL (Literal["website_url"]): The website url entity type.
        PHONE_NUMBER (Literal["phone_number"]): The phone number entity type.

    """

    CUSTOM = "custom"
    STRING = "string"
    INTEGER = "integer"
    FLOAT = "float"
    DATE = "date"
    EMAIL = "email"
    WEBSITE_URL = "website_url"
    PHONE_NUMBER = "phone_number"

class DATE_TRANSFORM_VARIANTS:
    """The supported date transform variants.

    Attributes:
        FIRST_DAY_OF_THE_MONTH (Literal["FIRST_DAY_OF_THE_MONTH"]): The first day of the month.
        LAST_DAY_OF_THE_MONTH (Literal["LAST_DAY_OF_THE_MONTH"]): The last day of the month.
        MIDDLE_OF_THE_MONTH (Literal["MIDDLE_OF_THE_MONTH"]): The middle of the month.
        MIDDLE_OF_THE_YEAR (Literal["MIDDLE_OF_THE_YEAR"]): The middle of the year.
        RANDOM (Literal["RANDOM"]): A random date.

    Methods:
        values():
            Return a list of all possible date transform variants.
        is_valid(value):
            Check if the value is a valid date variant.

    """

    FIRST_DAY_OF_THE_MONTH = "FIRST_DAY_OF_THE_MONTH"
    LAST_DAY_OF_THE_MONTH = "LAST_DAY_OF_THE_MONTH"
    MIDDLE_OF_THE_MONTH = "MIDDLE_OF_THE_MONTH"
    MIDDLE_OF_THE_YEAR = "MIDDLE_OF_THE_YEAR"
    RANDOM = "RANDOM"

    @classmethod
    def values(cls) -> List[str]:
        """Return a list of all possible date transform variants.

        Returns:
            The list of all possible variants.

        """
        return [
            cls.FIRST_DAY_OF_THE_MONTH,
            cls.LAST_DAY_OF_THE_MONTH,
            cls.MIDDLE_OF_THE_MONTH,
            cls.MIDDLE_OF_THE_YEAR,
            cls.RANDOM,
        ]

    @classmethod
    def is_valid(cls, value: str) -> bool:
        """Check if the value is a valid date variant.

        Args:
            value: The value to check.

        Returns:
            `True` if the value is a valid date variant, `False` otherwise.

        """
        return value in cls.values()