Filter warnings, configure logging, format

Author: simonkurtz-MSFT

shared/python/console.py

@@ -14,8 +14,8 @@
 import textwrap
 import threading
 
-from logging_config import ensure_configured
-
+from logging_config import configure_logging
+configure_logging()
 
 # ------------------------------
 #    CONSTANTS
@@ -122,7 +122,6 @@ def _print_log(message: str, prefix: str = '', color: str = '', output: str = ''
         blank_below (bool, optional): Whether to print a blank line below.
         wrap_lines (bool, optional): Whether to wrap lines to fit console width.
     """
-    ensure_configured()
 
     time_str = f' ⌚ {datetime.datetime.now().time()}' if show_time else ''
     output_str = f' {output}' if output else ''
@@ -167,9 +166,9 @@ def print_info(msg: str, blank_above: bool = False) -> None:
     """Print an informational message."""
     _print_log(msg, 'ℹ️ ', BOLD_B, blank_above = blank_above, level = logging.INFO)
 
-def print_message(msg: str, output: str = '', duration: str = '', blank_above: bool = False) -> None:
+def print_message(msg: str, output: str = '', duration: str = '', blank_above: bool = False, blank_below: bool = False) -> None:
     """Print a general message."""
-    _print_log(msg, 'ℹ️ ', BOLD_G, output, duration, True, blank_above, level = logging.INFO)
+    _print_log(msg, 'ℹ️ ', BOLD_G, output, duration, True, blank_above, blank_below, level = logging.INFO)
 
 def print_ok(msg: str, output: str = '', duration: str = '', blank_above: bool = False) -> None:
     """Print an OK/success message."""

shared/python/infrastructures.py

@@ -258,7 +258,7 @@ def deploy_infrastructure(self, is_update: bool = False) -> utils.Output:
             output = az.run(
                 f'az deployment group create --name {self.infra.value} --resource-group {self.rg_name} --template-file "{main_bicep_path}" --parameters "{params_file_path}" --query "properties.outputs"',
                 f"Deployment '{self.infra.value}' succeeded",
-                f"Deployment '{self.infra.value}' failed."
+                utils.get_deployment_failure_message(self.infra.value)
             )
 
             # ------------------------------

shared/python/logging_config.py

@@ -15,7 +15,6 @@
 import logging.config
 import os
 import threading
-import warnings
 from pathlib import Path
 from typing import Final
 
@@ -31,28 +30,7 @@
 _ENV_FILE_NAME: Final[str] = '.env'
 
 _config_lock = threading.Lock()
-_state: dict[str, bool] = {'configured': False, 'dotenv_loaded': False, 'warnings_configured': False}
-
-
-def _configure_warnings_once() -> None:
-    """Configure global warning filters once per process.
-
-    This keeps notebook output clean while remaining surgical: we only suppress a
-    single, well-known IPython message that is frequently triggered when a
-    `SystemExit` is raised in an interactive context.
-    """
-
-    with _config_lock:
-        if _state['warnings_configured']:
-            return
-        _state['warnings_configured'] = True
-
-    warnings.filterwarnings(
-        'ignore',
-        message=r"To exit: use 'exit', 'quit', or Ctrl-D\.",
-        category=UserWarning,
-        module=r'IPython\\.core\\.interactiveshell',
-    )
+_state: dict[str, bool] = {'configured': False, 'dotenv_loaded': False}
 
 
 def _find_env_file() -> Path | None:
@@ -179,13 +157,6 @@ def configure_logging(*, level: str | None = None, force: bool = False) -> None:
         _state['configured'] = True
 
 
-def ensure_configured() -> None:
-    """Ensure logging is configured (idempotent)."""
-
-    configure_logging(force=False)
-    _configure_warnings_once()
-
-
 def is_debug_enabled(logger: logging.Logger | None = None) -> bool:
     """Return True if DEBUG is enabled for the given logger (or root)."""
 

shared/python/utils.py

@@ -12,19 +12,48 @@
 import secrets
 import base64
 import inspect
+import warnings
 from pathlib import Path
 from typing import Any
 
 # APIM Samples imports
 import azure_resources as az
 from apimtypes import APIM_SKU, HTTP_VERB, INFRASTRUCTURE, Endpoints, Output, get_project_root
 from console import print_error, print_info, print_message, print_ok, print_plain, print_warning, print_val
+from logging_config import get_configured_level_name
+
+# Configure warning filter to suppress IPython exit warnings
+warnings.filterwarnings(
+    'ignore',
+    message = r"To exit: use 'exit', 'quit', or Ctrl-D\.",
+    category = UserWarning,
+    module = r'IPython\.core\.interactiveshell',
+)
 
 
 # ------------------------------
 #    HELPER FUNCTIONS
 # ------------------------------
 
+def get_deployment_failure_message(deployment_name: str) -> str:
+    """
+    Generate a deployment failure message that conditionally includes debug instruction.
+
+    Args:
+        deployment_name (str): The name of the failed deployment.
+
+    Returns:
+        str: Appropriate failure message based on current logging level.
+    """
+    base_message = f"Deployment '{deployment_name}' failed. View deployment details in Azure Portal."
+
+    # Only suggest enabling DEBUG logging if it's not already enabled
+    current_level = get_configured_level_name()
+    if current_level != 'DEBUG':
+        return f"{base_message} Enable DEBUG logging in workspace root .env file, then rerun to see details."
+
+    return base_message
+
 def build_infrastructure_tags(infrastructure: str | INFRASTRUCTURE, custom_tags: dict | None = None) -> dict:
     """
     Build standard tags for infrastructure resource groups, including required 'infrastructure' tag.
@@ -83,7 +112,7 @@ def __init__(self, rg_location: str, deployment: INFRASTRUCTURE, index: int, api
         self.index = index
         self.apim_sku = apim_sku
 
-        print_message('Initializing Infrastructure Notebook Helper with the following parameters:', blank_above=True)
+        print_message('Initializing Infrastructure Notebook Helper with the following parameters:', blank_above = True, blank_below = True)
         print_val('Location', self.rg_location)
         print_val('Infrastructure', self.deployment.value)
         print_val('Index', self.index)
@@ -166,7 +195,6 @@ def create_infrastructure(self, bypass_infrastructure_check: bool = False, allow
                     process.wait()
 
                     if process.returncode:
-                        print_error('Infrastructure creation failed!')
                         raise SystemExit(1)
 
                 return True
@@ -595,7 +623,7 @@ def create_bicep_deployment_group(rg_name: str, rg_location: str, deployment: st
         cmd += ' --debug'
 
     print_plain('\nDeploying bicep...\n')
-    return az.run(cmd, f"Deployment '{deployment_name}' succeeded", f"Deployment '{deployment_name}' failed.")
+    return az.run(cmd, f"Deployment '{deployment_name}' succeeded", get_deployment_failure_message(deployment_name))
 
 # TODO: Reconcile this with apimtypes.py get_project_root
 def find_project_root() -> str:
@@ -689,7 +717,7 @@ def _prompt_for_infrastructure_update(rg_name: str) -> tuple[bool, int | None]:
             - new_index: None if no index change, integer if user selected option 2
     """
     print_ok(f'Infrastructure already exists: {rg_name}')
-    print_plain('🔄 Infrastructure Update Options:\n')
+    print_plain('🔄 Infrastructure Update Options:\n', blank_above = True)
     print_plain('   This infrastructure notebook can update the existing infrastructure.')
     print_plain('   Updates are additive and will:')
     print_plain('   • Add new APIs and policy fragments defined in the infrastructure')
@@ -751,7 +779,7 @@ def does_infrastructure_exist(infrastructure: INFRASTRUCTURE, index: int, allow_
         print_ok(f'Infrastructure already exists: {rg_name}')
 
         if allow_update_option:
-            print_plain('🔄 Infrastructure Update Options:\n')
+            print_plain('🔄 Infrastructure Update Options:\n', blank_above = True)
             print_plain('   This infrastructure notebook can update the existing infrastructure. Updates are additive and will:\n')
             print_plain('   • Add new APIs and policy fragments defined in the infrastructure')
             print_plain('   • Update existing infrastructure components to match the template')

tests/python/test_logging_config.py

@@ -95,13 +95,3 @@ def test_should_print_traceback_from_env(level: str, expected: bool, monkeypatch
     monkeypatch.setenv('APIM_SAMPLES_LOG_LEVEL', level)
 
     assert logging_config.should_print_traceback() is expected
-
-
-def test_configure_warnings_once_is_idempotent(monkeypatch: pytest.MonkeyPatch) -> None:
-    mock_filter = Mock()
-    monkeypatch.setattr(logging_config.warnings, 'filterwarnings', mock_filter)
-
-    logging_config._configure_warnings_once()
-    logging_config._configure_warnings_once()
-
-    mock_filter.assert_called_once()