dycw-utilities 0.166.7__tar.gz → 0.166.9__tar.gz

{dycw_utilities-0.166.7 → dycw_utilities-0.166.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.166.7
+Version: 0.166.9
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12

{dycw_utilities-0.166.7 → dycw_utilities-0.166.9}/pyproject.toml

@@ -146,6 +146,12 @@ pqdm = [
 psutil = [
   "psutil >=7.0.0, <7.1",
 ]
+pydantic-settings = [
+  "pydantic-settings",
+]
+pydantic-settings-sops = [
+  "pydantic-settings-sops",
+]
 pyinstrument = [
   "pyinstrument >=5.1.0, <5.2",
 ]
@@ -236,7 +242,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.166.7"
+version = "0.166.9"
 
 [project.entry-points.pytest11]
 pytest-randomly = "utilities.pytest_plugins.pytest_randomly"
@@ -269,7 +275,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.166.7"
+current_version = "0.166.9"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

dycw_utilities-0.166.9/src/tests/test_pydantic_settings.py

@@ -0,0 +1,77 @@
+from __future__ import annotations
+
+from json import dumps
+from typing import TYPE_CHECKING, ClassVar
+
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+from utilities.os import temp_environ
+from utilities.pydantic_settings import CustomBaseSettings, load_settings
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+    from utilities.types import MaybeIterable, PathLike
+
+
+class TestCustomBaseSettings:
+    def test_main(self, *, tmp_path: Path) -> None:
+        file = tmp_path.joinpath("settings.toml")
+        _ = file.write_text(dumps({"x": 1, "y": 2}))
+
+        class Settings(CustomBaseSettings):
+            json_files: ClassVar[MaybeIterable[PathLike]] = file
+            x: int
+            y: int
+
+        settings = load_settings(Settings)
+        assert settings.x == 1
+        assert settings.y == 2
+
+    def test_env_var(self) -> None:
+        class Settings(CustomBaseSettings):
+            x: int
+
+        with temp_environ(x="1"):
+            settings = load_settings(Settings)
+        assert settings.x == 1
+
+    def test_env_var_with_prefix(self) -> None:
+        class Settings(CustomBaseSettings):
+            model_config = SettingsConfigDict(env_prefix="test_")
+            x: int
+
+        with temp_environ(test_x="1"):
+            settings = load_settings(Settings)
+        assert settings.x == 1
+
+    def test_env_var_with_nested(self) -> None:
+        class Settings(CustomBaseSettings):
+            inner: Inner
+
+        class Inner(BaseSettings):
+            x: int
+
+        _ = Settings.model_rebuild()
+
+        with temp_environ(inner__x="1"):
+            settings = load_settings(Settings)
+        assert settings.inner.x == 1
+
+    def test_env_var_with_prefix_and_nested(self) -> None:
+        class Settings(CustomBaseSettings):
+            model_config = SettingsConfigDict(env_prefix="test__")
+            inner: Inner
+
+        class Inner(BaseSettings):
+            x: int
+
+        _ = Settings.model_rebuild()
+        with temp_environ(test__inner__x="1"):
+            settings = load_settings(Settings)
+        assert settings.inner.x == 1
+
+    def test_no_files(self) -> None:
+        class Settings(CustomBaseSettings): ...
+
+        _ = load_settings(Settings)

dycw_utilities-0.166.9/src/tests/test_pydantic_settings_sops.py

@@ -0,0 +1,49 @@
+from __future__ import annotations
+
+import re
+from json import dumps
+from subprocess import check_call
+from typing import TYPE_CHECKING, ClassVar
+
+from tests.conftest import SKIPIF_CI
+from utilities.iterables import one
+from utilities.os import temp_environ
+from utilities.pydantic_settings import load_settings
+from utilities.pydantic_settings_sops import SopsBaseSettings
+from utilities.re import extract_group
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+    from utilities.types import MaybeIterable, PathLike
+
+
+class TestSOPSBaseSettings:
+    @SKIPIF_CI
+    def test_main(self, *, tmp_path: Path) -> None:
+        unencrypted_file = tmp_path.joinpath("unencrypted.json")
+        _ = unencrypted_file.write_text(dumps({"x": 1, "y": 2}))
+        key_file = tmp_path.joinpath("keys.txt")
+        with key_file.open(mode="w") as file:
+            _ = check_call(["age-keygen"], stdout=file)
+        pattern = re.compile(r"^# public key: (age.+)$")
+        public_line = one(
+            line for line in key_file.read_text().splitlines() if pattern.search(line)
+        )
+        public_key = extract_group(pattern, public_line)
+        encrypted_file = tmp_path.joinpath("encrypted.json")
+        with (
+            temp_environ(SOPS_AGE_RECIPIENTS=public_key),
+            encrypted_file.open(mode="w") as file,
+        ):
+            _ = check_call(["sops", "encrypt", str(unencrypted_file)], stdout=file)
+
+        class Settings(SopsBaseSettings):
+            secret_files: ClassVar[MaybeIterable[PathLike]] = encrypted_file
+            x: int
+            y: int
+
+        with temp_environ(SOPS_AGE_KEY_FILE=str(key_file)):
+            settings = load_settings(Settings)
+        assert settings.x == 1
+        assert settings.y == 2

{dycw_utilities-0.166.7 → dycw_utilities-0.166.9}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.166.7"
+__version__ = "0.166.9"

dycw_utilities-0.166.9/src/utilities/pydantic_settings.py

@@ -0,0 +1,61 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, ClassVar, override
+
+from pydantic_settings import (
+    BaseSettings,
+    JsonConfigSettingsSource,
+    PydanticBaseSettingsSource,
+    SettingsConfigDict,
+)
+
+from utilities.iterables import always_iterable
+
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+
+    from utilities.types import MaybeIterable, PathLike
+
+
+class CustomBaseSettings(BaseSettings):
+    """Base settings for loading JSON files."""
+
+    # paths
+    json_files: ClassVar[MaybeIterable[PathLike]] = ()
+
+    # config
+    model_config: ClassVar[SettingsConfigDict] = SettingsConfigDict(
+        env_nested_delimiter="__"
+    )
+
+    @classmethod
+    @override
+    def settings_customise_sources(
+        cls,
+        settings_cls: type[BaseSettings],
+        init_settings: PydanticBaseSettingsSource,
+        env_settings: PydanticBaseSettingsSource,
+        dotenv_settings: PydanticBaseSettingsSource,
+        file_secret_settings: PydanticBaseSettingsSource,
+    ) -> tuple[PydanticBaseSettingsSource, ...]:
+        _ = (init_settings, dotenv_settings, file_secret_settings)
+        return tuple(cls._yield_base_settings_sources(settings_cls, env_settings))
+
+    @classmethod
+    def _yield_base_settings_sources(
+        cls,
+        settings_cls: type[BaseSettings],
+        env_settings: PydanticBaseSettingsSource,
+        /,
+    ) -> Iterator[PydanticBaseSettingsSource]:
+        yield env_settings
+        for file in always_iterable(cls.json_files):
+            yield JsonConfigSettingsSource(settings_cls, json_file=file)
+
+
+def load_settings[T: BaseSettings](cls: type[T], /) -> T:
+    """Load a set of settings."""
+    return cls()
+
+
+__all__ = ["CustomBaseSettings", "load_settings"]

dycw_utilities-0.166.9/src/utilities/pydantic_settings_sops.py

@@ -0,0 +1,40 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, ClassVar, override
+
+from pydantic_settings_sops import SOPSConfigSettingsSource
+
+from utilities.iterables import always_iterable
+from utilities.pydantic_settings import CustomBaseSettings
+
+if TYPE_CHECKING:
+    from collections.abc import Iterator
+
+    from pydantic_settings import BaseSettings, PydanticBaseSettingsSource
+
+    from utilities.types import MaybeIterable, PathLike
+
+
+class SopsBaseSettings(CustomBaseSettings):
+    """Base settings for loading secrets using `sops/age`."""
+
+    # paths
+    secret_files: ClassVar[MaybeIterable[PathLike]] = ()
+
+    @classmethod
+    @override
+    def _yield_base_settings_sources(
+        cls,
+        settings_cls: type[BaseSettings],
+        env_settings: PydanticBaseSettingsSource,
+        /,
+    ) -> Iterator[PydanticBaseSettingsSource]:
+        yield from super()._yield_base_settings_sources(settings_cls, env_settings)
+        for file in always_iterable(cls.secret_files):
+            yield SOPSConfigSettingsSource(
+                settings_cls,  # pyright: ignore[reportArgumentType],
+                json_file=file,
+            )
+
+
+__all__ = ["SopsBaseSettings"]