configaroo 0.2.2__tar.gz → 0.2.4__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: configaroo
-Version: 0.2.2
+Version: 0.2.4
 Summary: Bouncy handling of configuration files
 Author-email: Geir Arne Hjelle <geirarne@gmail.com>
 Maintainer-email: Geir Arne Hjelle <geirarne@gmail.com>
@@ -8,7 +8,7 @@ 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
+Project-URL: changelog, https://github.com/gahjelle/configaroo/releases
 Keywords: configuration,configuration-management,toml,json
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
@@ -17,7 +17,6 @@ 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
@@ -25,11 +24,19 @@ Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pydantic>=2.0
-Requires-Dist: pyplugs>=0.4.0
+Requires-Dist: pyplugs>=0.5.4
 Dynamic: license-file
 
 # Configaroo - Bouncy Configuration Handling
 
+[![Latest version](https://img.shields.io/pypi/v/configaroo.svg)](https://pypi.org/project/configaroo/)
+[![Python versions](https://img.shields.io/pypi/pyversions/configaroo.svg)](https://pypi.org/project/configaroo/)
+[![License](https://img.shields.io/pypi/l/configaroo.svg)](https://github.com/gahjelle/configaroo/blob/main/LICENSE)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Linted](https://github.com/gahjelle/configaroo/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/gahjelle/configaroo/actions/workflows/lint.yml)
+[![Tested with Pytest](https://github.com/gahjelle/configaroo/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/gahjelle/configaroo/actions/workflows/test.yml)
+[![Type checked with mypy](https://img.shields.io/badge/type%20checked-mypy-green)](http://mypy-lang.org/)
+
 Configaroo is a light configuration package for Python that offers the following features:
 
 - Access configuration settings with dotted keys: `config.nested.key`

configaroo-0.2.4/README.md

@@ -0,0 +1,18 @@
+# Configaroo - Bouncy Configuration Handling
+
+[![Latest version](https://img.shields.io/pypi/v/configaroo.svg)](https://pypi.org/project/configaroo/)
+[![Python versions](https://img.shields.io/pypi/pyversions/configaroo.svg)](https://pypi.org/project/configaroo/)
+[![License](https://img.shields.io/pypi/l/configaroo.svg)](https://github.com/gahjelle/configaroo/blob/main/LICENSE)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Linted](https://github.com/gahjelle/configaroo/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/gahjelle/configaroo/actions/workflows/lint.yml)
+[![Tested with Pytest](https://github.com/gahjelle/configaroo/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/gahjelle/configaroo/actions/workflows/test.yml)
+[![Type checked with mypy](https://img.shields.io/badge/type%20checked-mypy-green)](http://mypy-lang.org/)
+
+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.2.4/pyproject.toml

@@ -0,0 +1,93 @@
+[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",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+dependencies = ["pydantic>=2.0", "pyplugs>=0.5.4"]
+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/releases"
+
+[dependency-groups]
+build = ["build>=1.2.2.post1", "twine>=6.1.0"]
+dev = [
+    "bumpver>=2024.1130",
+    "ipython>=8.36.0",
+    "mypy>=1.17.1",
+    "pre-commit>=4.2.0",
+    "pytest>=8.3.5",
+    "rich>=14.1.0",
+    "ruff>=0.11.11",
+    "tomli-w>=1.2.0",
+]
+
+
+[tool.setuptools.dynamic]
+version = { attr = "configaroo.__version__" }
+
+
+[tool.ruff]
+target-version = "py311"
+exclude = [".git", "venv", "migrations", "node_modules"]
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+    "COM812", # Trailing comma missing (handled by formatter)
+    "D203",   # Force blank line before class docstring (incompatible with D211)
+    "D213",   # Start docstring on second line (incompatible with D212)
+]
+
+[tool.ruff.lint.per-file-ignores]
+# D101: Missing docstring in public class (Basemodel classes may break this)
+# PLR2004: Magic value used in comparison (OK for tests)
+# S101: Use of `assert` (OK for tests)
+# SLF001: Private member accessed (OK for tests)
+# UP018: Replace with string/integer/... literal (OK for typed tests)
+"examples/*/config.py" = ["D101"]
+"tests/schema.py" = ["D101"]
+"tests/test_*.py" = ["PLR2004", "S101", "SLF001", "UP018"]
+"tests/*/test_*.py" = ["S101"]
+
+[tool.mypy]
+python_version = "3.11"
+strict = true
+
+[tool.bumpver]
+current_version = "v0.2.4"
+version_pattern = "vMAJOR.MINOR.PATCH"
+commit_message = "bump version {old_version} -> {new_version}"
+tag_message = "{new_version}"
+commit = true
+tag = true
+push = true
+
+[tool.bumpver.file_patterns]
+"pyproject.toml" = ['current_version = "{version}"']
+"src/configaroo/__init__.py" = ['__version__ = "MAJOR.MINOR.PATCH"']

{configaroo-0.2.2 → configaroo-0.2.4}/src/configaroo/__init__.py

@@ -1,17 +1,18 @@
-"""Bouncy configuration handling"""
+"""Bouncy configuration handling."""
 
-from configaroo.configuration import Configuration
+from configaroo.configuration import Configuration, print_configuration
 from configaroo.exceptions import (
-    ConfigarooException,
+    ConfigarooError,
     MissingEnvironmentVariableError,
     UnsupportedLoaderError,
 )
 
 __all__ = [
+    "ConfigarooError",
     "Configuration",
-    "ConfigarooException",
     "MissingEnvironmentVariableError",
     "UnsupportedLoaderError",
+    "print_configuration",
 ]
 
-__version__ = "0.2.2"
+__version__ = "0.2.4"

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

@@ -1,11 +1,12 @@
-"""A dict-like configuration with support for envvars, validation and type conversion"""
+"""A dict-like config with support for envvars, validation and type conversion."""
 
 import inspect
 import os
 import re
 from collections import UserDict
+from collections.abc import Callable
 from pathlib import Path
-from typing import Any, Self, Type, TypeVar
+from typing import Any, Self, TypeVar
 
 from pydantic import BaseModel
 
@@ -15,12 +16,12 @@ from configaroo.exceptions import MissingEnvironmentVariableError
 ModelT = TypeVar("ModelT", bound=BaseModel)
 
 
-class Configuration(UserDict):
-    """A Configuration is a dict-like structure with some conveniences"""
+class Configuration(UserDict[str, Any]):
+    """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
+        """Construct a Configuration from a dictionary.
 
         The dictionary is referenced directly, a copy isn't made
         """
@@ -40,7 +41,7 @@ class Configuration(UserDict):
         env_prefix: str = "",
         extra_dynamic: dict[str, Any] | None = None,
     ) -> Self:
-        """Read a Configuration from a file"""
+        """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
@@ -56,32 +57,34 @@ class Configuration(UserDict):
 
         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 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:
+    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"""
+    def __getitem__(self, key: str) -> Any:  # noqa: ANN401
+        """Make sure nested sections have type Configuration."""
         value = self.data[key]
         if isinstance(value, dict | UserDict | Configuration):
             return Configuration.from_dict(value)
-        else:
-            return value
 
-    def __getattr__(self, key: str) -> Any:
-        """Create attribute access for config keys for convenience"""
+        return value
+
+    def __getattr__(self, key: str) -> Any:  # noqa: ANN401
+        """Create attribute access for config keys for convenience."""
         try:
             return self[key]
         except KeyError:
-            raise AttributeError(
-                f"'{type(self).__name__}' has no attribute or key '{key}'"
-            )
+            message = f"'{type(self).__name__}' has no attribute or key '{key}'"
+            raise AttributeError(message) from None
 
     def __contains__(self, key: object) -> bool:
-        """Add support for dotted keys"""
+        """Add support for dotted keys.
+
+        The type hint for key is object to match the UserDict class.
+        """
         if key in self.data:
             return True
         prefix, _, rest = str(key).partition(".")
@@ -90,8 +93,8 @@ class Configuration(UserDict):
         except KeyError:
             return False
 
-    def get(self, key: str, default: Any = None) -> Any:
-        """Allow dotted keys when using .get()"""
+    def get(self, key: str, default: Any = None) -> Any:  # noqa: ANN401
+        """Allow dotted keys when using .get()."""
         if key in self.data:
             return self[key]
 
@@ -101,8 +104,8 @@ class Configuration(UserDict):
         except KeyError:
             return default
 
-    def add(self, key: str, value: Any) -> Self:
-        """Add a value, allow dotted keys"""
+    def add(self, key: str, value: Any) -> Self:  # noqa: ANN401
+        """Add a value, allow dotted keys."""
         prefix, _, rest = key.partition(".")
         if not rest:
             return self | {key: value}
@@ -110,21 +113,19 @@ class Configuration(UserDict):
         return self | {prefix: cls(self.setdefault(prefix, {})).add(rest, value)}
 
     def add_envs(self, envs: dict[str, str], prefix: str = "") -> Self:
-        """Add environment variables to configuration"""
+        """Add environment variables to configuration."""
         for env, key in envs.items():
             env_key = f"{prefix}{env}"
             if env_value := os.getenv(env_key):
-                self = self.add(key, env_value)
+                self = self.add(key, env_value)  # noqa: PLW0642
             elif key not in self:
-                raise MissingEnvironmentVariableError(
-                    f"required environment variable '{env_key}' not found"
-                )
+                raise MissingEnvironmentVariableError(env_key)
         return self
 
     def parse_dynamic(
-        self, extra: dict[str, Any] | None = None, _include_self: bool = True
+        self, extra: dict[str, Any] | None = None, *, _include_self: bool = True
     ) -> Self:
-        """Parse dynamic values of the form {section.key}"""
+        """Parse dynamic values of the form {section.key}."""
         cls = type(self)
         variables = (
             (self.to_flat_dict() if _include_self else {})
@@ -148,17 +149,17 @@ class Configuration(UserDict):
         # 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:
+    def validate_model(self, model: type[BaseModel]) -> Self:
         """Validate the configuration against the given model."""
         model.model_validate(self.data)
         return self
 
-    def convert_model(self, model: Type[ModelT]) -> ModelT:
-        """Convert data types to match the given model"""
+    def convert_model(self, model: type[ModelT]) -> ModelT:
+        """Convert data types to match the given model."""
         return model(**self.data)
 
     def to_dict(self) -> dict[str, Any]:
-        """Dump the configuration into a Python dictionary"""
+        """Dump the configuration into a Python dictionary."""
         return {
             key: value.to_dict() if isinstance(value, Configuration) else value
             for key, value in self.items()
@@ -183,6 +184,50 @@ class Configuration(UserDict):
         }
 
 
+def print_configuration(config: Configuration | BaseModel, indent: int = 4) -> None:
+    """Pretty print a configuration.
+
+    If rich is installed, then a rich console is used for the printing.
+    """
+    return _print_dict_as_tree(
+        config.model_dump() if isinstance(config, BaseModel) else config,
+        indent=indent,
+        _print=_get_rich_print(),
+    )
+
+
+def _get_rich_print() -> Callable[[str], None]:
+    """Initialize a Rich console if Rich is installed, otherwise use built-in print."""
+    try:
+        from rich.console import Console  # noqa: PLC0415
+
+        return Console().print
+    except ImportError:
+        import builtins  # noqa: PLC0415
+
+        return builtins.print
+
+
+def _print_dict_as_tree(
+    data: dict[str, Any] | UserDict[str, Any] | Configuration,
+    indent: int = 4,
+    current_indent: int = 0,
+    _print: Callable[[str], None] = print,
+) -> None:
+    """Print a nested dictionary as a tree."""
+    for key, value in data.items():
+        if isinstance(value, dict | UserDict | Configuration):
+            _print(" " * current_indent + f"- {key}")
+            _print_dict_as_tree(
+                value,
+                indent=indent,
+                current_indent=current_indent + indent,
+                _print=_print,
+            )
+        else:
+            _print(" " * current_indent + f"- {key}: {value!r}")
+
+
 def _find_pyproject_toml(
     path: Path | None = None, _file_name: str = "pyproject.toml"
 ) -> Path:
@@ -195,8 +240,8 @@ def _find_pyproject_toml(
     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)
+
+    return _find_pyproject_toml(path.parent, _file_name=_file_name)
 
 
 def _get_foreign_path() -> Path:

configaroo-0.2.4/src/configaroo/exceptions.py

@@ -0,0 +1,23 @@
+"""Configaroo specific exceptions."""
+
+
+class ConfigarooError(Exception):
+    """Base exception for more specific Configaroo exceptions."""
+
+
+class MissingEnvironmentVariableError(ConfigarooError, KeyError):
+    """A required environment variable is missing."""
+
+    def __init__(self, name: str) -> None:
+        """Set a consistent error message."""
+        super().__init__(f"required environment variable '{name}' not found")
+
+
+class UnsupportedLoaderError(ConfigarooError, ValueError):
+    """An unsupported loader is called."""
+
+    def __init__(self, loader: str, available: list[str]) -> None:
+        """Set a consistent error message."""
+        super().__init__(
+            f"file type '{loader}' isn't supported. Use one of: {', '.join(available)}"
+        )

{configaroo-0.2.2 → configaroo-0.2.4}/src/configaroo/loaders/__init__.py

@@ -7,8 +7,23 @@ import pyplugs
 
 from configaroo.exceptions import UnsupportedLoaderError
 
-load = pyplugs.call_factory(__package__)
-loader_names = pyplugs.names_factory(__package__)
+PACKAGE = str(__package__)
+
+
+def load(loader: str, path: Path) -> dict[str, Any]:
+    """Load a file using the given loader."""
+    return pyplugs.call_typed(
+        PACKAGE,
+        plugin=loader,
+        func="load",
+        path=path,
+        _return_type=dict(),  # noqa: C408
+    )
+
+
+def loader_names() -> list[str]:
+    """List names of available loaders."""
+    return sorted(pyplugs.names(PACKAGE))
 
 
 def from_file(path: str | Path, loader: str | None = None) -> dict[str, Any]:
@@ -18,7 +33,4 @@ def from_file(path: str | Path, loader: str | None = None) -> dict[str, Any]:
     try:
         return load(loader, path=path)
     except pyplugs.UnknownPluginError:
-        raise UnsupportedLoaderError(
-            f"file type '{loader}' isn't supported. "
-            f"Use one of: {', '.join(loader_names())}"
-        ) from None
+        raise UnsupportedLoaderError(loader, loader_names()) from None

configaroo-0.2.4/src/configaroo/loaders/json.py

@@ -0,0 +1,16 @@
+"""Loader for JSON-files."""
+
+import json
+from pathlib import Path
+from typing import Any
+
+import pyplugs
+
+
+@pyplugs.register
+def load(path: Path) -> dict[str, Any]:
+    """Read a JSON-file.
+
+    Enforce that the JSON is an array/dict.
+    """
+    return dict(json.loads(path.read_text(encoding="utf-8")))

{configaroo-0.2.2 → configaroo-0.2.4}/src/configaroo/loaders/toml.py

@@ -1,4 +1,4 @@
-"""Loader for TOML-files"""
+"""Loader for TOML-files."""
 
 import tomllib
 from pathlib import Path
@@ -8,6 +8,6 @@ import pyplugs
 
 
 @pyplugs.register
-def load_toml_file(path: Path) -> dict[str, Any]:
-    """Read a TOML-file"""
+def load(path: Path) -> dict[str, Any]:
+    """Read a TOML-file."""
     return tomllib.loads(path.read_text(encoding="utf-8"))

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: configaroo
-Version: 0.2.2
+Version: 0.2.4
 Summary: Bouncy handling of configuration files
 Author-email: Geir Arne Hjelle <geirarne@gmail.com>
 Maintainer-email: Geir Arne Hjelle <geirarne@gmail.com>
@@ -8,7 +8,7 @@ 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
+Project-URL: changelog, https://github.com/gahjelle/configaroo/releases
 Keywords: configuration,configuration-management,toml,json
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
@@ -17,7 +17,6 @@ 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
@@ -25,11 +24,19 @@ Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pydantic>=2.0
-Requires-Dist: pyplugs>=0.4.0
+Requires-Dist: pyplugs>=0.5.4
 Dynamic: license-file
 
 # Configaroo - Bouncy Configuration Handling
 
+[![Latest version](https://img.shields.io/pypi/v/configaroo.svg)](https://pypi.org/project/configaroo/)
+[![Python versions](https://img.shields.io/pypi/pyversions/configaroo.svg)](https://pypi.org/project/configaroo/)
+[![License](https://img.shields.io/pypi/l/configaroo.svg)](https://github.com/gahjelle/configaroo/blob/main/LICENSE)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Linted](https://github.com/gahjelle/configaroo/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/gahjelle/configaroo/actions/workflows/lint.yml)
+[![Tested with Pytest](https://github.com/gahjelle/configaroo/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/gahjelle/configaroo/actions/workflows/test.yml)
+[![Type checked with mypy](https://img.shields.io/badge/type%20checked-mypy-green)](http://mypy-lang.org/)
+
 Configaroo is a light configuration package for Python that offers the following features:
 
 - Access configuration settings with dotted keys: `config.nested.key`

{configaroo-0.2.2 → configaroo-0.2.4}/src/configaroo.egg-info/SOURCES.txt

@@ -18,5 +18,6 @@ tests/test_dynamic.py
 tests/test_environment.py
 tests/test_json.py
 tests/test_loaders.py
+tests/test_print.py
 tests/test_toml.py
 tests/test_validation.py

configaroo-0.2.4/src/configaroo.egg-info/requires.txt

@@ -0,0 +1,2 @@
+pydantic>=2.0
+pyplugs>=0.5.4