Use Babel's Locale everywhere to reduce data conversions

Author: bartfeenstra

betty/ancestry/locale.py

@@ -13,12 +13,14 @@
     LinkedDataDumpableWithSchemaJsonLdObject,
 )
 from betty.json.schema import Null, OneOf
-from betty.locale import UNDETERMINED_LOCALE
+from betty.locale import LocaleLike, ensure_locale, to_language_tag
 from betty.locale.localized import Localized
 from betty.locale.schema import LocaleSchema
 from betty.privacy import is_public
 
 if TYPE_CHECKING:
+    from babel import Locale
+
     from betty.project import Project
     from betty.serde.dump import Dump, DumpMapping
 
@@ -31,25 +33,25 @@ class HasLocale(Localized, LinkedDataDumpableWithSchemaJsonLdObject):
     def __init__(
         self,
         *args: Any,
-        locale: str = UNDETERMINED_LOCALE,
+        locale: LocaleLike | None = None,
         **kwargs: Any,
     ):
         super().__init__(*args, **kwargs)
-        self._locale = locale
+        self._locale = None if locale is None else ensure_locale(locale)
 
     @override  # type: ignore[explicit-override]
     @property
-    def locale(self) -> str:
+    def locale(self) -> Locale | None:
         return self._locale
 
     @locale.setter
-    def locale(self, locale: str) -> None:
+    def locale(self, locale: Locale | None) -> None:
         self._locale = locale
 
     @override
     async def dump_linked_data(self, project: Project, /) -> DumpMapping[Dump]:
         dump = await super().dump_linked_data(project)
-        dump["locale"] = self.locale if is_public(self) else None
+        dump["locale"] = to_language_tag(self.locale) if is_public(self) else None
         return dump
 
     @override

betty/ancestry/person_name.py

@@ -12,7 +12,6 @@
 from betty.ancestry.locale import HasLocale
 from betty.json.linked_data import JsonLdObject, dump_context
 from betty.json.schema import String
-from betty.locale import UNDETERMINED_LOCALE
 from betty.locale.localizable import Localizable, _, ngettext
 from betty.model import Entity, EntityPlugin
 from betty.model.association import BidirectionalToOne, ToManyAssociates, ToOneAssociate
@@ -21,6 +20,7 @@
 if TYPE_CHECKING:
     from betty.ancestry.citation import Citation
     from betty.ancestry.person import Person
+    from betty.locale import LocaleLike
     from betty.project import Project
     from betty.serde.dump import Dump, DumpMapping
 
@@ -59,7 +59,7 @@ def __init__(
         privacy: Privacy | None = None,
         public: bool | None = None,
         private: bool | None = None,
-        locale: str = UNDETERMINED_LOCALE,
+        locale: LocaleLike | None = None,
         citations: ToManyAssociates[Citation] | None = None,
     ):
         if not individual and not affiliation:

betty/app/config.py

@@ -8,17 +8,14 @@
 
 from typing_extensions import override
 
-from betty.assertion import (
-    OptionalField,
-    assert_locale,
-    assert_record,
-    assert_setattr,
-    assert_str,
-)
+from betty.assertion import OptionalField, assert_locale, assert_record, assert_setattr
 from betty.config import Configuration
 from betty.dirs import APP_CONFIG_DIRECTORY_PATH
+from betty.locale import to_language_tag
 
 if TYPE_CHECKING:
+    from babel import Locale
+
     from betty.serde.dump import Dump, DumpMapping
 
 CONFIGURATION_FILE_PATH = APP_CONFIG_DIRECTORY_PATH / "app.json"
@@ -33,32 +30,32 @@ class AppConfiguration(Configuration):
     def __init__(
         self,
         *,
-        locale: str | None = None,
+        locale: Locale | None = None,
     ):
         super().__init__()
-        self._locale: str | None = locale
+        self._locale: Locale | None = locale
 
     @property
-    def locale(self) -> str | None:
+    def locale(self) -> Locale | None:
         """
         The application locale.
         """
         return self._locale
 
     @locale.setter
-    def locale(self, locale: str) -> None:
+    def locale(self, locale: Locale | None) -> None:
         self.assert_mutable()
