__init__.py

"""
This module provides support for user settings stored locally, for development, or for
CLIs.
"""

from pathlib import Path
from typing import Any
from uuid import uuid4

from config.common import ConfigurationSource
from config.json import JSONFile

try:
    # Python 3.11
    import tomllib
except ImportError:  # pragma: no cover
    # older Python
    import tomli as tomllib  # noqa


def get_project_name() -> str:
    pyproject = Path("pyproject.toml").resolve()

    if pyproject.exists():
        with open(pyproject, "rb") as source:
            data = tomllib.load(source)
        try:
            return data["project"]["name"]
        except KeyError:  # pragma: no cover
            pass

    return uuid4().hex


class UserSettings(ConfigurationSource):
    """
    This class reads settings stored in a file inside the user's folder.
    """

    def __init__(self, project_name: str | None = None, optional: bool = True) -> None:
        """
        Configures an instance of UserSettings that obtains values from a project file
        stored in the user's folder. If a project name is not provided, it is
        automatically inferred from a `pyproject.toml` file, if present, otherwise a
        random value is generated.
        """
        if not project_name:
            project_name = get_project_name()
        self.project_name = project_name
        self._settings_file_path = (
            self.get_base_folder() / project_name / "settings.json"
        )
        self._source = JSONFile(self.settings_file_path, optional)

    def get_base_folder(self) -> Path:
        return Path.home() / ".neoteroi" / "ec"

    @property
    def settings_file_path(self) -> Path:
        return self._settings_file_path

    def get_values(self) -> dict[str, Any]:
        """Returns the values read from this source."""
        return self._source.get_values()