azpaddypy 0.4.0__py3-none-any.whl → 0.4.1__py3-none-any.whl

azpaddypy/mgmt/__init__.py

@@ -6,8 +6,11 @@ __version__ = "0.1.0"
 
 from azpaddypy.mgmt.logging import AzureLogger
 from azpaddypy.mgmt.identity import AzureIdentity
+from azpaddypy.mgmt.local_development import LocalDevelopmentSettings, set_local_dev_environment
 
 __all__ = [
     "AzureLogger", 
     "AzureIdentity",
+    "LocalDevelopmentSettings",
+    "set_local_dev_environment",
 ]

azpaddypy/mgmt/local_development.py

@@ -0,0 +1,196 @@
+import os
+import json
+import pathlib
+from typing import Dict, Optional, Union
+from .logging import AzureLogger
+
+
+class LocalDevelopmentSettings:
+    """Manages loading of local development settings from .env and JSON files.
+
+    This class provides a standardized way to load configuration from
+    .env files and Azure Functions-style `local.settings.json` files into
+    environment variables, making local development environments consistent
+    with deployed Azure environments.
+
+    It supports overriding existing environment variables and provides clear
+    logging for loaded settings.
+
+    Attributes:
+        logger: An instance of AzureLogger for structured logging.
+        settings_path: The path to the settings file to be loaded.
+    """
+
+    def __init__(
+        self,
+        service_name: str = "local_dev_settings",
+        service_version: str = "1.0.0",
+        logger: Optional[AzureLogger] = None,
+        connection_string: Optional[str] = None,
+    ):
+        """Initializes the LocalDevelopmentSettings manager.
+
+        Args:
+            service_name: The name of the service using the settings manager.
+            service_version: The version of the service.
+            logger: An optional existing AzureLogger instance.
+            connection_string: Application Insights connection string for a new logger.
+        """
+        if logger:
+            self.logger = logger
+        else:
+            self.logger = AzureLogger(
+                service_name=service_name,
+                service_version=service_version,
+                connection_string=connection_string,
+                enable_console_logging=True,
+            )
+        self.logger.info("LocalDevelopmentSettings initialized.")
+
+    def load_from_dotenv(
+        self,
+        dotenv_path: Union[str, pathlib.Path],
+        override: bool = False
+    ) -> bool:
+        """Loads key-value pairs from a .env file into environment variables.
+
+        Args:
+            dotenv_path: The path to the .env file.
+            override: If True, existing environment variables will be overwritten.
+
+        Returns:
+            True if the file was loaded successfully, False otherwise.
+        """
+        dotenv_path = pathlib.Path(dotenv_path)
+        if not dotenv_path.is_file():
+            self.logger.warning(f".env file not found at {dotenv_path}. Skipping.")
+            return False
+
+        try:
+            with open(dotenv_path, "r") as f:
+                for line in f:
+                    line = line.strip()
+                    if not line or line.startswith("#"):
+                        continue
+
+                    parts = line.split("=", 1)
+                    if len(parts) != 2:
+                        continue
+
+                    key, value = parts[0].strip(), parts[1].strip()
+                    value = value.replace('"', "")
+
+                    if key not in os.environ or override:
+                        os.environ[key] = value
+                        self.logger.debug(f"Loaded from .env: {key}={value[:8]}...")
+                    else:
+                        self.logger.debug(f"Skipping from .env (exists): {key}")
+
+            self.logger.info(f"Successfully loaded settings from {dotenv_path}")
+            return True
+        except Exception as e:
+            self.logger.error(f"Error reading .env file at {dotenv_path}: {e}", exc_info=True)
+            return False
+
+    def load_from_json(
+        self,
+        json_path: Union[str, pathlib.Path],
+        override: bool = False
+    ) -> bool:
+        """Loads settings from a JSON file (e.g., local.settings.json).
+
+        The JSON file is expected to have a "Values" key containing a
+        dictionary of settings.
+
+        Args:
+            json_path: The path to the JSON settings file.
+            override: If True, existing environment variables will be overwritten.
+
+        Returns:
+            True if the file was loaded successfully, False otherwise.
+        """
+        json_path = pathlib.Path(json_path)
+        if not json_path.is_file():
+            self.logger.warning(f"JSON settings file not found at {json_path}. Skipping.")
+            return False
+
+        try:
+            with open(json_path, "r") as f:
+                settings = json.load(f)
+
+            if "Values" in settings and isinstance(settings["Values"], dict):
+                for key, value in settings["Values"].items():
+                    if key not in os.environ or override:
+                        os.environ[key] = str(value)
+                        self.logger.debug(f"Loaded from JSON: {key}={str(value)[:8]}...")
+                    else:
+                        self.logger.debug(f"Skipping from JSON (exists): {key}")
+                self.logger.info(f"Successfully loaded settings from {json_path}")
+                return True
+            else:
+                self.logger.warning(f"No 'Values' dictionary found in {json_path}. Skipping.")
+                return False
+        except json.JSONDecodeError:
+            self.logger.error(f"Error decoding JSON from {json_path}.", exc_info=True)
+            return False
+        except Exception as e:
+            self.logger.error(f"Error reading JSON file at {json_path}: {e}", exc_info=True)
+            return False
+
+    def apply_settings(
+        self,
+        settings: Dict[str, str],
+        override: bool = True
+    ):
+        """Applies a dictionary of settings to the environment variables.
+
+        Args:
+            settings: A dictionary of key-value pairs to set as environment variables.
+            override: If True, existing environment variables will be overwritten.
+        """
+        for key, value in settings.items():
+            if key not in os.environ or override:
+                os.environ[key] = str(value)
+                self.logger.debug(f"Applied setting: {key}={str(value)[:8]}...")
+            else:
+                self.logger.debug(f"Skipping setting (exists): {key}")
+        self.logger.info(f"Applied {len(settings)} settings to environment.")
+
+
+def set_local_dev_environment(
+    file_path: str = ".env",
+    settings: Optional[Dict[str, str]] = None,
+    logger: Optional[AzureLogger] = None,
+    override_json: bool = True,
+    override_dotenv: bool = True,
+    override_settings: bool = True
+):
+    """Convenience function to load settings from multiple sources.
+
+    This function orchestrates loading settings from a `local.settings.json` file,
+    a `.env` file, and a direct dictionary of settings, in that order.
+
+    Args:
+        file_path: Base path for `.env` or `local.settings.json`. The function
+                   will look for both.
+        settings: A dictionary of settings to apply.
+        logger: An optional AzureLogger instance.
+        override_json: Whether settings from JSON should override existing env vars.
+        override_dotenv: Whether settings from .env should override existing env vars.
+        override_settings: Whether settings from the dictionary should override.
+    """
+    manager = LocalDevelopmentSettings(logger=logger)
+    
+    # Try loading local.settings.json
+    json_path = pathlib.Path(file_path).parent / "local.settings.json"
+    if json_path.is_file():
+        manager.load_from_json(json_path, override=override_json)
+    
+    # Try loading .env
+    dotenv_path = pathlib.Path(file_path)
+    if dotenv_path.is_file() and dotenv_path.name == ".env":
+        manager.load_from_dotenv(dotenv_path, override=override_dotenv)
+
+    # Apply dictionary settings
+    if settings:
+        manager.apply_settings(settings, override=override_settings)

