configaroo 0.1.3__tar.gz → 0.2.1__tar.gz

{configaroo-0.1.3 → configaroo-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: configaroo
-Version: 0.1.3
+Version: 0.2.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.1.3 → configaroo-0.2.1}/pyproject.toml

@@ -50,13 +50,13 @@ dev = [
 version = { attr = "configaroo.__version__" }
 
 [tool.bumpver]
-current_version = "v0.1.3"
+current_version = "v0.2.1"
 version_pattern = "vMAJOR.MINOR.PATCH"
 commit_message  = "bump version {old_version} -> {new_version}"
 tag_message     = "{new_version}"
 commit          = true
 tag             = true
-push            = false
+push            = true
 
 [tool.bumpver.file_patterns]
 "pyproject.toml"             = ['current_version = "{version}"']

configaroo-0.2.1/src/configaroo/__init__.py

@@ -0,0 +1,17 @@
+"""Bouncy configuration handling"""
+
+from configaroo.configuration import Configuration
+from configaroo.exceptions import (
+    ConfigarooException,
+    MissingEnvironmentVariableError,
+    UnsupportedLoaderError,
+)
+
+__all__ = [
+    "Configuration",
+    "ConfigarooException",
+    "MissingEnvironmentVariableError",
+    "UnsupportedLoaderError",
+]
+
+__version__ = "0.2.1"

{configaroo-0.1.3 → configaroo-0.2.1}/src/configaroo/configuration.py

@@ -5,13 +5,15 @@ import os
 import re
 from collections import UserDict
 from pathlib import Path
-from typing import Any, Self, Type
+from typing import Any, Self, Type, TypeVar
 
 from pydantic import BaseModel
 
 from configaroo import loaders
 from configaroo.exceptions import MissingEnvironmentVariableError
 
+ModelT = TypeVar("ModelT", bound=BaseModel)
+
 
 class Configuration(UserDict):
     """A Configuration is a dict-like structure with some conveniences"""
@@ -24,12 +26,11 @@ class Configuration(UserDict):
         envs: dict[str, str] | None = None,
         env_prefix: str = "",
         extra_dynamic: dict[str, Any] | None = None,
-        model: Type[BaseModel] | None = None,
     ) -> 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, model=model
+            envs=envs, env_prefix=env_prefix, extra_dynamic=extra_dynamic
         )
 
     def initialize(
@@ -37,18 +38,17 @@ class Configuration(UserDict):
         envs: dict[str, str] | None = None,
         env_prefix: str = "",
         extra_dynamic: dict[str, Any] | None = None,
-        model: Type[BaseModel] | None = None,
     ) -> Self:
         """Initialize a configuration.
 
-        The initialization adds environment variables, parses dynamic values,
-        validates against a Pydantic model, and converts value types using the
-        same model.
+        The initialization adds environment variables and parses dynamic values.
         """
         self = self if envs is None else self.add_envs(envs, prefix=env_prefix)
-        self = self.parse_dynamic(extra_dynamic)
-        self = self if model is None else self.validate(model).convert(model)
-        return self
+        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)
 
     def __getitem__(self, key: str) -> Any:
         """Make sure nested sections have type Configuration"""
@@ -108,18 +108,20 @@ class Configuration(UserDict):
                 )
         return self
 
-    def parse_dynamic(self, extra: dict[str, Any] | None = None) -> Self:
+    def parse_dynamic(
+        self, extra: dict[str, Any] | None = None, _include_self: bool = True
+    ) -> Self:
         """Parse dynamic values of the form {section.key}"""
         cls = type(self)
         variables = (
-            self.to_flat_dict()
+            (self.to_flat_dict() if _include_self else {})
             | {"project_path": _find_pyproject_toml()}
             | ({} if extra is None else extra)
         )