-        self._locale = assert_locale()(locale)
+        self._locale = locale
 
     @override
     def load(self, dump: Dump, /) -> None:
         self.assert_mutable()
         assert_record(
-            OptionalField("locale", assert_str() | assert_setattr(self, "locale"))
+            OptionalField("locale", assert_locale() | assert_setattr(self, "locale"))
         )(dump)
 
     @override
     def dump(self) -> DumpMapping[Dump]:
         if self.locale is None:
             return {}
-        return {"locale": self.locale}
+        return {"locale": to_language_tag(self.locale)}

betty/assertion.py

@@ -17,6 +17,7 @@
 from pathlib import Path
 from types import NoneType
 from typing import (
+    TYPE_CHECKING,
     Any,
     Generic,
     TypeAlias,
@@ -29,10 +30,13 @@
 from betty.data import Index, Key
 from betty.error import FileNotFound
 from betty.exception import HumanFacingException, HumanFacingExceptionGroup
-from betty.locale import UNDETERMINED_LOCALE, get_data
+from betty.locale import from_language_tag
 from betty.locale.localizable import Localizable, Paragraph, _, do_you_mean
 from betty.typing import Void, Voidable, internal
 
+if TYPE_CHECKING:
+    from babel import Locale
+
 Number: TypeAlias = int | float
 
 
@@ -525,30 +529,11 @@ def _assert_file_path(file_path: Path, /) -> Path:
     return assert_path() | _assert_file_path
 
 
-def assert_locale() -> AssertionChain[Any, str]:
+def assert_locale() -> AssertionChain[Any, Locale]:
     """
     Assert that a value is a valid `IETF BCP 47 language tag <https://en.wikipedia.org/wiki/IETF_language_tag>`_.
     """
-
-    def _assert_locale(value: str, /) -> str:
-        # Allow locales for which no system information usually exists.
-        if value == UNDETERMINED_LOCALE:
-            return value
-
-        try:
-            get_data(value)
-        except HumanFacingException as error:
-            raise HumanFacingException(error) from error
-        return value
-
-    return assert_locale_identifier() | _assert_locale
-
-
-def assert_locale_identifier() -> AssertionChain[Any, str]:
-    """
-    Assert that a value could be a valid `IETF BCP 47 language tag <https://en.wikipedia.org/wiki/IETF_language_tag>`_.
-    """
-    return assert_str() | assert_len(minimum=1) | str
+    return assert_str() | from_language_tag
 
 
 def assert_setattr(instance: object, attr_name: str, /) -> AssertionChain[Any, Any]:

betty/assets/locale/ar/betty.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: Betty VERSION\n"
 "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
-"POT-Creation-Date: 2025-11-25 02:03+0000\n"
+"POT-Creation-Date: 2025-11-27 01:37+0000\n"
 "PO-Revision-Date: 2024-11-30 19:00+0000\n"
 "Last-Translator: Bart Feenstra <[email protected]>\n"
 "Language: ar\n"
@@ -679,7 +679,7 @@ msgid "Locale aliases must not contain slashes."
 msgstr ""
 
 #, python-brace-format
-msgid "Locale {locale} is not supported by your system."
+msgid "Locale {locale} is not known by your system."
 msgstr ""
 
 msgid "Locality"
@@ -1205,11 +1205,11 @@ msgid "Unknown key: {unknown_key}."
 msgstr ""
 
 #, python-brace-format
-msgid "Unknown locale {locale}."
+msgid "Unknown plugin \"{plugin_id}\"."
 msgstr ""
 
 #, python-brace-format
-msgid "Unknown plugin \"{plugin_id}\"."
+msgid "Untranslated locale {locale}."
 msgstr ""
 
 msgid "Update all existing translations"
@@ -1267,8 +1267,8 @@ msgid "Where do you want to save your project's configuration file?"
 msgstr ""
 
 msgid ""
-"Which language should your project site be generated in? Enter an IETF "
-"BCP 47 language code."
+"Which language should your project site be generated in? Enter a language"
+" code."
 msgstr ""
 
 msgid "Wikipedia contributors"

betty/assets/locale/betty.pot

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: Betty VERSION\n"
 "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
-"POT-Creation-Date: 2025-11-25 02:03+0000\n"
+"POT-Creation-Date: 2025-11-27 01:37+0000\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"
@@ -672,7 +672,7 @@ msgid "Locale aliases must not contain slashes."
 msgstr ""
 
 #, python-brace-format
-msgid "Locale {locale} is not supported by your system."
+msgid "Locale {locale} is not known by your system."
 msgstr ""
 
 msgid "Locality"
@@ -1182,11 +1182,11 @@ msgid "Unknown key: {unknown_key}."
 msgstr ""
 
 #, python-brace-format
-msgid "Unknown locale {locale}."
+msgid "Unknown plugin \"{plugin_id}\"."
 msgstr ""
 
 #, python-brace-format
-msgid "Unknown plugin \"{plugin_id}\"."
+msgid "Untranslated locale {locale}."
 msgstr ""
 
 msgid "Update all existing translations"
@@ -1244,8 +1244,8 @@ msgid "Where do you want to save your project's configuration file?"
 msgstr ""
 
 msgid ""
-"Which language should your project site be generated in? Enter an IETF BCP"
-" 47 language code."
+"Which language should your project site be generated in? Enter a language "
+"code."
 msgstr ""
 
 msgid "Wikipedia contributors"

betty/assets/locale/de-DE/betty.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: Betty VERSION\n"
 "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
-"POT-Creation-Date: 2025-11-25 02:03+0000\n"
+"POT-Creation-Date: 2025-11-27 01:37+0000\n"
 "PO-Revision-Date: 2025-03-28 20:02+0000\n"
 "Last-Translator: Ettore Atalan <[email protected]>\n"
 "Language: de_DE\n"
@@ -708,7 +708,7 @@ msgid "Locale aliases must not contain slashes."
 msgstr "Gebietsschema-Aliase dürfen keine Schrägstriche enthalten."
 
 #, python-brace-format
-msgid "Locale {locale} is not supported by your system."
+msgid "Locale {locale} is not known by your system."
 msgstr ""
 
 msgid "Locality"
@@ -1236,11 +1236,11 @@ msgid "Unknown key: {unknown_key}."
 msgstr "Unbekannter Schlüssel: {unknown_key}."
 
 #, python-brace-format
-msgid "Unknown locale {locale}."
+msgid "Unknown plugin \"{plugin_id}\"."
 msgstr ""
 
 #, python-brace-format
-msgid "Unknown plugin \"{plugin_id}\"."
+msgid "Untranslated locale {locale}."
 msgstr ""
 
 msgid "Update all existing translations"
@@ -1300,8 +1300,8 @@ msgid "Where do you want to save your project's configuration file?"
 msgstr ""
 
 msgid ""
-"Which language should your project site be generated in? Enter an IETF "
-"BCP 47 language code."
+"Which language should your project site be generated in? Enter a language"
+" code."
 msgstr ""
 
 msgid "Wikipedia contributors"

betty/assets/locale/fr-FR/betty.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PROJECT VERSION\n"
 "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
-"POT-Creation-Date: 2025-11-25 02:03+0000\n"
+"POT-Creation-Date: 2025-11-27 01:37+0000\n"
 "PO-Revision-Date: 2025-08-27 20:02+0000\n"
 "Last-Translator: \"David D.\" <[email protected]>\n"
 "Language: fr_FR\n"
@@ -691,7 +691,7 @@ msgid "Locale aliases must not contain slashes."
 msgstr ""
 
 #, python-brace-format
-msgid "Locale {locale} is not supported by your system."
+msgid "Locale {locale} is not known by your system."
 msgstr ""
 
 msgid "Locality"
@@ -1203,11 +1203,11 @@ msgid "Unknown key: {unknown_key}."
 msgstr ""
 
 #, python-brace-format
-msgid "Unknown locale {locale}."
+msgid "Unknown plugin \"{plugin_id}\"."
 msgstr ""
 
 #, python-brace-format
-msgid "Unknown plugin \"{plugin_id}\"."
+msgid "Untranslated locale {locale}."
 msgstr ""
 
 msgid "Update all existing translations"
@@ -1267,11 +1267,9 @@ msgid "Where do you want to save your project's configuration file?"
 msgstr "Où voulez-vous enregistrer le fichier de configuration de votre projet ?"
 
 msgid ""
-"Which language should your project site be generated in? Enter an IETF "
-"BCP 47 language code."
+"Which language should your project site be generated in? Enter a language"
+" code."
 msgstr ""
-"Dans quelle langue doit être généré le site de votre projet ? Entrez un "
-"code de langue IETF BCP 47."
 
 msgid "Wikipedia contributors"
 msgstr "Contributeurs Wikipédia"