configaroo 0.3.0__py3-none-any.whl → 0.4.1__py3-none-any.whl

configaroo/__init__.py

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

configaroo/configuration.py

@@ -6,6 +6,7 @@ import re
 from collections import UserDict
 from collections.abc import Callable
 from pathlib import Path
+from types import UnionType
 from typing import Any, Self, TypeVar
 
 from pydantic import BaseModel
@@ -36,33 +37,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
-        )
+        """Read a Configuration from a file.
 
-    def initialize(
-        self,
-        envs: dict[str, str] | None = None,
-        env_prefix: str = "",
-        extra_dynamic: dict[str, Any] | None = None,
-    ) -> Self:
-        """Initialize a configuration.
-
-        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."""
@@ -112,30 +100,6 @@ 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] | 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):
-                self = self.add(key, env_value)  # noqa: PLW0642
-            elif key not in self:
-                raise MissingEnvironmentVariableError(env_key)
-        return self
-
     def parse_dynamic(
         self, extra: dict[str, Any] | None = None, *, _include_self: bool = True
     ) -> Self:
@@ -163,6 +127,60 @@ class Configuration(UserDict[str, Any]):
         # Continue parsing until no more replacements are made.
         return parsed.parse_dynamic(extra=extra, _include_self=_include_self)
 
+    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 simple 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):
+                self = self.add(key, env_value)  # noqa: PLW0642
+            elif key not in self:
+                raise MissingEnvironmentVariableError(env_key)
+        return self
+
+    def add_envs_from_model(
+        self,
+        model: type[BaseModel],
+        prefix: str = "",
+        types: type | UnionType = str | bool | int | float,
+    ) -> Self:
+        """Add environment variables to configuration based on the given model.
+
+        Top level string, bool, integer, and float fields from the model are
+        looked for among environment variables.
+        """
+
+        def _get_class_from_annotation(annotation: type) -> type:
+            """Unpack generic annotations and return the underlying class."""
+            return (
+                _get_class_from_annotation(annotation.__origin__)
+                if hasattr(annotation, "__origin__")
+                else annotation
+            )
+
+        envs = {
+            re.sub(r"\W", "_", key).upper(): key
+            for key, field in model.model_fields.items()
+            if (
+                field.annotation is not None
+                and issubclass(_get_class_from_annotation(field.annotation), types)
+            )
+        }
+        return self.add_envs(envs, prefix=prefix)
+
     def validate_model(self, model: type[BaseModel]) -> Self:
         """Validate the configuration against the given model."""
         model.model_validate(self.data)
@@ -172,6 +190,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 +239,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/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.dist-info → configaroo-0.4.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: configaroo
-Version: 0.3.0
+Version: 0.4.1
 Summary: Bouncy handling of configuration files
 Author-email: Geir Arne Hjelle <geirarne@gmail.com>
 Maintainer-email: Geir Arne Hjelle <geirarne@gmail.com>

configaroo-0.4.1.dist-info/RECORD

@@ -0,0 +1,12 @@
+configaroo/__init__.py,sha256=yTD0mUdvhepcJSiLEBKTPDuQh8BWjrKnTB1QSfmjHRw,412
+configaroo/configuration.py,sha256=1tGBLkyz703txcaGx49kWHMiVYgjTcERnikVQ69Pusc,10928
+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.4.1.dist-info/licenses/LICENSE,sha256=rdeT6Y5bm0MUaERso7HRWpPj37Y1RD5li2lIQaMNJjc,1090
+configaroo-0.4.1.dist-info/METADATA,sha256=U_sK60hkeYLqI5gEjv6UoG1l1r3w3pKhhADB4kfXqDQ,2672
+configaroo-0.4.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+configaroo-0.4.1.dist-info/top_level.txt,sha256=JVYICl1cWSjvSOZuZMYm976z9lnZaWtHVRSt373QCxg,11
+configaroo-0.4.1.dist-info/RECORD,,

configaroo-0.3.0.dist-info/RECORD

@@ -1,12 +0,0 @@
-configaroo/__init__.py,sha256=yNF3fDQx9xXJEXHtJmeYMdqy-Dnk0mHz2-EL590A858,412
-configaroo/configuration.py,sha256=phBUk_hHRFQb4vCcn6WHfNOnovEmdV6hnotRJkPSz2E,10255
-configaroo/exceptions.py,sha256=GfLf3CLfHStiQjvdS7ZAtrKF9gmGL_8biFLayue6J0M,772
-configaroo/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-configaroo/loaders/__init__.py,sha256=l2pHeD9PJ3ZQA5xUCq9nfFqw2YhAHLeTe50wvhMmTYA,977
-configaroo/loaders/json.py,sha256=fT2Lg4hPM2BuwqrDsP7bcJlepAdmEh2iKU-YVK4KmIA,306
-configaroo/loaders/toml.py,sha256=jw9U78Lf-GMA8QmGIM8xMBqOhPaa8ITSMAhhN1ZNyng,256
-configaroo-0.3.0.dist-info/licenses/LICENSE,sha256=rdeT6Y5bm0MUaERso7HRWpPj37Y1RD5li2lIQaMNJjc,1090
-configaroo-0.3.0.dist-info/METADATA,sha256=spH6HtB45ksEBsjuCJIADFjWabsQQfzTPZvCuMfV8Fk,2672
-configaroo-0.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-configaroo-0.3.0.dist-info/top_level.txt,sha256=JVYICl1cWSjvSOZuZMYm976z9lnZaWtHVRSt373QCxg,11
-configaroo-0.3.0.dist-info/RECORD,,