-        return cls(
+        parsed = cls(
             {
                 key: (
-                    value.parse_dynamic(extra=variables)
+                    value.parse_dynamic(extra=variables, _include_self=False)
                     if isinstance(value, Configuration)
                     else _incomplete_format(value, variables)
                     if isinstance(value, str)
@@ -128,16 +130,19 @@ class Configuration(UserDict):
                 for key, value in self.items()
             }
         )
+        if parsed == self:
+            return parsed
+        # Continue parsing until no more replacements are made.
+        return parsed.parse_dynamic(extra=extra, _include_self=_include_self)
 
-    def validate(self, model: Type[BaseModel]) -> Self:
+    def validate_model(self, model: Type[BaseModel]) -> Self:
         """Validate the configuration against the given model."""
         model.model_validate(self.data)
         return self
 
-    def convert(self, model: Type[BaseModel]) -> Self:
+    def convert_model(self, model: Type[ModelT]) -> ModelT:
         """Convert data types to match the given model"""
-        cls = type(self)
-        return cls(model(**self.data).model_dump())
+        return model(**self.data)
 
     def to_dict(self) -> dict[str, Any]:
         """Dump the configuration into a Python dictionary"""

{configaroo-0.1.3 → configaroo-0.2.1}/src/configaroo.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: configaroo
-Version: 0.1.3
+Version: 0.2.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.1.3 → configaroo-0.2.1}/src/configaroo.egg-info/SOURCES.txt

@@ -14,6 +14,7 @@ src/configaroo/loaders/__init__.py
 src/configaroo/loaders/json.py
 src/configaroo/loaders/toml.py
 tests/test_configuration.py
+tests/test_dynamic.py
 tests/test_environment.py
 tests/test_json.py
 tests/test_loaders.py

{configaroo-0.1.3 → configaroo-0.2.1}/tests/test_configuration.py

@@ -4,6 +4,7 @@ from pathlib import Path
 
 import pytest
 
+import configaroo
 from configaroo import Configuration, configuration
 
 
@@ -101,54 +102,6 @@ def test_contains_with_dotted_key(config):
     assert "nested.number" not in config
 
 
-def test_parse_dynamic_default(config, file_path):
-    """Test parsing of default dynamic variables"""
-    parsed_config = (config | {"diameter": "2 x {nested.pie}"}).parse_dynamic()
-    print("pyproject.toml dir: ", configuration._find_pyproject_toml(file_path))
-    print(f"{parsed_config.paths.dynamic = }")
-    assert parsed_config.paths.dynamic == str(file_path)
-    assert parsed_config.phrase == "The meaning of life is 42"
-    assert parsed_config.diameter == "2 x 3.14"
-
-
-def test_parse_dynamic_extra(config, file_path):
-    """Test parsing of extra dynamic variables"""
-    parsed_config = (config | {"animal": "{adjective} kangaroo"}).parse_dynamic(
-        extra={"number": 14, "adjective": "bouncy"}
-    )
-    assert parsed_config.paths.dynamic == str(file_path)
-    assert parsed_config.phrase == "The meaning of life is 14"
-    assert parsed_config.animal == "bouncy kangaroo"
-
-
-def test_parse_dynamic_formatted(config):
-    """Test that formatting works for dynamic variables"""
-    parsed_config = (
-        config
-        | {
-            "string": "Hey {word!r}",
-            "three": "->{nested.pie:6.0f}<-",
-            "centered": "|{word:^12}|",
-        }
-    ).parse_dynamic()
-    assert parsed_config.centered == "|  platypus  |"
-    assert parsed_config.three == "->     3<-"
-    assert parsed_config.string == "Hey 'platypus'"
-
-
-def test_parse_dynamic_ignore(config):
-    """Test that parsing of dynamic variables ignores unknown replacements"""
-    parsed_config = (
-        config
-        | {
-            "animal": "{adjective} kangaroo",
-            "phrase": "one {nested.non_existent} dollar",
-        }
-    ).parse_dynamic()
-    assert parsed_config.animal == "{adjective} kangaroo"
-    assert parsed_config.phrase == "one {nested.non_existent} dollar"
-
-
 def test_find_pyproject_toml():
     """Test that the pyproject.toml file can be located"""
     assert configuration._find_pyproject_toml() == Path(__file__).parent.parent
@@ -166,3 +119,9 @@ def test_incomplete_formatter():
         {"number": 3.14, "string": "platypus", "name": "Geir Arne"},
     )
     assert formatted == "  3.1 {non_existent} 'platypus' Geir Arne"
+
+
+def test_public_classes_are_exposed():
+    """Test that the __all__ attribute exposes all public classes"""
+    public_classes = [attr for attr in dir(configaroo) if "A" <= attr[:1] <= "Z"]
+    assert sorted(public_classes) == sorted(configaroo.__all__)

configaroo-0.2.1/tests/test_dynamic.py

