configaroo 0.1.0__tar.gz → 0.1.2__tar.gz

configaroo-0.1.2/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright © 2025 Geir Arne Hjelle
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+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.

configaroo-0.1.2/PKG-INFO

@@ -0,0 +1,40 @@
+Metadata-Version: 2.4
+Name: configaroo
+Version: 0.1.2
+Summary: Bouncy handling of configuration files
+Author-email: Geir Arne Hjelle <geirarne@gmail.com>
+Maintainer-email: Geir Arne Hjelle <geirarne@gmail.com>
+License-Expression: MIT
+Project-URL: homepage, https://github.com/gahjelle/configaroo
+Project-URL: github, https://github.com/gahjelle/configaroo
+Project-URL: issues, https://github.com/gahjelle/configaroo/issues
+Project-URL: changelog, https://github.com/gahjelle/configaroo/blob/main/CHANGELOG.md
+Keywords: configuration,configuration-management,toml,json
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pyplugs>=0.4.0
+Dynamic: license-file
+
+# Configaroo - Bouncy Configuration Handling
+
+Configaroo is a light configuration package for Python that offers the following features:
+
+- Access configuration settings with dotted keys: `config.nested.key`
+- Use different configuration file formats, including TOML and JSON
+- 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

configaroo-0.1.2/pyproject.toml

@@ -0,0 +1,63 @@
+[build-system]
+requires      = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+
+[project]
+name = "configaroo"
+description = "Bouncy handling of configuration files"
+readme = "README.md"
+authors = [{ name = "Geir Arne Hjelle", email = "geirarne@gmail.com" }]
+maintainers = [{ name = "Geir Arne Hjelle", email = "geirarne@gmail.com" }]
+requires-python = ">=3.11"
+license = "MIT"
+license-files = ["LICENSE"]
+keywords = ["configuration", "configuration-management", "toml", "json"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+dependencies = ["pydantic>=2.0", "pyplugs>=0.4.0"]
+dynamic = ["version"]
+
+[project.urls]
+homepage  = "https://github.com/gahjelle/configaroo"
+github    = "https://github.com/gahjelle/configaroo"
+issues    = "https://github.com/gahjelle/configaroo/issues"
+changelog = "https://github.com/gahjelle/configaroo/blob/main/CHANGELOG.md"
+
+[dependency-groups]
+build = ["build>=1.2.2.post1", "twine>=6.1.0"]
+dev = [
+    "bumpver>=2024.1130",
+    "ipython>=8.36.0",
+    "pytest>=8.3.5",
+    "ruff>=0.11.11",
+    "tomli-w>=1.2.0",
+]
+
+
+[tool.setuptools.dynamic]
+version = { attr = "configaroo.__version__" }
+
+[tool.bumpver]
+current_version = "v0.1.2"
+version_pattern = "vMAJOR.MINOR.PATCH"
+commit_message  = "bump version {old_version} -> {new_version}"
+tag_message     = "{new_version}"
+commit          = true
+tag             = true
+push            = false
+
+[tool.bumpver.file_patterns]
+"pyproject.toml"             = ['current_version = "{version}"']
+"src/configaroo/__init__.py" = ['__version__ = "MAJOR.MINOR.PATCH"']

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

@@ -6,3 +6,5 @@ from configaroo.exceptions import (  # noqa
     MissingEnvironmentVariableError,
     UnsupportedLoaderError,
 )
+
+__version__ = "0.1.2"

{configaroo-0.1.0 → configaroo-0.1.2}/src/configaroo/configuration.py

@@ -1,11 +1,12 @@
 """A dict-like configuration with support for envvars, validation and type conversion"""
 
+import inspect
 import os
+import re
 from collections import UserDict
 from pathlib import Path
 from typing import Any, Self, Type
 
-import dotenv
 from pydantic import BaseModel
 
 from configaroo import loaders
@@ -27,7 +28,9 @@ class Configuration(UserDict):
     ) -> Self:
         """Read a Configuration from a file"""
         config_dict = loaders.from_file(file_path, loader=loader)
