appsettings2 2.0.9__tar.gz → 2.0.10__tar.gz

{appsettings2-2.0.9/src/appsettings2.egg-info → appsettings2-2.0.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: appsettings2
-Version: 2.0.9
+Version: 2.0.10
 Summary: Unifies configuration sources into a Configuration object that can be bound to complex types, or accessed directly for configuration data.
 Author-email: Shaun Wilson <mrshaunwilson@msn.com>
 License: MIT License
@@ -42,7 +42,7 @@ Requires-Dist: flake8; extra == "dev"
 Requires-Dist: flake8-pyproject; extra == "dev"
 Requires-Dist: mypy; extra == "dev"
 Requires-Dist: pep8-naming; extra == "dev"
-Requires-Dist: punit>=1.4.9; extra == "dev"
+Requires-Dist: punit>=1.10.8; extra == "dev"
 Requires-Dist: twine; extra == "dev"
 Requires-Dist: types-PyYAML; extra == "dev"
 Dynamic: license-file

{appsettings2-2.0.9 → appsettings2-2.0.10}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "appsettings2"
-version = "2.0.9"
+version = "2.0.10"
 description = "Unifies configuration sources into a Configuration object that can be bound to complex types, or accessed directly for configuration data."
 keywords = ["appsettings", "configuration"]
 authors = [
@@ -25,7 +25,7 @@ dev = [
     "flake8-pyproject",
     "mypy",
     "pep8-naming",
-    "punit (>=1.4.9)",
+    "punit (>=1.10.8)",
     "twine",
     "types-PyYAML"
 ]

{appsettings2-2.0.9 → appsettings2-2.0.10}/src/appsettings2/ConfigurationBuilder.py

@@ -65,13 +65,14 @@ class ConfigurationBuilder:
     addCommandLine = add_command_line
     """⚠️ DEPRECATED: use ``add_command_line(...)`` instead."""
  
-    def add_environment(self) -> 'ConfigurationBuilder':
+    def add_environment(self, required_prefix: str | None = None) -> 'ConfigurationBuilder':
         """
         Add a :py:class:`~appsettings2.providers.EnvironmentConfigurationProvider`.
 
+        :param required_prefix: Optional prefix used to filter which environment variables are included. Only variables whose names start with this prefix (followed by ``_`` or ``__``) will be loaded. When ``None``, all environment variables are included. Defaults to None.
         :return: Returns :py:class:`~appsettings2.ConfigurationBuilder` for method chaining.
         """
-        return self.add_provider(EnvironmentConfigurationProvider())
+        return self.add_provider(EnvironmentConfigurationProvider(required_prefix=required_prefix))
 
     addEnvironment = add_environment
     """⚠️ DEPRECATED: use ``add_environment(...)`` instead."""

{appsettings2-2.0.9 → appsettings2-2.0.10}/src/appsettings2/__init__.py

@@ -10,8 +10,8 @@ from . import helpers
 from . import providers
 
 
-__version__ = '2.0.9'
-__commit__ = 'b510516'
+__version__ = '2.0.10'
+__commit__ = 'fe8eec3'
 __all__ = [
     '__version__', '__commit__',
     'Configuration',

{appsettings2-2.0.9 → appsettings2-2.0.10}/src/appsettings2/helpers.py

@@ -8,7 +8,17 @@ from .Configuration import Configuration
 from .ConfigurationBuilder import ConfigurationBuilder
 
 
-def get_configuration(basename: str | pathlib.PosixPath | pathlib.Path = 'appsettings', json: bool = True, toml: bool = True, yaml: bool = True, cli: bool = True, environment: bool = True, variations: Optional[list[str | None]] = ['', 'prod', 'production', 'stage', 'staging', 'qa', 'dev', 'development', 'local']) -> Configuration:
+def get_configuration(
+    basename: str | pathlib.PosixPath | pathlib.Path = 'appsettings',
+    *,
+    json: bool = True,
+    toml: bool = True,
+    yaml: bool = True,
+    cli: bool = True,
+    environment: bool = True,
+    variations: Optional[list[str | None]] = ['', 'prod', 'production', 'stage', 'staging', 'qa', 'dev', 'development', 'local'],
+    env_prefix: str | None = None
+) -> Configuration:
     """
     Get a ``Configuration`` instance by loading from a set of well-known providers and their variations.
 
@@ -19,6 +29,7 @@ def get_configuration(basename: str | pathlib.PosixPath | pathlib.Path = 'appset
     :param cli: ``True`` to load configuration from Command-Line, defaults to True
     :param environment: ``True`` to load configuration from process Environment, defaults to True
     :param variations: A set of variations to apply to use with file-based Configuration Providers, defaults to ['', 'prod', 'production', 'stage', 'staging', 'qa', 'dev', 'development', 'local']
+    :param env_prefix: (OPTIONAL) When specified, only env vars having the specified prefix are bound as configuration settings, the prefix is stripped from the resulting setting name.
     :return: An ``appsettings2.Configuration`` instance.
     """
     if type(basename) is pathlib.Path or type(basename) is pathlib.PosixPath:
@@ -36,7 +47,7 @@ def get_configuration(basename: str | pathlib.PosixPath | pathlib.Path = 'appset
     if cli:
         builder.add_command_line()
     if environment:
-        builder.add_environment()
+        builder.add_environment(required_prefix=env_prefix)
     return builder.build()
 
 

appsettings2-2.0.10/src/appsettings2/providers/EnvironmentConfigurationProvider.py

@@ -0,0 +1,43 @@
+# SPDX-FileCopyrightText: © 2025 Shaun Wilson
+# SPDX-License-Identifier: MIT
+
+import os
+from typing import Any
+
+from ..Configuration import Configuration
+from .ConfigurationProvider import ConfigurationProvider
+
+
+class EnvironmentConfigurationProvider(ConfigurationProvider):
+    """A ``ConfigurationProvider`` that populates configuration data from Environment variables."""
+
+    __required_prefix: str | None
+
+    def __init__(self, /, required_prefix: str | None = None, **kwargs: Any) -> None:
+        self.__required_prefix = required_prefix.upper() if required_prefix is not None else None
+
+    def populate_configuration(self, configuration: Configuration) -> None:
+        """
+        Populate the provided :py:class:`~appsettings2.Configuration` from environment variables.
+
+        Usage::
+
+            # All env vars become config keys:
+            provider = EnvironmentConfigurationProvider()
+            provider.populate_configuration(config)
+
+            # Only keys with a specific prefix, stripped in output:
+            provider = EnvironmentConfigurationProvider(required_prefix="APP_")
+            # APP_DATABASE_URL=postgres://...  →  config["DATABASE_URL"] == "postgres://..."
+            provider.populate_configuration(config)
+
+        When ``required_prefix`` is set, only keys starting with that prefix are included,
+        and the prefix is stripped from each key in the output configuration.
+        """
+        for k in os.environ:
+            key = (
+                k
+                if self.__required_prefix is None
+                else k[len(self.__required_prefix):]
+            )
+            configuration.set(key, os.environ[k])

{appsettings2-2.0.9 → appsettings2-2.0.10/src/appsettings2.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: appsettings2
-Version: 2.0.9
+Version: 2.0.10
 Summary: Unifies configuration sources into a Configuration object that can be bound to complex types, or accessed directly for configuration data.
 Author-email: Shaun Wilson <mrshaunwilson@msn.com>
 License: MIT License
@@ -42,7 +42,7 @@ Requires-Dist: flake8; extra == "dev"
 Requires-Dist: flake8-pyproject; extra == "dev"
 Requires-Dist: mypy; extra == "dev"
 Requires-Dist: pep8-naming; extra == "dev"
-Requires-Dist: punit>=1.4.9; extra == "dev"
+Requires-Dist: punit>=1.10.8; extra == "dev"
 Requires-Dist: twine; extra == "dev"
 Requires-Dist: types-PyYAML; extra == "dev"
 Dynamic: license-file

{appsettings2-2.0.9 → appsettings2-2.0.10}/src/appsettings2.egg-info/requires.txt

@@ -6,6 +6,6 @@ flake8
 flake8-pyproject
 mypy
 pep8-naming
-punit>=1.4.9
+punit>=1.10.8
 twine
 types-PyYAML

appsettings2-2.0.9/src/appsettings2/providers/EnvironmentConfigurationProvider.py

@@ -1,14 +0,0 @@
-# SPDX-FileCopyrightText: © 2025 Shaun Wilson
-# SPDX-License-Identifier: MIT
-
-from .ConfigurationProvider import ConfigurationProvider
-from ..Configuration import Configuration
-import os
-
-
-class EnvironmentConfigurationProvider(ConfigurationProvider):
-    """A ``ConfigurationProvider`` that populates configuration data from Environment variables."""
-
-    def populate_configuration(self, configuration: Configuration) -> None:  # noqa: D102
-        for k in os.environ:
-            configuration.set(k, os.environ[k])