categorization_attributes.py

"""
Defines the attributes that are used for categorizing activity
profiles.
"""

from enum import StrEnum


class Country(str):
    """
    Specifies the home country of a person
    """

    @staticmethod
    def title() -> str:
        return "country"


class WorkStatus(StrEnum):
    """
    Specifies the working status of a person
    """

    full_time = "full time"
    part_time = "part time"
    unemployed = "unemployed"
    retired = "retired"
    student = "student"

    undetermined = "undetermined"
    work_full_or_part = "full or part time"
    unemployed_or_retired = "unemployed or retired"

    @staticmethod
    def title() -> str:
        return "work status"

    def is_determined(self) -> bool:
        return not (
            self == WorkStatus.undetermined
            or self == WorkStatus.work_full_or_part
            or self == WorkStatus.unemployed_or_retired
        )


class Sex(StrEnum):
    """
    Specifies the sex of a person
    """

    male = "male"
    female = "female"

    @staticmethod
    def title() -> str:
        return "sex"


class DayType(StrEnum):
    """
    Specifies the day type of a diary entry
    """

    work = "working day"
    no_work = "rest day"

    undetermined = "undetermined"

    @staticmethod
    def title() -> str:
        return "day type"


class Person(str):
    """
    Specifies the name or other identifier of a person
    """

    @staticmethod
    def title() -> str:
        return "person"


def get_default_categorization_attributes() -> list[str]:
    """
    Returns the categorization attributes for a full
    categorization (country, sex, work status, day type)

    :return: the categorization attributes
    """
    categorization_attributes = [
        Country.title(),
        Sex.title(),
        WorkStatus.title(),
        DayType.title(),
    ]
    return categorization_attributes