dycw-utilities 0.166.16__tar.gz → 0.166.18__tar.gz

{dycw_utilities-0.166.16 → dycw_utilities-0.166.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.166.16
+Version: 0.166.18
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12
@@ -18,13 +18,13 @@ Requires-Dist: pytest-cov<6.3,>=6.2.1; extra == 'test'
 Requires-Dist: pytest-instafail<0.6,>=0.5.0; extra == 'test'
 Requires-Dist: pytest-lazy-fixtures<1.4,>=1.3.4; extra == 'test'
 Requires-Dist: pytest-randomly<3.17,>=3.16.0; extra == 'test'
-Requires-Dist: pytest-regressions<2.9,>=2.8.2; extra == 'test'
+Requires-Dist: pytest-regressions<2.9,>=2.8.3; extra == 'test'
 Requires-Dist: pytest-repeat<0.10,>=0.9.4; extra == 'test'
 Requires-Dist: pytest-rerunfailures<16.1,>=16.0.1; extra == 'test'
 Requires-Dist: pytest-rng<1.1,>=1.0.0; extra == 'test'
 Requires-Dist: pytest-timeout<2.5,>=2.4.0; extra == 'test'
 Requires-Dist: pytest-xdist<3.9,>=3.8.0; extra == 'test'
-Requires-Dist: pytest<8.5,>=8.4.1; extra == 'test'
+Requires-Dist: pytest<8.5,>=8.4.2; extra == 'test'
 Requires-Dist: testbook<0.5,>=0.4.2; extra == 'test'
 Description-Content-Type: text/markdown
 

{dycw_utilities-0.166.16 → dycw_utilities-0.166.18}/pyproject.toml

@@ -160,14 +160,14 @@ pyinstrument = [
   "pyinstrument >=5.1.0, <5.2",
 ]
 pytest = [
-  "pytest >=8.4.1, <8.5",
+  "pytest >=8.4.2, <8.5",
   "pytest-asyncio >=1.1.0, <1.2",
   "pytest-randomly >=3.16.0, <3.17",
   "pytest-timeout >=2.4.0, <2.5",
   "pytest-xdist >=3.8.0, <3.9",
 ]
 pytest-regressions = [
-  "pytest-regressions >=2.8.2, <2.9",
+  "pytest-regressions >=2.8.3, <2.9",
 ]
 pytest-regressions-test = [
   "orjson",
@@ -246,7 +246,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.166.16"
+version = "0.166.18"
 
 [project.entry-points.pytest11]
 pytest-randomly = "utilities.pytest_plugins.pytest_randomly"
@@ -259,13 +259,13 @@ logging = [
 test = [
   "dycw-pytest-only >=2.1.1, <2.2",
   "hypothesis >=6.138.13, <6.139",
-  "pytest >=8.4.1, <8.5",
+  "pytest >=8.4.2, <8.5",
   "pytest-asyncio >=1.1.0, <1.2",
   "pytest-cov >=6.2.1, <6.3",
   "pytest-instafail >=0.5.0, <0.6",
   "pytest-lazy-fixtures >=1.3.4, <1.4",
   "pytest-randomly >=3.16.0, <3.17",
-  "pytest-regressions >=2.8.2, <2.9",
+  "pytest-regressions >=2.8.3, <2.9",
   "pytest-repeat >=0.9.4, <0.10",
   "pytest-rerunfailures >=16.0.1, <16.1",
   "pytest-rng >=1.0.0, <1.1",
@@ -279,7 +279,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.166.16"
+current_version = "0.166.18"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

dycw_utilities-0.166.18/src/tests/test_pydantic_settings.py

@@ -0,0 +1,174 @@
+from __future__ import annotations
+
+import json
+from typing import TYPE_CHECKING, ClassVar
+
+import tomlkit
+import yaml
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+from utilities.os import temp_environ
+from utilities.pydantic_settings import (
+    CustomBaseSettings,
+    PathLikeOrWithSection,
+    load_settings,
+)
+
+if TYPE_CHECKING:
+    from collections.abc import Sequence
+    from pathlib import Path
+
+
+class TestCustomBaseSettings:
+    def test_json(self, *, tmp_path: Path) -> None:
+        file = tmp_path.joinpath("settings.json")
+        _ = file.write_text(json.dumps({"x": 1}))
+
+        class Settings(CustomBaseSettings):
+            json_files: ClassVar[Sequence[PathLikeOrWithSection]] = [file]
+            x: int
+
+        settings = load_settings(Settings)
+        assert settings.x == 1
+
+    def test_json_section_str(self, *, tmp_path: Path) -> None:
+        file = tmp_path.joinpath("settings.json")
+        _ = file.write_text(json.dumps({"outer": {"x": 1}}))
+
+        class Settings(CustomBaseSettings):
+            json_files: ClassVar[Sequence[PathLikeOrWithSection]] = [(file, "outer")]
+            x: int
+
+        settings = load_settings(Settings)
+        assert settings.x == 1
+
+    def test_json_section_nested(self, *, tmp_path: Path) -> None:
+        file = tmp_path.joinpath("settings.json")
+        _ = file.write_text(json.dumps({"outer": {"middle": {"x": 1}}}))
+
+        class Settings(CustomBaseSettings):
+            json_files: ClassVar[Sequence[PathLikeOrWithSection]] = [
+                (file, ["outer", "middle"])
+            ]
+            x: int
+
+        settings = load_settings(Settings)
+        assert settings.x == 1
+
+    def test_toml(self, *, tmp_path: Path) -> None:
+        file = tmp_path.joinpath("settings.toml")
+        _ = file.write_text(tomlkit.dumps({"x": 1}))
+
+        class Settings(CustomBaseSettings):
+            toml_files: ClassVar[Sequence[PathLikeOrWithSection]] = [file]
+            x: int
+
+        settings = load_settings(Settings)
+        assert settings.x == 1
+
+    def test_toml_section_str(self, *, tmp_path: Path) -> None:
+        file = tmp_path.joinpath("settings.toml")
+        _ = file.write_text(tomlkit.dumps({"outer": {"x": 1}}))
+
+        class Settings(CustomBaseSettings):
+            toml_files: ClassVar[Sequence[PathLikeOrWithSection]] = [(file, "outer")]
+            x: int
+
+        settings = load_settings(Settings)
+        assert settings.x == 1
+
+    def test_toml_section_nested(self, *, tmp_path: Path) -> None:
+        file = tmp_path.joinpath("settings.toml")
+        _ = file.write_text(tomlkit.dumps({"outer": {"middle": {"x": 1}}}))
+
+        class Settings(CustomBaseSettings):
+            toml_files: ClassVar[Sequence[PathLikeOrWithSection]] = [
+                (file, ["outer", "middle"])
+            ]
+            x: int
+
+        settings = load_settings(Settings)
+        assert settings.x == 1
+
+    def test_yaml(self, *, tmp_path: Path) -> None:
+        file = tmp_path.joinpath("settings.yaml")
+        _ = file.write_text(yaml.dump({"x": 1}))
+
+        class Settings(CustomBaseSettings):
+            yaml_files: ClassVar[Sequence[PathLikeOrWithSection]] = [file]
+            x: int
+
+        settings = load_settings(Settings)
+        assert settings.x == 1
+
+    def test_yaml_section_str(self, *, tmp_path: Path) -> None:
+        file = tmp_path.joinpath("settings.yaml")
+        _ = file.write_text(yaml.dump({"outer": {"x": 1}}))
+
+        class Settings(CustomBaseSettings):
+            yaml_files: ClassVar[Sequence[PathLikeOrWithSection]] = [(file, "outer")]
+            x: int
+
+        settings = load_settings(Settings)
+        assert settings.x == 1
+
+    def test_yaml_section_nested(self, *, tmp_path: Path) -> None:
+        file = tmp_path.joinpath("settings.yaml")
+        _ = file.write_text(yaml.dump({"outer": {"middle": {"x": 1}}}))
+
+        class Settings(CustomBaseSettings):
+            yaml_files: ClassVar[Sequence[PathLikeOrWithSection]] = [
+                (file, ["outer", "middle"])
+            ]
+            x: int
+
+        settings = load_settings(Settings)
+        assert settings.x == 1
+
+    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.16 → dycw_utilities-0.166.18}/src/tests/test_pydantic_settings_sops.py

@@ -13,9 +13,10 @@ from utilities.pydantic_settings_sops import SopsBaseSettings
 from utilities.re import extract_group
 
 if TYPE_CHECKING:
+    from collections.abc import Sequence
     from pathlib import Path
 
-    from utilities.types import MaybeIterable, PathLike
+    from utilities.types import PathLike
 
 
 class TestSOPSBaseSettings:
@@ -39,7 +40,7 @@ class TestSOPSBaseSettings:
             _ = check_call(["sops", "encrypt", str(unencrypted_file)], stdout=file)
 
         class Settings(SopsBaseSettings):
-            secret_files: ClassVar[MaybeIterable[PathLike]] = encrypted_file
+            secret_files: ClassVar[Sequence[PathLike]] = [encrypted_file]
             x: int
             y: int
 

{dycw_utilities-0.166.16 → dycw_utilities-0.166.18}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.166.16"
+__version__ = "0.166.18"

dycw_utilities-0.166.18/src/utilities/pydantic_settings.py

@@ -0,0 +1,180 @@
+from __future__ import annotations
+
+from functools import reduce
+from pathlib import Path
+from typing import TYPE_CHECKING, Any, ClassVar, assert_never, override
+
+from pydantic_settings import (
+    BaseSettings,
+    JsonConfigSettingsSource,
+    PydanticBaseSettingsSource,
+    SettingsConfigDict,
+    TomlConfigSettingsSource,
+    YamlConfigSettingsSource,
+)
+from pydantic_settings.sources import DEFAULT_PATH
+
+from utilities.iterables import always_iterable
+
+if TYPE_CHECKING:
+    from collections.abc import Iterator, Sequence
+
+    from pydantic_settings.sources import PathType
+
+    from utilities.types import MaybeSequenceStr, PathLike
+
+
+type PathLikeOrWithSection = PathLike | tuple[PathLike, MaybeSequenceStr]
+
+
+class CustomBaseSettings(BaseSettings):
+    """Base settings for loading JSON files."""
+
+    # paths
+    json_files: ClassVar[Sequence[PathLikeOrWithSection]] = []
+    toml_files: ClassVar[Sequence[PathLikeOrWithSection]] = []
+    yaml_files: ClassVar[Sequence[PathLikeOrWithSection]] = []
+
+    # 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 json in cls.json_files:
+            match json:
+                case Path() | str():
+                    yield JsonConfigSettingsSource(settings_cls, json_file=json)
+                case Path() | str() as file, str() | list() | tuple() as section:
+                    yield JsonConfigSectionSettingsSource(
+                        settings_cls, json_file=file, section=section
+                    )
+                case never:
+                    assert_never(never)
+        for toml in cls.toml_files:
+            match toml:
+                case Path() | str():
+                    yield TomlConfigSettingsSource(settings_cls, toml_file=toml)
+                case Path() | str() as file, str() | list() | tuple() as section:
+                    yield TomlConfigSectionSettingsSource(
+                        settings_cls, toml_file=file, section=section
+                    )
+                case never:
+                    assert_never(never)
+        for yaml in cls.yaml_files:
+            match yaml:
+                case Path() | str():
+                    yield YamlConfigSettingsSource(settings_cls, yaml_file=yaml)
+                case Path() | str() as file, str() | list() | tuple() as section:
+                    yield YamlConfigSectionSettingsSource(
+                        settings_cls, yaml_file=file, section=section
+                    )
+                case never:
+                    assert_never(never)
+
+
+def load_settings[T: BaseSettings](cls: type[T], /) -> T:
+    """Load a set of settings."""
+    return cls()
+
+
+class JsonConfigSectionSettingsSource(JsonConfigSettingsSource):
+    @override
+    def __init__(
+        self,
+        settings_cls: type[BaseSettings],
+        json_file: PathType | None = DEFAULT_PATH,
+        json_file_encoding: str | None = None,
+        *,
+        section: MaybeSequenceStr,
+    ) -> None:
+        super().__init__(
+            settings_cls, json_file=json_file, json_file_encoding=json_file_encoding
+        )
+        self.section = section
+
+    @override
+    def __call__(self) -> dict[str, Any]:
+        return reduce(
+            lambda acc, el: acc.get(el, {}),
+            always_iterable(self.section),
+            super().__call__(),
+        )
+
+
+class TomlConfigSectionSettingsSource(TomlConfigSettingsSource):
+    @override
+    def __init__(
+        self,
+        settings_cls: type[BaseSettings],
+        toml_file: PathType | None = DEFAULT_PATH,
+        *,
+        section: MaybeSequenceStr,
+    ) -> None:
+        super().__init__(settings_cls, toml_file=toml_file)
+        self.section = section
+
+    @override
+    def __call__(self) -> dict[str, Any]:
+        return reduce(
+            lambda acc, el: acc.get(el, {}),
+            always_iterable(self.section),
+            super().__call__(),
+        )
+
+
+class YamlConfigSectionSettingsSource(YamlConfigSettingsSource):
+    @override
+    def __init__(
+        self,
+        settings_cls: type[BaseSettings],
+        yaml_file: PathType | None = DEFAULT_PATH,
+        yaml_file_encoding: str | None = None,
+        yaml_config_section: str | None = None,
+        *,
+        section: MaybeSequenceStr,
+    ) -> None:
+        super().__init__(
+            settings_cls,
+            yaml_file=yaml_file,
+            yaml_file_encoding=yaml_file_encoding,
+            yaml_config_section=yaml_config_section,
+        )
+        self.section = section
+
+    @override
+    def __call__(self) -> dict[str, Any]:
+        return reduce(
+            lambda acc, el: acc.get(el, {}),
+            always_iterable(self.section),
+            super().__call__(),
+        )
+
+
+__all__ = [
+    "CustomBaseSettings",
+    "JsonConfigSectionSettingsSource",
+    "TomlConfigSectionSettingsSource",
+    "YamlConfigSectionSettingsSource",
+    "load_settings",
+]

{dycw_utilities-0.166.16 → dycw_utilities-0.166.18}/src/utilities/pydantic_settings_sops.py

@@ -4,22 +4,21 @@ 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 collections.abc import Iterator, Sequence
 
     from pydantic_settings import BaseSettings, PydanticBaseSettingsSource
 
-    from utilities.types import MaybeIterable, PathLike
+    from utilities.types import PathLike
 
 
 class SopsBaseSettings(CustomBaseSettings):
     """Base settings for loading secrets using `sops/age`."""
 
     # paths
-    secret_files: ClassVar[MaybeIterable[PathLike]] = ()
+    secret_files: ClassVar[Sequence[PathLike]] = ()
 
     @classmethod
     @override
@@ -30,7 +29,7 @@ class SopsBaseSettings(CustomBaseSettings):
         /,
     ) -> Iterator[PydanticBaseSettingsSource]:
         yield from super()._yield_base_settings_sources(settings_cls, env_settings)
-        for file in always_iterable(cls.secret_files):
+        for file in cls.secret_files:
             yield SOPSConfigSettingsSource(
                 settings_cls,  # pyright: ignore[reportArgumentType],
                 json_file=file,

dycw_utilities-0.166.16/src/tests/test_pydantic_settings.py

@@ -1,99 +0,0 @@
-from __future__ import annotations
-
-import json
-from typing import TYPE_CHECKING, ClassVar
-
-import tomlkit
-import yaml
-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_json(self, *, tmp_path: Path) -> None:
-        file = tmp_path.joinpath("settings.json")
-        _ = file.write_text(json.dumps({"x": 1}))
-
-        class Settings(CustomBaseSettings):
-            json_files: ClassVar[MaybeIterable[PathLike]] = file
-            x: int
-
-        settings = load_settings(Settings)
-        assert settings.x == 1
-
-    def test_toml(self, *, tmp_path: Path) -> None:
-        file = tmp_path.joinpath("settings.toml")
-        _ = file.write_text(tomlkit.dumps({"x": 1}))
-
-        class Settings(CustomBaseSettings):
-            toml_files: ClassVar[MaybeIterable[PathLike]] = file
-            x: int
-
-        settings = load_settings(Settings)
-        assert settings.x == 1
-
-    def test_yaml(self, *, tmp_path: Path) -> None:
-        file = tmp_path.joinpath("settings.yaml")
-        _ = file.write_text(yaml.dump({"x": 1}))
-
-        class Settings(CustomBaseSettings):
-            yaml_files: ClassVar[MaybeIterable[PathLike]] = file
-            x: int
-
-        settings = load_settings(Settings)
-        assert settings.x == 1
-
-    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.16/src/utilities/pydantic_settings.py

@@ -1,69 +0,0 @@
-from __future__ import annotations
-
-from typing import TYPE_CHECKING, ClassVar, override
-
-from pydantic_settings import (
-    BaseSettings,
-    JsonConfigSettingsSource,
-    PydanticBaseSettingsSource,
-    SettingsConfigDict,
-    TomlConfigSettingsSource,
-    YamlConfigSettingsSource,
-)
-
-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]] = ()
-    toml_files: ClassVar[MaybeIterable[PathLike]] = ()
-    yaml_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)
-        for file in always_iterable(cls.toml_files):
-            yield TomlConfigSettingsSource(settings_cls, toml_file=file)
-        for file in always_iterable(cls.yaml_files):
-            yield YamlConfigSettingsSource(settings_cls, yaml_file=file)
-
-
-def load_settings[T: BaseSettings](cls: type[T], /) -> T:
-    """Load a set of settings."""
-    return cls()
-
-
-__all__ = ["CustomBaseSettings", "load_settings"]