Source code for betty.app.config

"""
Provide application configuration.
"""

from __future__ import annotations

from typing import TYPE_CHECKING, final

from typing_extensions import override

from betty import fs
from betty.assertion import (
    OptionalField,
    assert_locale,
    assert_record,
    assert_setattr,
    assert_str,
)
from betty.config import Configuration
from betty.typing import pickleable

if TYPE_CHECKING:
    from betty.serde.dump import Dump, DumpMapping

CONFIGURATION_FILE_PATH = fs.HOME_DIRECTORY_PATH / "app.json"




@final
@pickleable
class AppConfiguration(Configuration):
    """
    Provide configuration for :py:class:`betty.app.App`.
    """



    def __init__(
        self,
        *,
        locale: str | None = None,
    ):
        super().__init__()
        self._locale: str | None = locale


    @property
    def locale(self) -> str | None:
        """
        The application locale.
        """
        return self._locale

    @locale.setter
    def locale(self, locale: str) -> None:
        self.assert_mutable()
        self._locale = assert_locale()(locale)



    @override
    def load(self, dump: Dump) -> None:
        self.assert_mutable()
        assert_record(
            OptionalField("locale", assert_str() | assert_setattr(self, "locale"))
        )(dump)




    @override
    def dump(self) -> DumpMapping[Dump]:
        if self.locale is None:
            return {}
        return {"locale": self.locale}