Skip to content

TTS preferences

Source: ui/tts_preferences.py

Process-wide TTS language, auto-speak, and word-list speaker defaults, loaded from and saved to preferences. A set with empty override cells uses these values. Ownership and preference keys are in State and persistence; per-set cells are in Per-set settings. Startup restore order is in Startup.

Process-wide TTS language and auto-speak flags backed by preferences.

TtsPreferences

Runtime TTS settings loaded at startup and edited from Settings.

DEFAULT_* flags are the original Settings values. The mutable class attributes below start there and change when the user edits Settings.

Attributes:

Name Type Description
language str

gTTS language code used by AppSession.speak.
auto_speak_definitions bool

When True, definitions Check auto-plays the word without error snackbars.
speakers_word_formations bool

When True, word-list cards show speakers on verb/person/thing/adjective/adverb fields.
speakers_word bool

When True, definition-list cards show a speaker on the word field.
speakers_definition bool

When True, definition-list cards show a speaker on the definition field.
Source code in src/learning_app/ui/tts_preferences.py 
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
class TtsPreferences:
    """Runtime TTS settings loaded at startup and edited from Settings.

    ``DEFAULT_*`` flags are the original Settings values. The mutable class
    attributes below start there and change when the user edits Settings.

    Attributes:
        language: gTTS language code used by ``AppSession.speak``.
        auto_speak_definitions: When ``True``, definitions Check auto-plays
            the word without error snackbars.
        speakers_word_formations: When ``True``, word-list cards show speakers
            on verb/person/thing/adjective/adverb fields.
        speakers_word: When ``True``, definition-list cards show a speaker on
            the word field.
        speakers_definition: When ``True``, definition-list cards show a
            speaker on the definition field.
    """

    DEFAULT_AUTO_SPEAK_DEFINITIONS = True
    DEFAULT_SPEAKERS_WORD_FORMATIONS = True
    DEFAULT_SPEAKERS_WORD = True
    DEFAULT_SPEAKERS_DEFINITION = False

    language: str = DEFAULT_LANGUAGE
    auto_speak_definitions: bool = DEFAULT_AUTO_SPEAK_DEFINITIONS
    speakers_word_formations: bool = DEFAULT_SPEAKERS_WORD_FORMATIONS
    speakers_word: bool = DEFAULT_SPEAKERS_WORD
    speakers_definition: bool = DEFAULT_SPEAKERS_DEFINITION

    @classmethod
    def normalize_language(cls, language: object) -> str:
        """Return a supported language code, or English when unknown."""
        if isinstance(language, str) and language in LANGUAGE_CODES:
            return language
        return DEFAULT_LANGUAGE

    @classmethod
    def parse_auto_speak(cls, raw: object) -> bool:
        """Parse a stored auto-speak value; missing or unknown means on."""
        return cls._parse_bool(raw, default=True)

    @classmethod
    def parse_speakers_word_formations(cls, raw: object) -> bool:
        """Parse word-formation speaker switch; missing or unknown means on."""
        return cls._parse_bool(raw, default=True)

    @classmethod
    def parse_speakers_word(cls, raw: object) -> bool:
        """Parse word-field speaker switch; missing or unknown means on."""
        return cls._parse_bool(raw, default=True)

    @classmethod
    def parse_speakers_definition(cls, raw: object) -> bool:
        """Parse definition-field speaker switch; missing or unknown means off."""
        return cls._parse_bool(raw, default=False)

    @classmethod
    def _parse_bool(cls, raw: object, *, default: bool) -> bool:
        if raw is None:
            return default
        text = str(raw).strip().lower()
        if default:
            return text not in {"false", "0", "off", "no"}
        return text in {"true", "1", "on", "yes"}

    @classmethod
    async def load_from_preferences(cls) -> None:
        """Load language, auto-speak, and list-speaker flags from storage.

        Missing keys are seeded with English, auto-speak on, word-formation
        and word speakers on, and definition speakers off.
        """
        storage = get_shared_preferences()
        if not await storage.contains_key(LANGUAGE_KEY):
            await storage.set(LANGUAGE_KEY, DEFAULT_LANGUAGE)
        if not await storage.contains_key(AUTO_SPEAK_DEFINITIONS_KEY):
            await storage.set(AUTO_SPEAK_DEFINITIONS_KEY, "true")
        if not await storage.contains_key(SPEAKERS_WORD_FORMATIONS_KEY):
            await storage.set(SPEAKERS_WORD_FORMATIONS_KEY, "true")
        if not await storage.contains_key(SPEAKERS_WORD_KEY):
            await storage.set(SPEAKERS_WORD_KEY, "true")
        if not await storage.contains_key(SPEAKERS_DEFINITION_KEY):
            await storage.set(SPEAKERS_DEFINITION_KEY, "false")
        cls.language = cls.normalize_language(await storage.get(LANGUAGE_KEY))
        cls.auto_speak_definitions = cls.parse_auto_speak(
            await storage.get(AUTO_SPEAK_DEFINITIONS_KEY)
        )
        cls.speakers_word_formations = cls.parse_speakers_word_formations(
            await storage.get(SPEAKERS_WORD_FORMATIONS_KEY)
        )
        cls.speakers_word = cls.parse_speakers_word(
            await storage.get(SPEAKERS_WORD_KEY)
        )
        cls.speakers_definition = cls.parse_speakers_definition(
            await storage.get(SPEAKERS_DEFINITION_KEY)
        )

    @classmethod
    async def save_language(cls, language: str) -> None:
        """Persist and apply a language code."""
        cls.language = cls.normalize_language(language)
        await get_shared_preferences().set(LANGUAGE_KEY, cls.language)

    @classmethod
    async def save_auto_speak_definitions(cls, enabled: bool) -> None:
        """Persist and apply the definitions auto-speak switch."""
        cls.auto_speak_definitions = bool(enabled)
        await get_shared_preferences().set(
            AUTO_SPEAK_DEFINITIONS_KEY,
            "true" if cls.auto_speak_definitions else "false",
        )

    @classmethod
    async def save_speakers_word_formations(cls, enabled: bool) -> None:
        """Persist and apply speakers on word-formation list cards."""
        cls.speakers_word_formations = bool(enabled)
        await get_shared_preferences().set(
            SPEAKERS_WORD_FORMATIONS_KEY,
            "true" if cls.speakers_word_formations else "false",
        )

    @classmethod
    async def save_speakers_word(cls, enabled: bool) -> None:
        """Persist and apply speakers on definition-list word fields."""
        cls.speakers_word = bool(enabled)
        await get_shared_preferences().set(
            SPEAKERS_WORD_KEY,
            "true" if cls.speakers_word else "false",
        )

    @classmethod
    async def save_speakers_definition(cls, enabled: bool) -> None:
        """Persist and apply speakers on definition-list definition fields."""
        cls.speakers_definition = bool(enabled)
        await get_shared_preferences().set(
            SPEAKERS_DEFINITION_KEY,
            "true" if cls.speakers_definition else "false",
        )

