configaroo 0.3.0__tar.gz → 0.4.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: configaroo
-Version: 0.3.0
+Version: 0.4.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.3.0 → configaroo-0.4.0}/pyproject.toml

@@ -79,7 +79,7 @@ python_version = "3.11"
 strict = true
 
 [tool.bumpver]
-current_version = "v0.3.0"
+current_version = "v0.4.0"
 version_pattern = "vMAJOR.MINOR.PATCH"
 commit_message = "bump version {old_version} -> {new_version}"
 tag_message = "{new_version}"

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

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

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

@@ -36,33 +36,20 @@ class Configuration(UserDict[str, Any]):
     def from_file(
         cls,
         file_path: str | Path,
+        *,
         loader: str | None = None,
-        envs: dict[str, str] | None = None,
-        env_prefix: str = "",
-        extra_dynamic: dict[str, Any] | None = None,
+        not_exist_ok: bool = False,
     ) -> Self:
-        """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
-        )
-
-    def initialize(
-        self,
-        envs: dict[str, str] | None = None,
-        env_prefix: str = "",
-        extra_dynamic: dict[str, Any] | None = None,
-    ) -> Self:
-        """Initialize a configuration.
+        """Read a Configuration from a file.
 
-        The initialization adds environment variables and parses dynamic values.
+        If not_exist_ok is True, then a missing file returns an empty
+        configuration. This may be useful if the configuration is potentially
+        populated by environment variables.
         """
-        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:
-        """Apply a pydantic model to a configuration."""
-        return self.validate_model(model).convert_model(model)
+        config_dict = loaders.from_file(
+            file_path, loader=loader, not_exist_ok=not_exist_ok
+        )
+        return cls(config_dict)
 
     def __getitem__(self, key: str) -> Any:  # noqa: ANN401
         """Make sure nested sections have type Configuration."""
@@ -172,6 +159,10 @@ class Configuration(UserDict[str, Any]):
         """Convert data types to match the given model."""
         return model(**self.data)
 
+    def with_model(self, model: type[ModelT]) -> ModelT:
+        """Apply a pydantic model to a configuration."""
+        return self.validate_model(model).convert_model(model)
+
     def to_dict(self) -> dict[str, Any]:
         """Dump the configuration into a Python dictionary."""
         return {
@@ -217,9 +208,7 @@ def _get_rich_print() -> Callable[[str], None]:  # pragma: no cover
 
         return Console().print
     except ImportError:
-        import builtins  # noqa: PLC0415
-
-        return builtins.print
+        return print
 
 
 def _print_dict_as_tree(

{configaroo-0.3.0 → configaroo-0.4.0}/src/configaroo/loaders/__init__.py

@@ -26,9 +26,14 @@ def loader_names() -> list[str]:
     return sorted(pyplugs.names(PACKAGE))
 
 
-def from_file(path: str | Path, loader: str | None = None) -> dict[str, Any]:
+def from_file(
+    path: str | Path, *, loader: str | None = None, not_exist_ok: bool = False
+) -> dict[str, Any]:
     """Load a file using a loader defined by the suffix if necessary."""
     path = Path(path)
+    if not path.exists() and not_exist_ok:
+        return {}
+
     loader = path.suffix.lstrip(".") if loader is None else loader
     try:
         return load(loader, path=path)

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: configaroo
-Version: 0.3.0
+Version: 0.4.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.3.0 → configaroo-0.4.0}/tests/test_configuration.py

@@ -8,12 +8,6 @@ import configaroo
 from configaroo import Configuration, configuration
 
 
-@pytest.fixture
-def file_path() -> Path:
-    """Return the path to the current file."""
-    return Path(__file__).resolve()
-
-
 def test_read_simple_values_as_attributes(config: Configuration) -> None:
     """Test attribute access for simple values."""
     assert config.number == 42

{configaroo-0.3.0 → configaroo-0.4.0}/tests/test_json.py

@@ -38,6 +38,12 @@ def test_error_on_wrong_format(toml_path: Path) -> None:
         Configuration.from_file(toml_path, loader="json")
 
 
+def test_file_may_be_allowed_to_not_exist() -> None:
+    """Test that not_exist_ok can suppress error when file doesn't exist."""
+    config = Configuration.from_file("non-existent.json", not_exist_ok=True)
+    assert config.data == {}
+
+
 def test_can_read_json_values(json_path: Path) -> None:
     """Test that values can be accessed."""
     config = Configuration.from_file(json_path)

{configaroo-0.3.0 → configaroo-0.4.0}/tests/test_toml.py

@@ -38,6 +38,12 @@ def test_error_on_wrong_format(json_path: Path) -> None:
         Configuration.from_file(json_path, loader="toml")
 
 
+def test_file_may_be_allowed_to_not_exist() -> None:
+    """Test that not_exist_ok can suppress error when file doesn't exist."""
+    config = Configuration.from_file("non-existent.toml", not_exist_ok=True)
+    assert config.data == {}
+
+
 def test_can_read_toml_values(toml_path: Path) -> None:
     """Test that values can be accessed."""
     config = Configuration.from_file(toml_path)