Merge pull request #20 from microsoft/psl-fix-linting

fix: pylint

Author: Yamini-Microsoft

.flake8

@@ -0,0 +1,23 @@
+[flake8]
+max-line-length = 88
+extend-ignore =
+    # Docstring warnings (D-series) - these are style preferences
+    D100, D101, D102, D103, D107, D400, D401
+    # Type annotation warnings (ANN-series) - gradually add these
+    ANN001, ANN101, ANN201, ANN202, ANN204, ANN205
+    # Import order warnings (I-series) - handled by isort
+    I100, I101, I201, I202
+    # Whitespace in blank lines
+    W293
+    # F-string without placeholders (often intentional for consistency)
+    F541
+exclude =
+    .git,
+    __pycache__,
+    .venv,
+    venv,
+    *.egg-info,
+    .tox,
+    .eggs
+per-file-ignores =
+    __init__.py:F401

src/azd_env_loader.py

@@ -1,11 +1,21 @@
+"""Azure Developer CLI (AZD) environment loader utility."""
 
 import json
 import os
 from pathlib import Path
+from typing import Optional
+
 
 class AZDEnvironmentLoader:
-    def __init__(self, directory: str = None, required: bool = False, log_events: bool = True):
+    """Loads and manages Azure Developer CLI environment variables."""
 
+    def __init__(
+        self,
+        directory: Optional[str] = None,
+        required: bool = False,
+        log_events: bool = True
+    ) -> None:
+        """Initialize the AZD environment loader."""
         if directory is None:
             curr_script_path = Path(__file__)
             project_root = curr_script_path.parent
@@ -26,39 +36,46 @@ def __init__(self, directory: str = None, required: bool = False, log_events: bo
             azure_dir = azure_dir / '.azure'
 
         config_file = azure_dir / 'config.json'
-        
+
         if not config_file.exists():
             self._handle_invalid_env("AZD config.json file not found")
             return
-        
+
         with open(config_file, 'r') as f:
             config = json.load(f)
-        
+
         self.default_env = config.get('defaultEnvironment')
         if not self.default_env:
-            self._handle_invalid_env("No defaultEnvironment set in AZD config.json")
+            msg = "No defaultEnvironment set in AZD config.json"
+            self._handle_invalid_env(msg)
             return
-        
+
         env_dir = azure_dir / self.default_env
         self.env_file = env_dir / '.env'
 
-    def _log(self, message: str):
+    def _log(self, message: str) -> None:
+        """Log a message if logging is enabled."""
         if self.log_events:
             print(message)
 
-    def _handle_invalid_env(self, message: str):
+    def _handle_invalid_env(self, message: str) -> None:
+        """Handle invalid environment configuration."""
         if self.required:
             raise EnvironmentError(f"❌ Error: {message}.")
         else:
             self._log(f"⚠️  Warning: {message}.")
 
-    def set_env_vars(self):
-        """Load environment variables from AZD environment if not already set."""
-        try:            
+    def set_env_vars(self) -> None:
+        """Load environment variables from AZD environment."""
+        try:
             if not self.env_file or not self.env_file.exists():
-                self._handle_invalid_env(f"No .env file found for the default environment '{self.default_env}'")
+                msg = (
+                    f"No .env file found for the default environment "
+                    f"'{self.default_env}'"
+                )
+                self._handle_invalid_env(msg)
                 return
-            
+
             with open(self.env_file, 'r') as f:
                 for line in f:
                     line = line.strip()
@@ -67,12 +84,22 @@ def set_env_vars(self):
                         key = key.strip()
                         value = value.strip().strip('"').strip("'")
                         if key and not os.getenv(key):
-                            self._log(f"Setting environment variable: {key}")
+                            self._log(
+                                f"Setting environment variable: {key}"
+                            )
                             os.environ[key] = value
 
-            self._log(f"✅ Loaded AZD environment variables from: {self.default_env}")
+            msg = (
+                f"✅ Loaded AZD environment variables from: "
+                f"{self.default_env}"
+            )
+            self._log(msg)
         except Exception as e:
             if self.required:
                 raise e
             else:
-                self._log(f"⚠️  Warning: Failed to load AZD environment variables. {str(e)}")
+                msg = (
+                    f"⚠️  Warning: Failed to load AZD environment "
+                    f"variables. {str(e)}"
+                )
+                self._log(msg)