normalize_language classmethod 

normalize_language(language: object) -> str

Return a supported language code, or English when unknown.

Source code in src/learning_app/ui/tts_preferences.py 
56
57
58
59
60
61
@classmethod
def normalize_language(cls, language: object) -> str:
    """Return a supported language code, or English when unknown."""
    if isinstance(language, str) and language in LANGUAGE_CODES:
        return language
    return DEFAULT_LANGUAGE

parse_auto_speak classmethod 

parse_auto_speak(raw: object) -> bool

Parse a stored auto-speak value; missing or unknown means on.

Source code in src/learning_app/ui/tts_preferences.py 
63
64
65
66
@classmethod
def parse_auto_speak(cls, raw: object) -> bool:
    """Parse a stored auto-speak value; missing or unknown means on."""
    return cls._parse_bool(raw, default=True)

parse_speakers_word_formations classmethod 

parse_speakers_word_formations(raw: object) -> bool

Parse word-formation speaker switch; missing or unknown means on.

Source code in src/learning_app/ui/tts_preferences.py 
68
69
70
71
@classmethod
def parse_speakers_word_formations(cls, raw: object) -> bool:
    """Parse word-formation speaker switch; missing or unknown means on."""
    return cls._parse_bool(raw, default=True)

parse_speakers_word classmethod 

parse_speakers_word(raw: object) -> bool

Parse word-field speaker switch; missing or unknown means on.

Source code in src/learning_app/ui/tts_preferences.py 
73
74
75
76
@classmethod
def parse_speakers_word(cls, raw: object) -> bool:
    """Parse word-field speaker switch; missing or unknown means on."""
    return cls._parse_bool(raw, default=True)

parse_speakers_definition classmethod 

parse_speakers_definition(raw: object) -> bool

Parse definition-field speaker switch; missing or unknown means off.

Source code in src/learning_app/ui/tts_preferences.py 
78
79
80
81
@classmethod
def parse_speakers_definition(cls, raw: object) -> bool:
    """Parse definition-field speaker switch; missing or unknown means off."""
    return cls._parse_bool(raw, default=False)

load_from_preferences async classmethod 

load_from_preferences() -> None

Load language, auto-speak, and list-speaker flags from storage.

