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

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

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

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

@@ -246,7 +246,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.166.17"
+version = "0.166.18"
 
 [project.entry-points.pytest11]
 pytest-randomly = "utilities.pytest_plugins.pytest_randomly"
@@ -279,7 +279,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.166.17"
+current_version = "0.166.18"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.166.17 → dycw_utilities-0.166.18}/src/tests/test_pydantic_settings.py

@@ -18,8 +18,6 @@ if TYPE_CHECKING:
     from collections.abc import Sequence
     from pathlib import Path
 
-    from utilities.types import PathLike
-
 
 class TestCustomBaseSettings:
     def test_json(self, *, tmp_path: Path) -> None:
@@ -27,7 +25,31 @@ class TestCustomBaseSettings:
         _ = file.write_text(json.dumps({"x": 1}))
 
         class Settings(CustomBaseSettings):
-            json_files: ClassVar[Sequence[PathLike]] = [file]
+            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)
@@ -73,7 +95,31 @@ class TestCustomBaseSettings:
         _ = file.write_text(yaml.dump({"x": 1}))
 
         class Settings(CustomBaseSettings):
-            yaml_files: ClassVar[Sequence[PathLike]] = [file]
+            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)

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

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.166.17"
+__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.17/src/utilities/pydantic_settings.py

@@ -1,106 +0,0 @@
-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[PathLike]] = []
-    toml_files: ClassVar[Sequence[PathLikeOrWithSection]] = []
-    yaml_files: ClassVar[Sequence[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 cls.json_files:
-            yield JsonConfigSettingsSource(settings_cls, json_file=file)
-        for path_or_pair in cls.toml_files:
-            match path_or_pair:
-                case Path() | str() as file:
-                    yield TomlConfigSettingsSource(settings_cls, toml_file=file)
-                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 file in 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()
-
-
-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__(),
-        )
-
-
-__all__ = ["CustomBaseSettings", "TomlConfigSectionSettingsSource", "load_settings"]