configaroo 0.5.0__py3-none-any.whl → 0.6.0__py3-none-any.whl

configaroo/__init__.py

@@ -20,4 +20,4 @@ __all__ = [
     "print_configuration",
 ]
 
-__version__ = "0.5.0"
+__version__ = "0.6.0"

configaroo/configuration.py

@@ -155,7 +155,7 @@ class Configuration(UserDict[str, Any]):
         self,
         model: type[BaseModel],
         prefix: str = "",
-        types: type | UnionType = str | bool | int | float,
+        types: type | UnionType = str | bool | int | float,  # pyright: ignore[reportArgumentType]
     ) -> Self:
         """Add environment variables to configuration based on the given model.
 
@@ -221,7 +221,11 @@ class Configuration(UserDict[str, Any]):
 
 
 def print_configuration(
-    config: Configuration | BaseModel, section: str | None = None, indent: int = 4
+    config: Configuration | BaseModel,
+    section: str | None = None,
+    *,
+    skip_none: bool = False,
+    indent: int = 4,
 ) -> None:
     """Pretty print a configuration.
 
@@ -231,7 +235,10 @@ def print_configuration(
         Configuration(config.model_dump()) if isinstance(config, BaseModel) else config
     )
     if section is None:
-        return _print_dict_as_tree(cfg, indent=indent, _print=_get_rich_print())
+        _print, _escape = _get_rich_print()
+        return _print_dict_as_tree(
+            cfg, skip_none=skip_none, indent=indent, _print=_print, _escape=_escape
+        )
 
     cfg_section = cfg.get(section)
     if cfg_section is None:
@@ -239,30 +246,43 @@ def print_configuration(
         raise KeyError(message) from None
 
     if isinstance(cfg_section, Configuration):
-        return print_configuration(cfg_section, indent=indent)
+        return print_configuration(cfg_section, skip_none=skip_none, indent=indent)
 
     *_, key = section.split(".")
-    return print_configuration(Configuration({key: cfg_section}), indent=indent)
+    return print_configuration(
+        Configuration({key: cfg_section}), skip_none=skip_none, indent=indent
+    )
 
 
-def _get_rich_print() -> Callable[[str], None]:  # pragma: no cover
-    """Initialize a Rich console if Rich is installed, otherwise use built-in print."""
+def _get_rich_print() -> tuple[
+    Callable[[str], None], Callable[[str], str]
+]:  # pragma: no cover
+    """Initialize a Rich console if Rich is installed, otherwise use built-in print.
+
+    Include a function that can be used to escape markup.
+    """
     try:
         from rich.console import Console  # noqa: PLC0415
+        from rich.markup import escape  # noqa: PLC0415
 
-        return Console().print
+        return Console().print, escape
     except ImportError:
-        return print
+        return print, str
 
 
 def _print_dict_as_tree(
     data: dict[str, Any] | UserDict[str, Any] | Configuration,
+    *,
+    skip_none: bool = False,
     indent: int = 4,
     current_indent: int = 0,
     _print: Callable[[str], None] = print,
+    _escape: Callable[[str], str] = str,
 ) -> None:
     """Print a nested dictionary as a tree."""
     for key, value in data.items():
+        if skip_none and value is None:
+            continue
         if isinstance(value, dict | UserDict | Configuration):
             _print(" " * current_indent + f"- {key}")
             _print_dict_as_tree(
@@ -270,9 +290,11 @@ def _print_dict_as_tree(
                 indent=indent,
                 current_indent=current_indent + indent,
                 _print=_print,
+                _escape=_escape,
             )
         else:
-            _print(" " * current_indent + f"- {key}: {value!r}")
+            escaped_repr = _escape(repr(value))
+            _print(" " * current_indent + f"- {key}: {escaped_repr}")
 
 
 def find_pyproject_toml(

{configaroo-0.5.0.dist-info → configaroo-0.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: configaroo
-Version: 0.5.0
+Version: 0.6.0
 Summary: Bouncy handling of configuration files
 Author-email: Geir Arne Hjelle <geirarne@gmail.com>
 Maintainer-email: Geir Arne Hjelle <geirarne@gmail.com>
@@ -33,9 +33,9 @@ Dynamic: license-file
 [![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)
+[![Linted with Ruff](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/)
+[![Type checked with pyright](https://microsoft.github.io/pyright/img/pyright_badge.svg)](https://microsoft.github.io/pyright/)
 
 Configaroo is a light configuration package for Python that offers the following features:
 

{configaroo-0.5.0.dist-info → configaroo-0.6.0.dist-info}/RECORD

@@ -1,12 +1,12 @@
-configaroo/__init__.py,sha256=l22-9ToQKNztSwKyyGs_jUIDJVqS7QoFPwUBrk9vKdg,477
-configaroo/configuration.py,sha256=1iUFB1hq8423rbz8VPzv7on0s3tTt89d6Ff3o_YcPL0,11407
+configaroo/__init__.py,sha256=6DOyBxg4xOCjHc9qVERA9NZ3VZD0rnKBPPoXaXFKSjY,477
+configaroo/configuration.py,sha256=z8zcdcAONtIE9M1xppf40iOVHfkp4x-TdTzmAUlpt-o,12032
 configaroo/exceptions.py,sha256=GfLf3CLfHStiQjvdS7ZAtrKF9gmGL_8biFLayue6J0M,772
 configaroo/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 configaroo/loaders/__init__.py,sha256=XQrFwCMWzQ71ykaZFPmYysDz12y_elPqxWhUMQCsq3s,1076
 configaroo/loaders/json.py,sha256=fT2Lg4hPM2BuwqrDsP7bcJlepAdmEh2iKU-YVK4KmIA,306
 configaroo/loaders/toml.py,sha256=jw9U78Lf-GMA8QmGIM8xMBqOhPaa8ITSMAhhN1ZNyng,256
-configaroo-0.5.0.dist-info/licenses/LICENSE,sha256=rdeT6Y5bm0MUaERso7HRWpPj37Y1RD5li2lIQaMNJjc,1090
-configaroo-0.5.0.dist-info/METADATA,sha256=GjTfNdCzx3HuH4-WFszmW4kau5_4aXXz5YE2YLV1T5w,2672
-configaroo-0.5.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-configaroo-0.5.0.dist-info/top_level.txt,sha256=JVYICl1cWSjvSOZuZMYm976z9lnZaWtHVRSt373QCxg,11
-configaroo-0.5.0.dist-info/RECORD,,
+configaroo-0.6.0.dist-info/licenses/LICENSE,sha256=rdeT6Y5bm0MUaERso7HRWpPj37Y1RD5li2lIQaMNJjc,1090
+configaroo-0.6.0.dist-info/METADATA,sha256=X4GSPIJMqNWSPufdbS2jgQ5Dma_WJ08ubKP57MsZ6l0,2703
+configaroo-0.6.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+configaroo-0.6.0.dist-info/top_level.txt,sha256=JVYICl1cWSjvSOZuZMYm976z9lnZaWtHVRSt373QCxg,11
+configaroo-0.6.0.dist-info/RECORD,,