configaroo 0.3.0__tar.gz → 0.4.1__tar.gz

{configaroo-0.3.0/src/configaroo.egg-info → configaroo-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: configaroo
-Version: 0.3.0
+Version: 0.4.1
 Summary: Bouncy handling of configuration files
 Author-email: Geir Arne Hjelle <geirarne@gmail.com>
 Maintainer-email: Geir Arne Hjelle <geirarne@gmail.com>

{configaroo-0.3.0 → configaroo-0.4.1}/pyproject.toml

@@ -79,7 +79,7 @@ python_version = "3.11"
 strict = true
 
 [tool.bumpver]
-current_version = "v0.3.0"
+current_version = "v0.4.1"
 version_pattern = "vMAJOR.MINOR.PATCH"
 commit_message = "bump version {old_version} -> {new_version}"
 tag_message = "{new_version}"

{configaroo-0.3.0 → configaroo-0.4.1}/src/configaroo/__init__.py

@@ -15,4 +15,4 @@ __all__ = [
     "print_configuration",
 ]
 
-__version__ = "0.3.0"
+__version__ = "0.4.1"

{configaroo-0.3.0 → configaroo-0.4.1}/src/configaroo/configuration.py

@@ -6,6 +6,7 @@ import re
 from collections import UserDict
 from collections.abc import Callable
 from pathlib import Path
+from types import UnionType
 from typing import Any, Self, TypeVar
 
 from pydantic import BaseModel
@@ -36,33 +37,20 @@ class Configuration(UserDict[str, Any]):
     def from_file(
         cls,
         file_path: str | Path,
+        *,
         loader: str | None = None,
-        envs: dict[str, str] | None = None,
-        env_prefix: str = "",
-        extra_dynamic: dict[str, Any] | None = None,
+        not_exist_ok: bool = False,
     ) -> Self:
-        """Read a Configuration from a file."""
-        config_dict = loaders.from_file(file_path, loader=loader)
-        return cls(config_dict).initialize(
-            envs=envs, env_prefix=env_prefix, extra_dynamic=extra_dynamic
-        )
+        """Read a Configuration from a file.
 
-    def initialize(
-        self,
-        envs: dict[str, str] | None = None,
-        env_prefix: str = "",
-        extra_dynamic: dict[str, Any] | None = None,
-    ) -> Self:
-        """Initialize a configuration.
-
-        The initialization adds environment variables and parses dynamic values.
+        If not_exist_ok is True, then a missing file returns an empty
+        configuration. This may be useful if the configuration is potentially
+        populated by environment variables.
         """
-        self = self if envs is None else self.add_envs(envs, prefix=env_prefix)  # noqa: PLW0642
-        return self.parse_dynamic(extra_dynamic)
-
-    def with_model(self, model: type[ModelT]) -> ModelT:
-        """Apply a pydantic model to a configuration."""
-        return self.validate_model(model).convert_model(model)
+        config_dict = loaders.from_file(
+            file_path, loader=loader, not_exist_ok=not_exist_ok
+        )
+        return cls(config_dict)
 
     def __getitem__(self, key: str) -> Any:  # noqa: ANN401
         """Make sure nested sections have type Configuration."""
@@ -112,30 +100,6 @@ class Configuration(UserDict[str, Any]):
         cls = type(self)
         return self | {prefix: cls(self.setdefault(prefix, {})).add(rest, value)}
 
-    def add_envs(self, envs: dict[str, str] | None = None, prefix: str = "") -> Self:
-        """Add environment variables to configuration.
-
-        If you don't specify which environment variables to read, you'll
-        automatically add any that matches a top-level value of the
-        configuration.
-        """
-        if envs is None:
-            # Automatically add top-level configuration items
-            envs = {
-                re.sub(r"\W", "_", key).upper(): key
-                for key, value in self.data.items()
-                if isinstance(value, str | int | float)
-            }
-
-        # Read environment variables
-        for env, key in envs.items():
-            env_key = f"{prefix}{env}"
-            if env_value := os.getenv(env_key):
-                self = self.add(key, env_value)  # noqa: PLW0642
-            elif key not in self:
-                raise MissingEnvironmentVariableError(env_key)
-        return self
-
     def parse_dynamic(
         self, extra: dict[str, Any] | None = None, *, _include_self: bool = True
     ) -> Self:
@@ -163,6 +127,60 @@ class Configuration(UserDict[str, Any]):
         # Continue parsing until no more replacements are made.
         return parsed.parse_dynamic(extra=extra, _include_self=_include_self)
 
+    def add_envs(self, envs: dict[str, str] | None = None, prefix: str = "") -> Self:
+        """Add environment variables to configuration.
+
+        If you don't specify which environment variables to read, you'll
+        automatically add any that matches a simple top-level value of the
+        configuration.
+        """
+        if envs is None:
+            # Automatically add top-level configuration items
+            envs = {
+                re.sub(r"\W", "_", key).upper(): key
+                for key, value in self.data.items()
+                if isinstance(value, str | int | float)
+            }
+
+        # Read environment variables
+        for env, key in envs.items():
+            env_key = f"{prefix}{env}"
+            if env_value := os.getenv(env_key):
+                self = self.add(key, env_value)  # noqa: PLW0642
+            elif key not in self:
+                raise MissingEnvironmentVariableError(env_key)
+        return self
+
+    def add_envs_from_model(
+        self,
+        model: type[BaseModel],
+        prefix: str = "",
+        types: type | UnionType = str | bool | int | float,
+    ) -> Self:
+        """Add environment variables to configuration based on the given model.
+
+        Top level string, bool, integer, and float fields from the model are
+        looked for among environment variables.
+        """
+
+        def _get_class_from_annotation(annotation: type) -> type:
+            """Unpack generic annotations and return the underlying class."""
+            return (
+                _get_class_from_annotation(annotation.__origin__)
+                if hasattr(annotation, "__origin__")
+                else annotation
+            )
+
+        envs = {
+            re.sub(r"\W", "_", key).upper(): key
+            for key, field in model.model_fields.items()
+            if (
+                field.annotation is not None
+                and issubclass(_get_class_from_annotation(field.annotation), types)
+            )
+        }
+        return self.add_envs(envs, prefix=prefix)
+
     def validate_model(self, model: type[BaseModel]) -> Self:
         """Validate the configuration against the given model."""
         model.model_validate(self.data)
@@ -172,6 +190,10 @@ class Configuration(UserDict[str, Any]):
         """Convert data types to match the given model."""
         return model(**self.data)
 
+    def with_model(self, model: type[ModelT]) -> ModelT:
+        """Apply a pydantic model to a configuration."""
+        return self.validate_model(model).convert_model(model)
+
     def to_dict(self) -> dict[str, Any]:
         """Dump the configuration into a Python dictionary."""
         return {
@@ -217,9 +239,7 @@ def _get_rich_print() -> Callable[[str], None]:  # pragma: no cover
 
         return Console().print
     except ImportError:
-        import builtins  # noqa: PLC0415
-
-        return builtins.print
+        return print
 
 
 def _print_dict_as_tree(

{configaroo-0.3.0 → configaroo-0.4.1}/src/configaroo/loaders/__init__.py

@@ -26,9 +26,14 @@ def loader_names() -> list[str]:
     return sorted(pyplugs.names(PACKAGE))
 
 
-def from_file(path: str | Path, loader: str | None = None) -> dict[str, Any]:
+def from_file(
+    path: str | Path, *, loader: str | None = None, not_exist_ok: bool = False
+) -> dict[str, Any]:
     """Load a file using a loader defined by the suffix if necessary."""
     path = Path(path)
+    if not path.exists() and not_exist_ok:
+        return {}
+
     loader = path.suffix.lstrip(".") if loader is None else loader
     try:
         return load(loader, path=path)

{configaroo-0.3.0 → configaroo-0.4.1/src/configaroo.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: configaroo
-Version: 0.3.0
+Version: 0.4.1
 Summary: Bouncy handling of configuration files
 Author-email: Geir Arne Hjelle <geirarne@gmail.com>
 Maintainer-email: Geir Arne Hjelle <geirarne@gmail.com>

{configaroo-0.3.0 → configaroo-0.4.1}/tests/test_configuration.py

@@ -8,12 +8,6 @@ import configaroo
 from configaroo import Configuration, configuration
 
 
-@pytest.fixture
-def file_path() -> Path:
-    """Return the path to the current file."""
-    return Path(__file__).resolve()
-
-
 def test_read_simple_values_as_attributes(config: Configuration) -> None:
     """Test attribute access for simple values."""
     assert config.number == 42

{configaroo-0.3.0 → configaroo-0.4.1}/tests/test_environment.py

@@ -1,6 +1,7 @@
 """Test handling of environment variables."""
 
 import pytest
+from pydantic import BaseModel, SecretStr
 
 from configaroo import Configuration, MissingEnvironmentVariableError
 
@@ -25,6 +26,7 @@ def test_several_envs(config: Configuration, monkeypatch: pytest.MonkeyPatch) ->
     """Test that we can read several environment variables."""
     monkeypatch.setenv("WORD", "platypus")
     monkeypatch.setenv("NEW_PATH", "files/config.json")
+
     config_w_env = config.add_envs({"WORD": "nested.word", "NEW_PATH": "path"})
     assert config_w_env.nested.word == "platypus"
     assert config_w_env.path == "files/config.json"
@@ -48,6 +50,7 @@ def test_env_prefix(config: Configuration, monkeypatch: pytest.MonkeyPatch) -> N
     """Test that a common prefix can be used for environment variables."""
     monkeypatch.setenv("EXAMPLE_NUMBER", "14")
     monkeypatch.setenv("EXAMPLE_WORD", "platypus")
+
     config_w_env = config.add_envs(
         {"NUMBER": "number", "WORD": "nested.word"}, prefix="EXAMPLE_"
     )
@@ -61,9 +64,65 @@ def test_env_automatic(config: Configuration, monkeypatch: pytest.MonkeyPatch) -
     monkeypatch.setenv("WORD", "kangaroo")
     monkeypatch.setenv("A_B_D_KEY_", "works")
     monkeypatch.setenv("NESTED", "should not be replaced")
-    config_w_env = (config | {"A b@d-key!": ""}).add_envs()
 
+    config_w_env = (config | {"A b@d-key!": ""}).add_envs()
     assert config_w_env.number == "28"
     assert config_w_env.word == "kangaroo"
     assert config_w_env["A b@d-key!"] == "works"
     assert config_w_env.nested != "should not be replaced"
+
+
+def test_env_from_model(monkeypatch: pytest.MonkeyPatch) -> None:
+    """Test that environment variables can be found and set based on a model."""
+
+    class TestModel(BaseModel):
+        first_name: str
+        age: int
+        check: bool
+        scores: dict[str, int]
+
+    monkeypatch.setenv("TEST_FIRST_NAME", "Michael J.")
+    monkeypatch.setenv("TEST_AGE", "47")
+    monkeypatch.setenv("TEST_CHECK", "true")
+    monkeypatch.setenv("TEST_SCORES", '{"England": 1, "Spain": 0}')
+    monkeypatch.setenv("TEST_UNKNOWN", "Will be ignored")
+
+    config_w_env = Configuration().add_envs_from_model(TestModel, prefix="TEST_")
+    assert config_w_env.first_name == "Michael J."
+    assert config_w_env.age == "47"
+    assert config_w_env.check == "true"
+    assert "scores" not in config_w_env.data  # Complex types are ignored
+    assert "unknown" not in config_w_env.data  # Unspecified fields are ignored
+
+
+def test_env_from_model_w_custom_types(monkeypatch: pytest.MonkeyPatch) -> None:
+    """Test that custom types can be used when discovering env variables from models."""
+
+    class TestModel(BaseModel):
+        first_name: str
+        age: int
+        hush: SecretStr
+        countries: list[str]
+
+    monkeypatch.setenv("TEST_FIRST_NAME", "Michael J.")
+    monkeypatch.setenv("TEST_AGE", "47")
+    monkeypatch.setenv("TEST_HUSH", "hush-hush")
+    monkeypatch.setenv("TEST_COUNTRIES", "England Australia Norway Spain")
+
+    config_w_env = Configuration().add_envs_from_model(
+        TestModel, prefix="TEST_", types=str | SecretStr | list
+    )
+    assert config_w_env.first_name == "Michael J."
+    assert config_w_env.hush == "hush-hush"
+    assert config_w_env.countries.split() == ["England", "Australia", "Norway", "Spain"]
+    assert "age" not in config_w_env  # int is not specified as a type to include
+
+
+def test_env_from_model_raises_if_missing() -> None:
+    """Test that missing environment variables defined in a model raises an error."""
+
+    class TestModel(BaseModel):
+        nonexistent_env: str
+
+    with pytest.raises(MissingEnvironmentVariableError):
+        Configuration().add_envs_from_model(TestModel)

{configaroo-0.3.0 → configaroo-0.4.1}/tests/test_json.py

@@ -38,6 +38,12 @@ def test_error_on_wrong_format(toml_path: Path) -> None:
         Configuration.from_file(toml_path, loader="json")
 
 
+def test_file_may_be_allowed_to_not_exist() -> None:
+    """Test that not_exist_ok can suppress error when file doesn't exist."""
+    config = Configuration.from_file("non-existent.json", not_exist_ok=True)
+    assert config.data == {}
+
+
 def test_can_read_json_values(json_path: Path) -> None:
     """Test that values can be accessed."""
     config = Configuration.from_file(json_path)

{configaroo-0.3.0 → configaroo-0.4.1}/tests/test_toml.py

@@ -38,6 +38,12 @@ def test_error_on_wrong_format(json_path: Path) -> None:
         Configuration.from_file(json_path, loader="toml")
 
 
+def test_file_may_be_allowed_to_not_exist() -> None:
+    """Test that not_exist_ok can suppress error when file doesn't exist."""
+    config = Configuration.from_file("non-existent.toml", not_exist_ok=True)
+    assert config.data == {}
+
+
 def test_can_read_toml_values(toml_path: Path) -> None:
     """Test that values can be accessed."""
     config = Configuration.from_file(toml_path)