configaroo 0.5.1__tar.gz → 0.6.0__tar.gz

{configaroo-0.5.1/src/configaroo.egg-info → configaroo-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: configaroo
-Version: 0.5.1
+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>

{configaroo-0.5.1 → configaroo-0.6.0}/pyproject.toml

@@ -86,7 +86,7 @@ reportUnknownArgumentType = "none"
 reportUnknownMemberType = "none"
 
 [tool.bumpver]
-current_version = "v0.5.1"
+current_version = "v0.6.0"
 version_pattern = "vMAJOR.MINOR.PATCH"
 commit_message = "bump version {old_version} -> {new_version}"
 tag_message = "{new_version}"

{configaroo-0.5.1 → configaroo-0.6.0}/src/configaroo/__init__.py

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

{configaroo-0.5.1 → configaroo-0.6.0}/src/configaroo/configuration.py

@@ -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.
 
@@ -232,7 +236,9 @@ def print_configuration(
     )
     if section is None:
         _print, _escape = _get_rich_print()
-        return _print_dict_as_tree(cfg, indent=indent, _print=_print, _escape=_escape)
+        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:
@@ -240,10 +246,12 @@ 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() -> tuple[
@@ -264,6 +272,8 @@ def _get_rich_print() -> tuple[
 
 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,
@@ -271,6 +281,8 @@ def _print_dict_as_tree(
 ) -> 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(

{configaroo-0.5.1 → configaroo-0.6.0/src/configaroo.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: configaroo
-Version: 0.5.1
+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>

{configaroo-0.5.1 → configaroo-0.6.0}/tests/test_print.py

@@ -100,3 +100,27 @@ def test_printing_of_rich_markup() -> None:
     """Test that a config value containing malformed Rich markup can be printed."""
     config = Configuration({"markup": "[/]"})
     print_configuration(config)
+
+
+def test_print_keeping_none(
+    capsys: pytest.CaptureFixture[str], config: Configuration
+) -> None:
+    """Test that None-values are kept in printout by default."""
+    print_configuration(config | {"none": None})
+    stdout = capsys.readouterr().out
+    lines = stdout.splitlines()
+
+    assert "- none: None" in lines
+    assert "- number: 42" in lines
+
+
+def test_print_skipping_none(
+    capsys: pytest.CaptureFixture[str], config: Configuration
+) -> None:
+    """Test that None-values are skipped in printout if asked for."""
+    print_configuration(config | {"none": None}, skip_none=True)
+    stdout = capsys.readouterr().out
+    lines = stdout.splitlines()
+
+    assert "- none: None" not in lines
+    assert "- number: 42" in lines