scratchattach 2.1.9__py3-none-any.whl → 2.1.10a0__py3-none-any.whl

scratchattach/utils/enums.py

@@ -1,190 +1,197 @@
-"""
-List of supported languages of scratch's translate and text2speech extensions.
-Adapted from https://translate-service.scratch.mit.edu/supported?language=en
-"""
-
-from enum import Enum
-from dataclasses import dataclass
-
-from typing import Callable, Iterable
-
-
-@dataclass(init=True, repr=True)
-class Language:
-    name: str = None
-    code: str = None
-    locales: list[str] = None
-    tts_locale: str = None
-    single_gender: bool = None
-
-
-class _EnumWrapper(Enum):
-    @classmethod
-    def find(cls, value, by: str, apply_func: Callable = None):
-        """
-        Finds the enum item with the given attribute that is equal to the given value.
-        the apply_func will be applied to the attribute of each language object before comparison.
-
-        i.e. Languages.find("ukranian", "name", str.lower) will return the Ukrainian language dataclass object
-        (even though Ukrainian was spelt lowercase, since str.lower will convert the "Ukrainian" string to lowercase)
-        """
-        if apply_func is None:
-            def apply_func(x):
-                return x
-
-        for item in cls:
-            item_obj = item.value
-
-            try:
-                if apply_func(getattr(item_obj, by)) == value:
-                    return item_obj
-            except TypeError:
-                pass
-
-    @classmethod
-    def all_of(cls, attr_name: str, apply_func: Callable = None) -> Iterable:
-        """
-        Returns the list of each listed enum item's specified attribute by "attr_name"
-
-        i.e. Languages.all_of("name") will return a list of names:
-        ["Albanian", "Amharic", ...]
-
-        The apply_func function will be applied to every list item,
-        i.e. Languages.all_of("name", str.lower) will return the same except in lowercase:
-        ["albanian", "amharic", ...]
-        """
-        if apply_func is None:
-            def apply_func(x):
-                return x
-
-        for item in cls:
-            item_obj = item.value
-            attr = getattr(item_obj, attr_name)
-            try:
-                yield apply_func(attr)
-
-            except TypeError:
-                yield attr
-
-    @classmethod
-    def find_by_attrs(cls, value, bys: list[str], apply_func: Callable = None) -> list:
-        """
-        Calls the EnumWrapper.by function multiple times until a match is found, using the provided 'by' attribute names
-        """
-        for by in bys:
-            ret = cls.find(value, by, apply_func)
-            if ret is not None:
-                return ret
-
-
-class Languages(_EnumWrapper):
-    Albanian = Language('Albanian', 'sq', None, None, None)
-    Amharic = Language('Amharic', 'am', None, None, None)
-    Arabic = Language('Arabic', 'ar', ['ar'], 'arb', True)
-    Armenian = Language('Armenian', 'hy', None, None, None)
-    Azerbaijani = Language('Azerbaijani', 'az', None, None, None)
-    Basque = Language('Basque', 'eu', None, None, None)
-    Belarusian = Language('Belarusian', 'be', None, None, None)
-    Bulgarian = Language('Bulgarian', 'bg', None, None, None)
-    Catalan = Language('Catalan', 'ca', None, None, None)
-    Chinese_Traditional = Language('Chinese (Traditional)', 'zh-tw', ['zh-cn', 'zh-tw'], 'cmn-CN', True)
-    Croatian = Language('Croatian', 'hr', None, None, None)
-    Czech = Language('Czech', 'cs', None, None, None)
-    Danish = Language('Danish', 'da', ['da'], 'da-DK', False)
-    Dutch = Language('Dutch', 'nl', ['nl'], 'nl-NL', False)
-    English = Language('English', 'en', ['en'], 'en-US', False)
-    Esperanto = Language('Esperanto', 'eo', None, None, None)
-    Estonian = Language('Estonian', 'et', None, None, None)
-    Finnish = Language('Finnish', 'fi', None, None, None)
-    French = Language('French', 'fr', ['fr'], 'fr-FR', False)
-    Galician = Language('Galician', 'gl', None, None, None)
-    German = Language('German', 'de', ['de'], 'de-DE', False)
-    Greek = Language('Greek', 'el', None, None, None)
-    Haitian_Creole = Language('Haitian Creole', 'ht', None, None, None)
-    Hindi = Language('Hindi', 'hi', ['hi'], 'hi-IN', True)
-    Hungarian = Language('Hungarian', 'hu', None, None, None)
-    Icelandic = Language('Icelandic', 'is', ['is'], 'is-IS', False)
-    Indonesian = Language('Indonesian', 'id', None, None, None)
-    Irish = Language('Irish', 'ga', None, None, None)
-    Italian = Language('Italian', 'it', ['it'], 'it-IT', False)
-    Japanese = Language('Japanese', 'ja', ['ja', 'ja-hira'], 'ja-JP', False)
-    Kannada = Language('Kannada', 'kn', None, None, None)
-    Korean = Language('Korean', 'ko', ['ko'], 'ko-KR', True)
-    Kurdish_Kurmanji = Language('Kurdish (Kurmanji)', 'ku', None, None, None)
-    Latin = Language('Latin', 'la', None, None, None)
-    Latvian = Language('Latvian', 'lv', None, None, None)
-    Lithuanian = Language('Lithuanian', 'lt', None, None, None)
-    Macedonian = Language('Macedonian', 'mk', None, None, None)
-    Malay = Language('Malay', 'ms', None, None, None)
-    Malayalam = Language('Malayalam', 'ml', None, None, None)
-    Maltese = Language('Maltese', 'mt', None, None, None)
-    Maori = Language('Maori', 'mi', None, None, None)
-    Marathi = Language('Marathi', 'mr', None, None, None)
-    Mongolian = Language('Mongolian', 'mn', None, None, None)
-    Myanmar_Burmese = Language('Myanmar (Burmese)', 'my', None, None, None)
-    Persian = Language('Persian', 'fa', None, None, None)
-    Polish = Language('Polish', 'pl', ['pl'], 'pl-PL', False)
-    Portuguese = Language('Portuguese', 'pt', ['pt'], 'pt-PT', False)
-    Romanian = Language('Romanian', 'ro', ['ro'], 'ro-RO', True)
-    Russian = Language('Russian', 'ru', ['ru'], 'ru-RU', False)
-    Scots_Gaelic = Language('Scots Gaelic', 'gd', None, None, None)
-    Serbian = Language('Serbian', 'sr', None, None, None)
-    Slovak = Language('Slovak', 'sk', None, None, None)
-    Slovenian = Language('Slovenian', 'sl', None, None, None)
-    Spanish = Language('Spanish', 'es', None, None, None)
-    Swedish = Language('Swedish', 'sv', ['sv'], 'sv-SE', True)
-    Telugu = Language('Telugu', 'te', None, None, None)
-    Thai = Language('Thai', 'th', None, None, None)
-    Turkish = Language('Turkish', 'tr', ['tr'], 'tr-TR', True)
-    Ukrainian = Language('Ukrainian', 'uk', None, None, None)
-    Uzbek = Language('Uzbek', 'uz', None, None, None)
-    Vietnamese = Language('Vietnamese', 'vi', None, None, None)
-    Welsh = Language('Welsh', 'cy', ['cy'], 'cy-GB', True)
-    Zulu = Language('Zulu', 'zu', None, None, None)
-    Hebrew = Language('Hebrew', 'he', None, None, None)
-    Chinese_Simplified = Language('Chinese (Simplified)', 'zh-cn', ['zh-cn', 'zh-tw'], 'cmn-CN', True)
-    Mandarin = Chinese_Simplified
-
-    nb_NO = Language(None, None, ['nb', 'nn'], 'nb-NO', True)
-    pt_BR = Language(None, None, ['pt-br'], 'pt-BR', False)
-    Brazilian = pt_BR
-    es_ES = Language(None, None, ['es'], 'es-ES', False)
-    es_US = Language(None, None, ['es-419'], 'es-US', False)
-
-    @classmethod
-    def find(cls, value, by: str = "name", apply_func: Callable = None) -> Language:
-        return super().find(value, by, apply_func)
-
-    @classmethod
-    def all_of(cls, attr_name: str = "name", apply_func: Callable = None) -> list:
-        return super().all_of(attr_name, apply_func)
-
-
-@dataclass(init=True, repr=True)
-class TTSVoice:
-    name: str
-    gender: str
-    playback_rate: float | int = 1
-
-
-class TTSVoices(_EnumWrapper):
-    alto = TTSVoice("alto", "female")
-    # female is functionally equal to alto
-    female = TTSVoice("female", "female")
-
-    tenor = TTSVoice("tenor", "male")
-    # male is functionally equal to tenor
-    male = TTSVoice("male", "male")
-
-    squeak = TTSVoice("squeak", "female", 1.19)
-    giant = TTSVoice("giant", "male", .84)
-    kitten = TTSVoice("kitten", "female", 1.41)
-
-    @classmethod
-    def find(cls, value, by: str = "name", apply_func: Callable = None) -> TTSVoice:
-        return super().find(value, by, apply_func)
-
-    @classmethod
-    def all_of(cls, attr_name: str = "name", apply_func: Callable = None) -> Iterable:
-        return super().all_of(attr_name, apply_func)
-
+"""
+List of supported languages of scratch's translate and text2speech extensions.
+Adapted from https://translate-service.scratch.mit.edu/supported?language=en
+"""
+from __future__ import annotations
+
+from enum import Enum
+from dataclasses import dataclass
+
+from typing import Optional, Callable, Iterable
+
+
+@dataclass(init=True, repr=True)
+class Language:
+    name: str = None
+    code: str = None
+    locales: list[str] = None
+    tts_locale: str = None
+    single_gender: bool = None
+
+
+class _EnumWrapper(Enum):
+    @classmethod
+    def find(cls, value, by: str, apply_func: Optional[Callable] = None):
+        """
+        Finds the enum item with the given attribute that is equal to the given value.
+        the apply_func will be applied to the attribute of each language object before comparison.
+
+        i.e. Languages.find("ukranian", "name", str.lower) will return the Ukrainian language dataclass object
+        (even though Ukrainian was spelt lowercase, since str.lower will convert the "Ukrainian" string to lowercase)
+        """
+        if apply_func is None:
+            def apply_func(x):
+                return x
+
+        for item in cls:
+            item_obj = item.value
+
+            try:
+                if by is None:
+                    _val = item_obj
+                else:
+                    _val = getattr(item_obj, by)
+
+                if apply_func(_val) == value:
+                    return item_obj
+                  
+            except TypeError:
+                pass
+
+    @classmethod
+    def all_of(cls, attr_name: str, apply_func: Optional[Callable] = None) -> Iterable:
+        """
+        Returns the list of each listed enum item's specified attribute by "attr_name"
+
+        i.e. Languages.all_of("name") will return a list of names:
+        ["Albanian", "Amharic", ...]
+
+        The apply_func function will be applied to every list item,
+        i.e. Languages.all_of("name", str.lower) will return the same except in lowercase:
+        ["albanian", "amharic", ...]
+        """
+        if apply_func is None:
+            def apply_func(x):
+                return x
+
+        for item in cls:
+            item_obj = item.value
+            attr = getattr(item_obj, attr_name)
+            try:
+                yield apply_func(attr)
+
+            except TypeError:
+                yield attr
+
+    @classmethod
+    def find_by_attrs(cls, value, bys: list[str], apply_func: Optional[Callable] = None) -> list:
+        """
+        Calls the EnumWrapper.by function multiple times until a match is found, using the provided 'by' attribute names
+        """
+        for by in bys:
+            ret = cls.find(value, by, apply_func)
+            if ret is not None:
+                return ret
+
+
+class Languages(_EnumWrapper):
+    Albanian = Language('Albanian', 'sq', None, None, None)
+    Amharic = Language('Amharic', 'am', None, None, None)
+    Arabic = Language('Arabic', 'ar', ['ar'], 'arb', True)
+    Armenian = Language('Armenian', 'hy', None, None, None)
+    Azerbaijani = Language('Azerbaijani', 'az', None, None, None)
+    Basque = Language('Basque', 'eu', None, None, None)
+    Belarusian = Language('Belarusian', 'be', None, None, None)
+    Bulgarian = Language('Bulgarian', 'bg', None, None, None)
+    Catalan = Language('Catalan', 'ca', None, None, None)
+    Chinese_Traditional = Language('Chinese (Traditional)', 'zh-tw', ['zh-cn', 'zh-tw'], 'cmn-CN', True)
+    Croatian = Language('Croatian', 'hr', None, None, None)
+    Czech = Language('Czech', 'cs', None, None, None)
+    Danish = Language('Danish', 'da', ['da'], 'da-DK', False)
+    Dutch = Language('Dutch', 'nl', ['nl'], 'nl-NL', False)
+    English = Language('English', 'en', ['en'], 'en-US', False)
+    Esperanto = Language('Esperanto', 'eo', None, None, None)
+    Estonian = Language('Estonian', 'et', None, None, None)
+    Finnish = Language('Finnish', 'fi', None, None, None)
+    French = Language('French', 'fr', ['fr'], 'fr-FR', False)
+    Galician = Language('Galician', 'gl', None, None, None)
+    German = Language('German', 'de', ['de'], 'de-DE', False)
+    Greek = Language('Greek', 'el', None, None, None)
+    Haitian_Creole = Language('Haitian Creole', 'ht', None, None, None)
+    Hindi = Language('Hindi', 'hi', ['hi'], 'hi-IN', True)
+    Hungarian = Language('Hungarian', 'hu', None, None, None)
+    Icelandic = Language('Icelandic', 'is', ['is'], 'is-IS', False)
+    Indonesian = Language('Indonesian', 'id', None, None, None)
+    Irish = Language('Irish', 'ga', None, None, None)
+    Italian = Language('Italian', 'it', ['it'], 'it-IT', False)
+    Japanese = Language('Japanese', 'ja', ['ja', 'ja-hira'], 'ja-JP', False)
+    Kannada = Language('Kannada', 'kn', None, None, None)
+    Korean = Language('Korean', 'ko', ['ko'], 'ko-KR', True)
+    Kurdish_Kurmanji = Language('Kurdish (Kurmanji)', 'ku', None, None, None)
+    Latin = Language('Latin', 'la', None, None, None)
+    Latvian = Language('Latvian', 'lv', None, None, None)
+    Lithuanian = Language('Lithuanian', 'lt', None, None, None)
+    Macedonian = Language('Macedonian', 'mk', None, None, None)
+    Malay = Language('Malay', 'ms', None, None, None)
+    Malayalam = Language('Malayalam', 'ml', None, None, None)
+    Maltese = Language('Maltese', 'mt', None, None, None)
+    Maori = Language('Maori', 'mi', None, None, None)
+    Marathi = Language('Marathi', 'mr', None, None, None)
+    Mongolian = Language('Mongolian', 'mn', None, None, None)
+    Myanmar_Burmese = Language('Myanmar (Burmese)', 'my', None, None, None)
+    Persian = Language('Persian', 'fa', None, None, None)
+    Polish = Language('Polish', 'pl', ['pl'], 'pl-PL', False)
+    Portuguese = Language('Portuguese', 'pt', ['pt'], 'pt-PT', False)
+    Romanian = Language('Romanian', 'ro', ['ro'], 'ro-RO', True)
+    Russian = Language('Russian', 'ru', ['ru'], 'ru-RU', False)
+    Scots_Gaelic = Language('Scots Gaelic', 'gd', None, None, None)
+    Serbian = Language('Serbian', 'sr', None, None, None)
+    Slovak = Language('Slovak', 'sk', None, None, None)
+    Slovenian = Language('Slovenian', 'sl', None, None, None)
+    Spanish = Language('Spanish', 'es', None, None, None)
+    Swedish = Language('Swedish', 'sv', ['sv'], 'sv-SE', True)
+    Telugu = Language('Telugu', 'te', None, None, None)
+    Thai = Language('Thai', 'th', None, None, None)
+    Turkish = Language('Turkish', 'tr', ['tr'], 'tr-TR', True)
+    Ukrainian = Language('Ukrainian', 'uk', None, None, None)
+    Uzbek = Language('Uzbek', 'uz', None, None, None)
+    Vietnamese = Language('Vietnamese', 'vi', None, None, None)
+    Welsh = Language('Welsh', 'cy', ['cy'], 'cy-GB', True)
+    Zulu = Language('Zulu', 'zu', None, None, None)
+    Hebrew = Language('Hebrew', 'he', None, None, None)
+    Chinese_Simplified = Language('Chinese (Simplified)', 'zh-cn', ['zh-cn', 'zh-tw'], 'cmn-CN', True)
+    Mandarin = Chinese_Simplified
+
+    nb_NO = Language(None, None, ['nb', 'nn'], 'nb-NO', True)
+    pt_BR = Language(None, None, ['pt-br'], 'pt-BR', False)
+    Brazilian = pt_BR
+    es_ES = Language(None, None, ['es'], 'es-ES', False)
+    es_US = Language(None, None, ['es-419'], 'es-US', False)
+
+    @classmethod
+    def find(cls, value, by: str = "name", apply_func: Optional[Callable] = None) -> Language:
+        return super().find(value, by, apply_func)
+
+    @classmethod
+    def all_of(cls, attr_name: str = "name", apply_func: Optional[Callable] = None) -> list:
+        return super().all_of(attr_name, apply_func)
+
+
+@dataclass(init=True, repr=True)
+class TTSVoice:
+    name: str
+    gender: str
+    playback_rate: float | int = 1
+
+
+class TTSVoices(_EnumWrapper):
+    alto = TTSVoice("alto", "female")
+    # female is functionally equal to alto
+    female = TTSVoice("female", "female")
+
+    tenor = TTSVoice("tenor", "male")
+    # male is functionally equal to tenor
+    male = TTSVoice("male", "male")
+
+    squeak = TTSVoice("squeak", "female", 1.19)
+    giant = TTSVoice("giant", "male", .84)
+    kitten = TTSVoice("kitten", "female", 1.41)
+
+    @classmethod
+    def find(cls, value, by: str = "name", apply_func: Optional[Callable] = None) -> TTSVoice:
+        return super().find(value, by, apply_func)
+
+    @classmethod
+    def all_of(cls, attr_name: str = "name", apply_func: Optional[Callable] = None) -> Iterable:
+        return super().all_of(attr_name, apply_func)
+