configaroo 0.1.2__tar.gz → 0.2.0__tar.gz

{configaroo-0.1.2 → configaroo-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: configaroo
-Version: 0.1.2
+Version: 0.2.0
 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.2 → configaroo-0.2.0}/pyproject.toml

@@ -50,7 +50,7 @@ dev = [
 version = { attr = "configaroo.__version__" }
 
 [tool.bumpver]
-current_version = "v0.1.2"
+current_version = "v0.2.0"
 version_pattern = "vMAJOR.MINOR.PATCH"
 commit_message  = "bump version {old_version} -> {new_version}"
 tag_message     = "{new_version}"

{configaroo-0.1.2 → configaroo-0.2.0}/src/configaroo/__init__.py

@@ -7,4 +7,4 @@ from configaroo.exceptions import (  # noqa
     UnsupportedLoaderError,
 )
 
-__version__ = "0.1.2"
+__version__ = "0.2.0"

{configaroo-0.1.2 → configaroo-0.2.0}/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"""
@@ -129,15 +129,14 @@ class Configuration(UserDict):
             }
         )
 
-    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.2 → configaroo-0.2.0}/src/configaroo.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: configaroo
-Version: 0.1.2
+Version: 0.2.0
 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.2 → configaroo-0.2.0}/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,37 @@ 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)