configaroo 0.2.1__py3-none-any.whl → 0.2.3__py3-none-any.whl

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.1"
+__version__ = "0.2.3"

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,8 +16,21 @@ 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.
+
+        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(
@@ -27,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
@@ -43,42 +57,44 @@ 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(value)
-        else:
-            return value
+            return Configuration.from_dict(value)
+
+        return value
 
-    def __getattr__(self, key: str) -> Any:
-        """Create attribute access for config keys for convenience"""
+    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.
 
-    def __contains__(self, key: str) -> bool:
-        """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 = key.partition(".")
+        prefix, _, rest = str(key).partition(".")
         try:
             return rest in self[prefix]
         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]
 
@@ -88,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}
@@ -97,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 {})
@@ -135,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()
@@ -170,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:
@@ -182,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/exceptions.py

@@ -1,13 +1,23 @@
-"""Configaroo specific exceptions"""
+"""Configaroo specific exceptions."""
 
 
-class ConfigarooException(Exception):
-    """Base exception for more specific Configaroo exceptions"""
+class ConfigarooError(Exception):
+    """Base exception for more specific Configaroo exceptions."""
 
 
-class MissingEnvironmentVariableError(ConfigarooException, KeyError):
-    """A required environment variable is missing"""
+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(ConfigarooException, ValueError):
-    """An unsupported loader is called"""
+
+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/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/loaders/json.py

@@ -1,4 +1,4 @@
-"""Loader for JSON-files"""
+"""Loader for JSON-files."""
 
 import json
 from pathlib import Path
@@ -8,6 +8,9 @@ import pyplugs
 
 
 @pyplugs.register
-def load_json_file(path: Path) -> dict[str, Any]:
-    """Read a JSON-file"""
-    return json.loads(path.read_text(encoding="utf-8"))
+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/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.1.dist-info → configaroo-0.2.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: configaroo
-Version: 0.2.1
+Version: 0.2.3
 Summary: Bouncy handling of configuration files
 Author-email: Geir Arne Hjelle <geirarne@gmail.com>
 Maintainer-email: Geir Arne Hjelle <geirarne@gmail.com>
@@ -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.3.dist-info/RECORD

@@ -0,0 +1,12 @@
+configaroo/__init__.py,sha256=Ed1V019MUJ0Kac5NOY43u83axSsl7I1xE5j1DpAKXeI,412
+configaroo/configuration.py,sha256=CzKS9zy3VCaCDexF5_DuYIhRIyBs8EVst6full9zM34,9728
+configaroo/exceptions.py,sha256=GfLf3CLfHStiQjvdS7ZAtrKF9gmGL_8biFLayue6J0M,772
+configaroo/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+configaroo/loaders/__init__.py,sha256=l2pHeD9PJ3ZQA5xUCq9nfFqw2YhAHLeTe50wvhMmTYA,977
+configaroo/loaders/json.py,sha256=fT2Lg4hPM2BuwqrDsP7bcJlepAdmEh2iKU-YVK4KmIA,306
+configaroo/loaders/toml.py,sha256=jw9U78Lf-GMA8QmGIM8xMBqOhPaa8ITSMAhhN1ZNyng,256
+configaroo-0.2.3.dist-info/licenses/LICENSE,sha256=rdeT6Y5bm0MUaERso7HRWpPj37Y1RD5li2lIQaMNJjc,1090
+configaroo-0.2.3.dist-info/METADATA,sha256=Y9N_zcN5p1jO4pHt1sI_BPX2qT_w9S_2UmdhKj87uyM,2686
+configaroo-0.2.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+configaroo-0.2.3.dist-info/top_level.txt,sha256=JVYICl1cWSjvSOZuZMYm976z9lnZaWtHVRSt373QCxg,11
+configaroo-0.2.3.dist-info/RECORD,,

{configaroo-0.2.1.dist-info → configaroo-0.2.3.dist-info}/licenses/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.1.dist-info/RECORD

@@ -1,12 +0,0 @@
-configaroo/__init__.py,sha256=-rsRqALc9-loy4qWJQHYE6QG0rZ1gwYjIUPy72DbsZg,371
-configaroo/configuration.py,sha256=a39w6uHJMrc8pDbHZJX0dr8DVZ6gMFbFSLUlEPCMCdw,7779
-configaroo/exceptions.py,sha256=1h-6hV7VqqKaRFnu539pjsO0ESSNDibt2kUeF7jAM2M,374
-configaroo/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-configaroo/loaders/__init__.py,sha256=-6GAR4g7vYW7Zagq9Ev479kpkfY7kbvDl4JPXd4wQQ0,756
-configaroo/loaders/json.py,sha256=6gs_ZegUEe70vb6uSJfKBos7UjfuJnyWgPE_kjDQISw,258
-configaroo/loaders/toml.py,sha256=ZVbHutZ7V-Z_jf2aHjV18jwaqCXumlr06j48rojHcBM,264
-configaroo-0.2.1.dist-info/licenses/LICENSE,sha256=2cbzsB4lU8qOO8fO1XVNJD7XPxzPhaWXm6U9DenSc0s,1089
-configaroo-0.2.1.dist-info/METADATA,sha256=0Od55T9MEvRBhi4JHllAU2S0U9NBl0T99yA2Axsf0wk,1789
-configaroo-0.2.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-configaroo-0.2.1.dist-info/top_level.txt,sha256=JVYICl1cWSjvSOZuZMYm976z9lnZaWtHVRSt373QCxg,11
-configaroo-0.2.1.dist-info/RECORD,,