configaroo 0.5.0__tar.gz → 0.6.0__tar.gz

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

@@ -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 → configaroo-0.6.0}/README.md

@@ -4,9 +4,9 @@
 [![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 → configaroo-0.6.0}/pyproject.toml

@@ -36,13 +36,14 @@ changelog = "https://github.com/gahjelle/configaroo/releases"
 
 [dependency-groups]
 build = ["build>=1.2.2.post1", "twine>=6.1.0"]
-ci = ["mypy>=1.17.1", "pytest>=8.4.1", "rich>=14.1.0", "ruff>=0.12.7", "tomli-w>=1.2.0"]
+ci = ["pytest>=8.4.1", "rich>=14.1.0", "ruff>=0.12.7", "tomli-w>=1.2.0"]
 dev = [
     { include-group = "ci" },
     { include-group = "test" },
     "bumpver>=2024.1130",
     "ipython>=8.36.0",
     "pre-commit>=4.2.0",
+    "pyright>=1.1.404",
 ]
 test = ["pytest>=8.4.1", "pytest-cov>=6.2.1", "tomli-w>=1.2.0"]
 
@@ -74,12 +75,18 @@ ignore = [
 "tests/test_*.py" = ["PLR2004", "S101", "SLF001", "UP018"]
 "tests/*/test_*.py" = ["S101"]
 
-[tool.mypy]
-python_version = "3.11"
-strict = true
+[tool.pyright]
+pythonVersion = "3.11"
+typeCheckingMode = "strict"
+verboseOutput = false
+include = ["src/", "tests/", "examples/"]
+venv = ".venv"
+
+reportUnknownArgumentType = "none"
+reportUnknownMemberType = "none"
 
 [tool.bumpver]
-current_version = "v0.5.0"
+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.0 → configaroo-0.6.0}/src/configaroo/__init__.py

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

{configaroo-0.5.0 → configaroo-0.6.0}/src/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 → configaroo-0.6.0/src/configaroo.egg-info}/PKG-INFO

@@ -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 → configaroo-0.6.0}/tests/test_configuration.py

@@ -127,12 +127,12 @@ def test_find_pyproject_toml() -> None:
 
 def test_find_foreign_caller() -> None:
     """Test that a foreign caller (outside of configaroo) can be identified."""
-    assert configuration._get_foreign_path() == Path(__file__)
+    assert configuration._get_foreign_path() == Path(__file__)  # pyright: ignore[reportPrivateUsage]
 
 
 def test_incomplete_formatter() -> None:
     """Test that the incomplete formatter can handle fields that aren't replaced."""
-    formatted = configuration._incomplete_format(
+    formatted = configuration._incomplete_format(  # pyright: ignore[reportPrivateUsage]
         "{number:5.1f} {non_existent} {string!r} {name}",
         {"number": 3.14, "string": "platypus", "name": "Geir Arne"},
     )

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

@@ -94,3 +94,33 @@ def test_printing_of_nested_sections(
     lines = stdout.splitlines()
 
     assert lines == ["- sea: 'Marianer'"]
+
+
+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