Missing keys are seeded with English, auto-speak on, word-formation and word speakers on, and definition speakers off.

Source code in src/learning_app/ui/tts_preferences.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
@classmethod
async def load_from_preferences(cls) -> None:
    """Load language, auto-speak, and list-speaker flags from storage.

    Missing keys are seeded with English, auto-speak on, word-formation
    and word speakers on, and definition speakers off.
    """
    storage = get_shared_preferences()
    if not await storage.contains_key(LANGUAGE_KEY):
        await storage.set(LANGUAGE_KEY, DEFAULT_LANGUAGE)
    if not await storage.contains_key(AUTO_SPEAK_DEFINITIONS_KEY):
        await storage.set(AUTO_SPEAK_DEFINITIONS_KEY, "true")
    if not await storage.contains_key(SPEAKERS_WORD_FORMATIONS_KEY):
        await storage.set(SPEAKERS_WORD_FORMATIONS_KEY, "true")
    if not await storage.contains_key(SPEAKERS_WORD_KEY):
        await storage.set(SPEAKERS_WORD_KEY, "true")
    if not await storage.contains_key(SPEAKERS_DEFINITION_KEY):
        await storage.set(SPEAKERS_DEFINITION_KEY, "false")
    cls.language = cls.normalize_language(await storage.get(LANGUAGE_KEY))
    cls.auto_speak_definitions = cls.parse_auto_speak(
        await storage.get(AUTO_SPEAK_DEFINITIONS_KEY)
    )
    cls.speakers_word_formations = cls.parse_speakers_word_formations(
        await storage.get(SPEAKERS_WORD_FORMATIONS_KEY)
    )
    cls.speakers_word = cls.parse_speakers_word(
        await storage.get(SPEAKERS_WORD_KEY)
    )
    cls.speakers_definition = cls.parse_speakers_definition(
        await storage.get(SPEAKERS_DEFINITION_KEY)
    )

save_language async classmethod 

save_language(language: str) -> None

Persist and apply a language code.

Source code in src/learning_app/ui/tts_preferences.py 
124
125
126
127
128
@classmethod
async def save_language(cls, language: str) -> None:
    """Persist and apply a language code."""
    cls.language = cls.normalize_language(language)
    await get_shared_preferences().set(LANGUAGE_KEY, cls.language)

save_auto_speak_definitions async classmethod 

save_auto_speak_definitions(enabled: bool) -> None

Persist and apply the definitions auto-speak switch.

Source code in src/learning_app/ui/tts_preferences.py 
130
131
132
133
134
135
136
137
@classmethod
async def save_auto_speak_definitions(cls, enabled: bool) -> None:
    """Persist and apply the definitions auto-speak switch."""
    cls.auto_speak_definitions = bool(enabled)
    await get_shared_preferences().set(
        AUTO_SPEAK_DEFINITIONS_KEY,
        "true" if cls.auto_speak_definitions else "false",
    )

save_speakers_word_formations async classmethod 

save_speakers_word_formations(enabled: bool) -> None

Persist and apply speakers on word-formation list cards.

Source code in src/learning_app/ui/tts_preferences.py 
139
140
141
142
143
144
145
146
@classmethod
async def save_speakers_word_formations(cls, enabled: bool) -> None:
    """Persist and apply speakers on word-formation list cards."""
    cls.speakers_word_formations = bool(enabled)
    await get_shared_preferences().set(
        SPEAKERS_WORD_FORMATIONS_KEY,
        "true" if cls.speakers_word_formations else "false",
    )

save_speakers_word async classmethod 

save_speakers_word(enabled: bool) -> None

Persist and apply speakers on definition-list word fields.

Source code in src/learning_app/ui/tts_preferences.py 
148
149
150
151
152
153
154
155
@classmethod
async def save_speakers_word(cls, enabled: bool) -> None:
    """Persist and apply speakers on definition-list word fields."""
    cls.speakers_word = bool(enabled)
    await get_shared_preferences().set(
        SPEAKERS_WORD_KEY,
        "true" if cls.speakers_word else "false",
    )

save_speakers_definition async classmethod 

save_speakers_definition(enabled: bool) -> None

Persist and apply speakers on definition-list definition fields.

Source code in src/learning_app/ui/tts_preferences.py 
157
158
159
160
161
162
163
164
@classmethod
async def save_speakers_definition(cls, enabled: bool) -> None:
    """Persist and apply speakers on definition-list definition fields."""
    cls.speakers_definition = bool(enabled)
    await get_shared_preferences().set(
        SPEAKERS_DEFINITION_KEY,
        "true" if cls.speakers_definition else "false",
    )