@@ -0,0 +1,69 @@
+"""Test handling of dynamic variables"""
+
+from pathlib import Path
+
+import pytest
+
+
+@pytest.fixture
+def file_path():
+    """The path to the current file"""
+    return Path(__file__).resolve()
+
+
+def test_parse_dynamic_default(config, file_path):
+    """Test parsing of default dynamic variables"""
+    parsed_config = (config | {"diameter": "2 x {nested.pie}"}).parse_dynamic()
+    assert parsed_config.paths.dynamic == str(file_path)
+    assert parsed_config.phrase == "The meaning of life is 42"
+    assert parsed_config.diameter == "2 x 3.14"
+
+
+def test_parse_dynamic_extra(config, file_path):
+    """Test parsing of extra dynamic variables"""
+    parsed_config = (config | {"animal": "{adjective} kangaroo"}).parse_dynamic(
+        extra={"number": 14, "adjective": "bouncy"}
+    )
+    assert parsed_config.paths.dynamic == str(file_path)
+    assert parsed_config.phrase == "The meaning of life is 14"
+    assert parsed_config.animal == "bouncy kangaroo"
+
+
+def test_parse_dynamic_formatted(config):
+    """Test that formatting works for dynamic variables"""
+    parsed_config = (
+        config
+        | {
+            "string": "Hey {word!r}",
+            "three": "->{nested.pie:6.0f}<-",
+            "centered": "|{word:^12}|",
+        }
+    ).parse_dynamic()
+    assert parsed_config.centered == "|  platypus  |"
+    assert parsed_config.three == "->     3<-"
+    assert parsed_config.string == "Hey 'platypus'"
+
+
+def test_parse_dynamic_ignore(config):
+    """Test that parsing of dynamic variables ignores unknown replacements"""
+    parsed_config = (
+        config
+        | {
+            "animal": "{adjective} kangaroo",
+            "phrase": "one {nested.non_existent} dollar",
+        }
+    ).parse_dynamic()
+    assert parsed_config.animal == "{adjective} kangaroo"
+    assert parsed_config.phrase == "one {nested.non_existent} dollar"
+
+
+def test_parse_dynamic_nested(config, file_path):
+    """Test that parsing dynamic variables referring to other dynamic variables work"""
+    parsed_config = config.parse_dynamic()
+    assert parsed_config.paths.nested == str(file_path)
+
+
+def test_parse_dynamic_only_full_name(config):
+    """Test that parsing dynamic variables only use full dotted name"""
+    parsed_config = config.parse_dynamic()
+    assert parsed_config.log.format == config.log.format

{configaroo-0.1.3 → configaroo-0.2.1}/tests/test_validation.py

@@ -10,7 +10,7 @@ from configaroo import Configuration
 
 def test_can_validate(config, model):
     """Test that a configuration can be validated"""
-    assert config.validate(model)
+    assert config.validate_model(model)
 
 
 def test_wrong_key_raises(model):
@@ -19,24 +19,43 @@ def test_wrong_key_raises(model):
         digit=4, nested={"pie": 3.14, "seven": 7}, path="files/config.toml"
     )
     with pytest.raises(pydantic.ValidationError):
-        config.validate(model)
+        config.validate_model(model)
 
 
 def test_missing_key_raises(model):
     """Test that a missing key raises an error"""
     config = Configuration(nested={"pie": 3.14, "seven": 7}, path="files/config.toml")
     with pytest.raises(pydantic.ValidationError):
-        config.validate(model)
+        config.validate_model(model)
 
 
 def test_extra_key_ok(config, model):
     """Test that an extra key raises when the model is strict"""
     updated_config = config | {"new_word": "cuckoo-bird"}
     with pytest.raises(pydantic.ValidationError):
-        updated_config.validate(model)
+        updated_config.validate_model(model)
 
 
 def test_type_conversion(config, model):
-    config_w_types = config.convert(model)
+    """Test that types can be converted based on the model"""
+    config_w_types = config.convert_model(model)
     assert isinstance(config.paths.relative, str)
     assert isinstance(config_w_types.paths.relative, Path)
+
+
+def test_converted_model_is_pydantic(config, model):
+    """Test that the converted model is a BaseModel which helps with auto-complete"""
+    config_w_types = config.convert_model(model=model)
+    assert isinstance(config_w_types, pydantic.BaseModel)
+
+
+def test_validate_and_convert(config, model):
+    config_w_model = config.with_model(model)
+    assert isinstance(config_w_model, pydantic.BaseModel)
+    assert isinstance(config_w_model.paths.relative, Path)
+
+
+def test_convert_to_path(config, model):
+    paths_cfg = config.parse_dynamic().with_model(model).paths
+    assert isinstance(paths_cfg.relative, Path) and paths_cfg.relative.exists()
+    assert isinstance(paths_cfg.directory, Path) and paths_cfg.directory.is_dir()

configaroo-0.1.3/src/configaroo/__init__.py

@@ -1,10 +0,0 @@
-"""Bouncy configuration handling"""
-
-from configaroo.configuration import Configuration  # noqa
-from configaroo.exceptions import (  # noqa
-    ConfigarooException,
-    MissingEnvironmentVariableError,
-    UnsupportedLoaderError,
-)
-
-__version__ = "0.1.3"