configaroo 0.2.3__tar.gz → 0.3.0__tar.gz

{configaroo-0.2.3/src/configaroo.egg-info → configaroo-0.3.0}/PKG-INFO

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

{configaroo-0.2.3 → configaroo-0.3.0}/pyproject.toml

@@ -32,20 +32,19 @@ dynamic = ["version"]
 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/blob/main/CHANGELOG.md"
+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"]
 dev = [
+    { include-group = "ci" },
+    { include-group = "test" },
     "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",
 ]
+test = ["pytest>=8.4.1", "pytest-cov>=6.2.1", "tomli-w>=1.2.0"]
 
 
 [tool.setuptools.dynamic]
@@ -80,7 +79,7 @@ python_version = "3.11"
 strict = true
 
 [tool.bumpver]
-current_version = "v0.2.3"
+current_version = "v0.3.0"
 version_pattern = "vMAJOR.MINOR.PATCH"
 commit_message = "bump version {old_version} -> {new_version}"
 tag_message = "{new_version}"

{configaroo-0.2.3 → configaroo-0.3.0}/src/configaroo/__init__.py

@@ -15,4 +15,4 @@ __all__ = [
     "print_configuration",
 ]
 
-__version__ = "0.2.3"
+__version__ = "0.3.0"

{configaroo-0.2.3 → configaroo-0.3.0}/src/configaroo/configuration.py

@@ -112,8 +112,22 @@ class Configuration(UserDict[str, Any]):
         cls = type(self)
         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."""
+    def add_envs(self, envs: dict[str, str] | None = None, prefix: str = "") -> Self:
+        """Add environment variables to configuration.
+
+        If you don't specify which environment variables to read, you'll
+        automatically add any that matches a top-level value of the
+        configuration.
+        """
+        if envs is None:
+            # Automatically add top-level configuration items
+            envs = {
+                re.sub(r"\W", "_", key).upper(): key
+                for key, value in self.data.items()
+                if isinstance(value, str | int | float)
+            }
+
+        # Read environment variables
         for env, key in envs.items():
             env_key = f"{prefix}{env}"
             if env_value := os.getenv(env_key):
@@ -129,7 +143,7 @@ class Configuration(UserDict[str, Any]):
         cls = type(self)
         variables = (
             (self.to_flat_dict() if _include_self else {})
-            | {"project_path": _find_pyproject_toml()}
+            | {"project_path": find_pyproject_toml()}
             | ({} if extra is None else extra)
         )
         parsed = cls(
@@ -196,7 +210,7 @@ def print_configuration(config: Configuration | BaseModel, indent: int = 4) -> N
     )
 
 
-def _get_rich_print() -> Callable[[str], None]:
+def _get_rich_print() -> Callable[[str], None]:  # pragma: no cover
     """Initialize a Rich console if Rich is installed, otherwise use built-in print."""
     try:
         from rich.console import Console  # noqa: PLC0415
@@ -222,13 +236,13 @@ def _print_dict_as_tree(
                 value,
                 indent=indent,
                 current_indent=current_indent + indent,
-                _print=print,
+                _print=_print,
             )
         else:
             _print(" " * current_indent + f"- {key}: {value!r}")
 
 
-def _find_pyproject_toml(
+def find_pyproject_toml(
     path: Path | None = None, _file_name: str = "pyproject.toml"
 ) -> Path:
     """Find a directory that contains a pyproject.toml file.
@@ -241,7 +255,7 @@ def _find_pyproject_toml(
     if (path / _file_name).exists() or path == path.parent:
         return path.resolve()
 
-    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.3 → configaroo-0.3.0/src/configaroo.egg-info}/PKG-INFO

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

{configaroo-0.2.3 → configaroo-0.3.0}/tests/test_configuration.py

@@ -64,6 +64,12 @@ def test_get_nested_values(config: Configuration) -> None:
     assert config.get("with_dot.org.num") == 1234
 
 
+def test_get_with_default(config: Configuration) -> None:
+    """Test that .get() falls back on default if the key doesn't exist."""
+    assert config.get("word", default="kangaroo") == "platypus"
+    assert config.get("another word", default="kangaroo") == "kangaroo"
+
+
 def test_update_preserves_type(config: Configuration) -> None:
     """Test that an update operation gives a Configuration."""
     assert isinstance(config | {"new": 1}, Configuration)
@@ -122,7 +128,7 @@ def test_contains_with_dotted_key(config: Configuration) -> None:
 
 def test_find_pyproject_toml() -> None:
     """Test that the pyproject.toml file can be located."""
-    assert configuration._find_pyproject_toml() == Path(__file__).parent.parent
+    assert configuration.find_pyproject_toml() == Path(__file__).parent.parent
 
 
 def test_find_foreign_caller() -> None:

{configaroo-0.2.3 → configaroo-0.3.0}/tests/test_environment.py

@@ -45,7 +45,7 @@ def test_missing_env_ok_if_optional(config: Configuration) -> None:
 
 
 def test_env_prefix(config: Configuration, monkeypatch: pytest.MonkeyPatch) -> None:
-    """Test that a common prefix can be used for environment_variables."""
+    """Test that a common prefix can be used for environment variables."""
     monkeypatch.setenv("EXAMPLE_NUMBER", "14")
     monkeypatch.setenv("EXAMPLE_WORD", "platypus")
     config_w_env = config.add_envs(
@@ -53,3 +53,17 @@ def test_env_prefix(config: Configuration, monkeypatch: pytest.MonkeyPatch) -> N
     )
     assert config_w_env.number == "14"
     assert config_w_env.nested.word == "platypus"
+
+
+def test_env_automatic(config: Configuration, monkeypatch: pytest.MonkeyPatch) -> None:
+    """Test that top-level keys can be automatically filled by env variables."""
+    monkeypatch.setenv("NUMBER", "28")
+    monkeypatch.setenv("WORD", "kangaroo")
+    monkeypatch.setenv("A_B_D_KEY_", "works")
+    monkeypatch.setenv("NESTED", "should not be replaced")
+    config_w_env = (config | {"A b@d-key!": ""}).add_envs()
+
+    assert config_w_env.number == "28"
+    assert config_w_env.word == "kangaroo"
+    assert config_w_env["A b@d-key!"] == "works"
+    assert config_w_env.nested != "should not be replaced"