-        return cls(**config_dict).initialize(envs=envs, model=model)
+        return cls(config_dict).initialize(
+            envs=envs, env_prefix=env_prefix, extra_dynamic=extra_dynamic, model=model
+        )
 
     def initialize(
         self,
@@ -51,7 +54,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(value)
         else:
             return value
 
@@ -76,39 +79,33 @@ class Configuration(UserDict):
 
     def get(self, key: str, default: Any = None) -> Any:
         """Allow dotted keys when using .get()"""
-        if key not in self.data:
-            prefix, _, rest = key.partition(".")
-            try:
-                return self[prefix].get(rest, default=default)
-            except KeyError:
-                return default
-        else:
+        if key in self.data:
             return self[key]
 
+        prefix, _, rest = key.partition(".")
+        try:
+            return self[prefix].get(rest, default=default)
+        except KeyError:
+            return default
+
     def add(self, key: str, value: Any) -> Self:
         """Add a value, allow dotted keys"""
         prefix, _, rest = key.partition(".")
-        if rest:
-            cls = type(self)
-            return self | {prefix: cls(**self.setdefault(prefix, {})).add(rest, value)}
-        else:
+        if not rest:
             return self | {key: value}
+        cls = type(self)
+        return self | {prefix: cls(self.setdefault(prefix, {})).add(rest, value)}
 
-    def add_envs(self, envs: dict[str, str], prefix: str = "", use_dotenv=True) -> Self:
+    def add_envs(self, envs: dict[str, str], prefix: str = "") -> Self:
         """Add environment variables to configuration"""
-        if use_dotenv:
-            dotenv.load_dotenv()
-
         for env, key in envs.items():
             env_key = f"{prefix}{env}"
-            env_value = os.getenv(env_key)
-            if env_value:
+            if env_value := os.getenv(env_key):
                 self = self.add(key, env_value)
-            else:
-                if key not in self:
-                    raise MissingEnvironmentVariableError(
-                        f"required environment variable '{env_key}' not found"
-                    )
+            elif key not in self:
+                raise MissingEnvironmentVariableError(
+                    f"required environment variable '{env_key}' not found"
+                )
         return self
 
     def parse_dynamic(self, extra: dict[str, Any] | None = None) -> Self:
@@ -116,15 +113,15 @@ class Configuration(UserDict):
         cls = type(self)
         variables = (
             self.to_flat_dict()
-            | {"project_path": Path(__file__).parent.parent.parent}
+            | {"project_path": _find_pyproject_toml()}
             | ({} if extra is None else extra)
         )
         return cls(
-            **{
+            {
                 key: (
                     value.parse_dynamic(extra=variables)
                     if isinstance(value, Configuration)
-                    else value.format(**variables)
+                    else _incomplete_format(value, variables)
                     if isinstance(value, str)
                     else value
                 )
@@ -140,7 +137,7 @@ class Configuration(UserDict):
     def convert(self, model: Type[BaseModel]) -> Self:
         """Convert data types to match the given model"""
         cls = type(self)
-        return cls(**model(**self.data).model_dump())
+        return cls(model(**self.data).model_dump())
 
     def to_dict(self) -> dict[str, Any]:
         """Dump the configuration into a Python dictionary"""
@@ -166,3 +163,53 @@ class Configuration(UserDict):
                 self[nested_key].to_flat_dict(_prefix=f"{_prefix}{nested_key}.").items()
             )
         }
+
+
+def _find_pyproject_toml(
+    path: Path | None = None, _file_name: str = "pyproject.toml"
+) -> Path:
+    """Find a directory that contains a pyproject.toml file.
+
+    This searches the given directory and all direct parents. If a
+    pyproject.toml file isn't found, then the root of the file system is
+    returned.
+    """
+    path = _get_foreign_path() if path is None else path
+    if (path / _file_name).exists() or path == path.parent:
+        return path.resolve()
+    else:
+        return _find_pyproject_toml(path.parent, _file_name=_file_name)
+
+
+def _get_foreign_path() -> Path:
+    """Find the path to the library that called this package.
+
+    Search the call stack for the first source code file outside of configaroo.
+    """
+    self_prefix = Path(__file__).parent.parent
+    return next(
+        path
+        for frame in inspect.stack()
+        if not (path := Path(frame.filename)).is_relative_to(self_prefix)
+    )
+
+
+def _incomplete_format(text: str, replacers: dict[str, Any]) -> str:
+    """Replace some, but not necessarily all format specifiers in a text string.
+
+    Regular .format() raises an error if not all {replace} parameters are
+    supplied. Here, we only replace the given replace arguments and leave the
+    rest untouched.
+    """
+    dot = "__DOT__"  # Escape . in fields as they have special meaning in .format()
+    pattern = r"({{{word}(?:![ars])?(?:|:[^}}]*)}})"  # Match {word} or {word:...}
+
+    for word, replacement in replacers.items():
+        for match in re.findall(pattern.format(word=word), text):
+            # Split expression to only replace . in the field name
+            field, colon, fmt = match.partition(":")
+            replacer = f"{field.replace('.', dot)}{colon}{fmt}".format(
+                **{word.replace(".", dot): replacement}
+            )
+            text = text.replace(match, replacer)
+    return text

configaroo-0.1.2/src/configaroo.egg-info/PKG-INFO

@@ -0,0 +1,40 @@
+Metadata-Version: 2.4
+Name: configaroo
+Version: 0.1.2
+Summary: Bouncy handling of configuration files
+Author-email: Geir Arne Hjelle <geirarne@gmail.com>
+Maintainer-email: Geir Arne Hjelle <geirarne@gmail.com>
+License-Expression: MIT
+Project-URL: homepage, https://github.com/gahjelle/configaroo
+Project-URL: github, https://github.com/gahjelle/configaroo
+Project-URL: issues, https://github.com/gahjelle/configaroo/issues
+Project-URL: changelog, https://github.com/gahjelle/configaroo/blob/main/CHANGELOG.md
+Keywords: configuration,configuration-management,toml,json
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pyplugs>=0.4.0
+Dynamic: license-file
+
+# Configaroo - Bouncy Configuration Handling
+
+Configaroo is a light configuration package for Python that offers the following features:
+
+- Access configuration settings with dotted keys: `config.nested.key`
+- Use different configuration file formats, including TOML and JSON
+- 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

{configaroo-0.1.0 → configaroo-0.1.2}/src/configaroo.egg-info/SOURCES.txt

@@ -1,3 +1,4 @@
+LICENSE
 README.md
 pyproject.toml
 src/configaroo/__init__.py

{configaroo-0.1.0 → configaroo-0.1.2}/src/configaroo.egg-info/requires.txt

@@ -1,3 +1,2 @@
 pydantic>=2.0
 pyplugs>=0.4.0
-python-dotenv>=1.1.0

{configaroo-0.1.0 → configaroo-0.1.2}/tests/test_configuration.py

@@ -1,8 +1,16 @@
 """Test base Configuration functionality"""
 
+from pathlib import Path
+
 import pytest
 
-from configaroo import Configuration
+from configaroo import Configuration, configuration
+
+
+@pytest.fixture
+def file_path():
+    """The path to the current file"""
+    return Path(__file__).resolve()
 
 
 def test_read_simple_values_as_attributes(config):
@@ -93,18 +101,68 @@ def test_contains_with_dotted_key(config):
     assert "nested.number" not in config
 
 
-def test_parse_dynamic_default(config):
+def test_parse_dynamic_default(config, file_path):
     """Test parsing of default dynamic variables"""
-    parsed_config = config.parse_dynamic()
-    assert parsed_config.paths.dynamic == __file__
+    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):
+def test_parse_dynamic_extra(config, file_path):
     """Test parsing of extra dynamic variables"""
-    parsed_config = (config | {"animal": "{adjective} platypus"}).parse_dynamic(
-        extra={"number": 14, "adjective": "tall"}
+    parsed_config = (config | {"animal": "{adjective} kangaroo"}).parse_dynamic(
+        extra={"number": 14, "adjective": "bouncy"}
     )
-    assert parsed_config.paths.dynamic == __file__
+    assert parsed_config.paths.dynamic == str(file_path)
     assert parsed_config.phrase == "The meaning of life is 14"
-    assert parsed_config.animal == "tall platypus"
+    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
+
+
+def test_find_foreign_caller():
+    """Test that a foreign caller (outside of configaroo) can be identified"""
+    assert configuration._get_foreign_path() == Path(__file__)
+
+
+def test_incomplete_formatter():
+    """Test that the incomplete formatter can handle fields that aren't replaced"""
+    formatted = configuration._incomplete_format(
+        "{number:5.1f} {non_existent} {string!r} {name}",
+        {"number": 3.14, "string": "platypus", "name": "Geir Arne"},
+    )
+    assert formatted == "  3.1 {non_existent} 'platypus' Geir Arne"

configaroo-0.1.0/PKG-INFO

@@ -1,21 +0,0 @@
-Metadata-Version: 2.4
-Name: configaroo
-Version: 0.1.0
-Summary: Bouncy handling of configuration files
-Author-email: Geir Arne Hjelle <geirarne@gmail.com>
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-Requires-Dist: pydantic>=2.0
-Requires-Dist: pyplugs>=0.4.0
-Requires-Dist: python-dotenv>=1.1.0
-
-# Configaroo - Bouncy Configuration Handling
-
-Configaroo is a light configuration package for Python that offers the following features:
-
-- Access configuration settings with dotted keys: `config.nested.key`
-- Use different configuration file formats, including TOML and JSON
-- 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

configaroo-0.1.0/pyproject.toml

@@ -1,15 +0,0 @@
-[project]
-name            = "configaroo"
-version         = "0.1.0"
-description     = "Bouncy handling of configuration files"
-readme          = "README.md"
-authors         = [{ name = "Geir Arne Hjelle", email = "geirarne@gmail.com" }]
-requires-python = ">=3.11"
-dependencies    = ["pydantic>=2.0", "pyplugs>=0.4.0", "python-dotenv>=1.1.0"]
-
-[build-system]
-requires      = ["setuptools>=61"]
-build-backend = "setuptools.build_meta"
-
-[dependency-groups]
-dev = ["ipython>=8.36.0", "pytest>=8.3.5", "ruff>=0.11.11", "tomli-w>=1.2.0"]

configaroo-0.1.0/src/configaroo.egg-info/PKG-INFO

@@ -1,21 +0,0 @@
-Metadata-Version: 2.4
-Name: configaroo
-Version: 0.1.0
-Summary: Bouncy handling of configuration files
-Author-email: Geir Arne Hjelle <geirarne@gmail.com>
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-Requires-Dist: pydantic>=2.0
-Requires-Dist: pyplugs>=0.4.0
-Requires-Dist: python-dotenv>=1.1.0
-
-# Configaroo - Bouncy Configuration Handling
-
-Configaroo is a light configuration package for Python that offers the following features:
-
-- Access configuration settings with dotted keys: `config.nested.key`
-- Use different configuration file formats, including TOML and JSON
-- 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