Skip to content

Home Information - Your home, your data, organized.

Python
1.3 KB
Raw Blame
from typing import List, Tuple

from hi.apps.audio.audio_file import AudioFile
from hi.apps.console.enums import Theme, DisplayUnits

from hi.constants import TIME_OF_DAY_CHOICES, TIMEZONE_NAME_LIST


class PredefinedValueRanges:
    """
    For attributes of type AttributeValueType.ENUM.  There are some
    predefined common defaults that can be used.  Instead of putting all
    the possible choices in the 'value_range_str' field of an Attribute,
    you can include a well-known identifier and the values will come from
    this module.

    This is also needed for enumerations that might change in future
    releases where we do not want to have to update the user database.
    """

    TIMEZONE_CHOICES_ID = 'hi.timezone'
    UNITS_CHOICES_ID = 'hi.units'
    THEME_CHOICES_ID = 'hi.theme'
    AUDIO_FILE_CHOICES_ID = 'hi.audio.file'
    TIME_OF_DAY_CHOICES_ID = 'hi.datetime.time-of-day'
    
    ID_TO_CHOICES = {
        TIME_OF_DAY_CHOICES_ID: TIME_OF_DAY_CHOICES,
        TIMEZONE_CHOICES_ID: [ ( x, x ) for x in TIMEZONE_NAME_LIST ],
        UNITS_CHOICES_ID: DisplayUnits.choices(),
        THEME_CHOICES_ID: Theme.choices(),
        AUDIO_FILE_CHOICES_ID: AudioFile.choices(),
    }
    
    @classmethod
    def get_choices( cls, choices_id : str ) -> List[ Tuple[ str, str ] ]:
        return cls.ID_TO_CHOICES.get( choices_id )