configaroo 0.2.0__tar.gz → 0.2.2__tar.gz

{configaroo-0.2.0 → configaroo-0.2.2}/LICENSE

@@ -17,4 +17,4 @@ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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

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

{configaroo-0.2.0 → configaroo-0.2.2}/README.md

@@ -7,4 +7,4 @@ Configaroo is a light configuration package for Python that offers the following
 - Override key configuration settings with environment variables
 - Validate a configuration based on a Pydantic model
 - Convert the type of configuration values based on a Pydantic model
-- Dynamically format certain configuration values
+- Dynamically format certain configuration values

{configaroo-0.2.0 → configaroo-0.2.2}/pyproject.toml

@@ -40,6 +40,7 @@ build = ["build>=1.2.2.post1", "twine>=6.1.0"]
 dev = [
     "bumpver>=2024.1130",
     "ipython>=8.36.0",
+    "pre-commit>=4.2.0",
     "pytest>=8.3.5",
     "ruff>=0.11.11",
     "tomli-w>=1.2.0",
@@ -50,13 +51,13 @@ dev = [
 version = { attr = "configaroo.__version__" }
 
 [tool.bumpver]
-current_version = "v0.2.0"
+current_version = "v0.2.2"
 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.2/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.2"

{configaroo-0.2.0 → configaroo-0.2.2}/src/configaroo/configuration.py

@@ -18,6 +18,19 @@ ModelT = TypeVar("ModelT", bound=BaseModel)
 class Configuration(UserDict):
     """A Configuration is a dict-like structure with some conveniences"""
 
+    @classmethod
+    def from_dict(cls, data: dict[str, Any] | UserDict[str, Any] | Self) -> Self:
+        """Construct a Configuration from a dictionary
+
+        The dictionary is referenced directly, a copy isn't made
+        """
+        configuration = cls()
+        if isinstance(data, UserDict | Configuration):
+            configuration.data = data.data
+        else:
+            configuration.data = data
+        return configuration
+
     @classmethod
     def from_file(
         cls,
@@ -54,7 +67,7 @@ class Configuration(UserDict):
         """Make sure nested sections have type Configuration"""
         value = self.data[key]
         if isinstance(value, dict | UserDict | Configuration):
-            return Configuration(value)
+            return Configuration.from_dict(value)
         else:
             return value
 
@@ -67,11 +80,11 @@ class Configuration(UserDict):
                 f"'{type(self).__name__}' has no attribute or key '{key}'"
             )
 
-    def __contains__(self, key: str) -> bool:
+    def __contains__(self, key: object) -> bool:
         """Add support for dotted keys"""
         if key in self.data:
             return True
-        prefix, _, rest = key.partition(".")
+        prefix, _, rest = str(key).partition(".")
         try:
             return rest in self[prefix]
         except KeyError:
@@ -108,18 +121,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,6 +143,10 @@ 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_model(self, model: Type[BaseModel]) -> Self:
         """Validate the configuration against the given model."""

{configaroo-0.2.0 → configaroo-0.2.2}/src/configaroo.egg-info/PKG-INFO

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

{configaroo-0.2.0 → configaroo-0.2.2}/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.2.0 → configaroo-0.2.2}/tests/test_configuration.py

@@ -4,6 +4,7 @@ from pathlib import Path
 
 import pytest
 
+import configaroo
 from configaroo import Configuration, configuration
 
 
@@ -71,6 +72,24 @@ def test_update_preserves_type(config):
     assert isinstance(config, Configuration)
 
 
+def test_update_changes_values(config):
+    """Test that an update adds or changes values"""
+    updated_config = config | {"number": 14, "new": "brand new!"}
+    assert updated_config.number == 14
+    assert updated_config.new == "brand new!"
+
+    config.update({"number": 14, "new": "brand new!"})
+    assert config.number == 14
+    assert config.new == "brand new!"
+
+
+def test_update_nested_values(config):
+    """Test that a nested section can be updated"""
+    config.nested.deep.update({"sea": "Mjoesa", "depth": 456})
+    assert config.nested.deep.sea == "Mjoesa"
+    assert config.nested.deep.depth == 456
+
+
 def test_dump_to_dict(config):
     """Test that dumping to a dictionary unwraps nested sections"""
     config_dict = config.to_dict()
@@ -101,54 +120,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 +137,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.2/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.2.0 → configaroo-0.2.2}/tests/test_validation.py

@@ -53,3 +53,9 @@ 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.2.0/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.2.0"