{azpaddypy-0.4.0.dist-info → azpaddypy-0.4.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: azpaddypy
-Version: 0.4.0
+Version: 0.4.1
 Summary: Comprehensive Python logger for Azure, integrating OpenTelemetry for advanced, structured, and distributed tracing.
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent

{azpaddypy-0.4.0.dist-info → azpaddypy-0.4.1.dist-info}/RECORD

@@ -1,11 +1,12 @@
 azpaddypy/__init__.py,sha256=hrWNAh4OHZOvm3Pbhq5eUjO-pSRYn0h0W0J87tc-lNI,45
-azpaddypy/mgmt/__init__.py,sha256=-jH8Ftx9C8qu4yF5dMVEapVZhNwG7m4QCUjyutesOoY,278
+azpaddypy/mgmt/__init__.py,sha256=YsY0KzTcPAjQJZpcQKyVCtS7_rI_AbxVJuD-6TVB3uY,443
 azpaddypy/mgmt/identity.py,sha256=mA_krQslMsK_sDob-z-QA0B9khK_JUO2way7xwPopR8,12001
+azpaddypy/mgmt/local_development.py,sha256=5nL-EWUk_6EvJUFjCwfYFK14E3Yh-ErfswHJrRoV5aI,7779
 azpaddypy/mgmt/logging.py,sha256=3ZLSKwpX7Tprthrkm3uN4ph2n2CxiGYUNri7jBJuXEY,36514
 azpaddypy/resources/__init__.py,sha256=Bvt3VK4RqwoxYpoh6EbLXIR18RuFPKaLP6zLL-icyFk,314
 azpaddypy/resources/keyvault.py,sha256=4J08vLqoLFd1_UUDBji2oG2fatZaPkgnRyT_Z6wHAOc,20312
-azpaddypy-0.4.0.dist-info/licenses/LICENSE,sha256=hQ6t0g2QaewGCQICHqTckBFbMVakGmoyTAzDpmEYV4c,1089
-azpaddypy-0.4.0.dist-info/METADATA,sha256=_rscPv9TjFvF_lmOgCisBK0janjJiuU7wjQX_H7Empg,665
-azpaddypy-0.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-azpaddypy-0.4.0.dist-info/top_level.txt,sha256=hsDuboDhT61320ML8X479ezSTwT3rrlDWz1_Z45B2cs,10
-azpaddypy-0.4.0.dist-info/RECORD,,
+azpaddypy-0.4.1.dist-info/licenses/LICENSE,sha256=hQ6t0g2QaewGCQICHqTckBFbMVakGmoyTAzDpmEYV4c,1089
+azpaddypy-0.4.1.dist-info/METADATA,sha256=8y3xmkrpmT_dNhwI_8a7U7r4Rzy-2EcliNMmm4Bt7cY,665
+azpaddypy-0.4.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+azpaddypy-0.4.1.dist-info/top_level.txt,sha256=hsDuboDhT61320ML8X479ezSTwT3rrlDWz1_Z45B2cs,10
+azpaddypy-0.4.1.dist-info/RECORD,,