Refactor logging mechanism to encapsulate console logging behavior and improve logger initialization

Author: grongierisc

src/iop/_common.py

@@ -17,7 +17,19 @@ class _Common(metaclass=abc.ABCMeta):
     INFO_URL: ClassVar[str]
     ICON_URL: ClassVar[str]
     iris_handle: Any = None
-    log_to_console: bool = False
+    _log_to_console: bool = False
+
+    @property
+    def log_to_console(self) -> bool:
+        return self._log_to_console
+    
+    @log_to_console.setter
+    def log_to_console(self, value: bool) -> None:
+        self._log_to_console = value
+        self.logger = LogManager.get_logger(self.__class__.__name__,value)
+
+    def __init__(self):
+        self.logger = LogManager.get_logger(self.__class__.__name__)
 
     # Lifecycle methods
     def on_init(self) -> None:
@@ -172,7 +184,7 @@ def _get_properties(cls) -> List[List[Any]]:
         except:
             pass
         return ret
-    
+
     # Logging methods
     def _log(self) -> Tuple[str, Optional[str]]:
         """Get class and method name for logging.
@@ -189,15 +201,27 @@ def _log(self) -> Tuple[str, Optional[str]]:
             pass
         return current_class, current_method
 
-    @property
-    def logger(self) -> logging.Logger:
-        """Get a logger instance for this component.
+    def _logging(self, message: str, level: int, to_console: Optional[bool] = None) -> None:
+        """Write log entry.
         
-        Returns:
-            Logger configured for IRIS integration
+        Args:
+            message: Message to log
+            level: Log level
+            to_console: If True, log to console instead of IRIS
         """
-        class_name, method_name = self._log()
-        return LogManager.get_logger(class_name, method_name, self.log_to_console)
+        current_class, current_method = self._log()
+        if to_console is None:
+            to_console = self.log_to_console
+        if level == logging.DEBUG:
+            self.logger.debug(message, extra={'to_console': to_console, 'class_name': current_class, 'method_name': current_method})
+        elif level == logging.INFO:
+            self.logger.info(message, extra={'to_console': to_console, 'class_name': current_class, 'method_name': current_method})
+        elif level == logging.CRITICAL:
+            self.logger.critical(message, extra={'to_console': to_console, 'class_name': current_class, 'method_name': current_method})
+        elif level == logging.WARNING:
+            self.logger.warning(message, extra={'to_console': to_console, 'class_name': current_class, 'method_name': current_method})
+        elif level == logging.ERROR:
+            self.logger.error(message, extra={'to_console': to_console, 'class_name': current_class, 'method_name': current_method})
 
     def trace(self, message: str, to_console: Optional[bool] = None) -> None:
         """Write trace log entry.
@@ -206,8 +230,7 @@ def trace(self, message: str, to_console: Optional[bool] = None) -> None:
             message: Message to log
             to_console: If True, log to console instead of IRIS
         """
-        self.logger.debug(message, extra={'to_console': to_console})
-
+        self._logging(message, logging.DEBUG, to_console)
 
     def log_info(self, message: str, to_console: Optional[bool] = None) -> None:
         """Write info log entry.
@@ -216,7 +239,7 @@ def log_info(self, message: str, to_console: Optional[bool] = None) -> None:
             message: Message to log
             to_console: If True, log to console instead of IRIS
         """
-        self.logger.info(message, extra={'to_console': to_console})
+        self._logging(message, logging.INFO, to_console)
 
     def log_alert(self, message: str, to_console: Optional[bool] = None) -> None:
         """Write alert log entry.
@@ -225,7 +248,7 @@ def log_alert(self, message: str, to_console: Optional[bool] = None) -> None:
             message: Message to log
             to_console: If True, log to console instead of IRIS
         """
-        self.logger.critical(message, extra={'to_console': to_console})
+        self._logging(message, logging.CRITICAL, to_console)
 
     def log_warning(self, message: str, to_console: Optional[bool] = None) -> None:
         """Write warning log entry.
@@ -234,7 +257,7 @@ def log_warning(self, message: str, to_console: Optional[bool] = None) -> None:
             message: Message to log
             to_console: If True, log to console instead of IRIS
         """
-        self.logger.warning(message, extra={'to_console': to_console})
+        self._logging(message, logging.WARNING, to_console)
 
     def log_error(self, message: str, to_console: Optional[bool] = None) -> None:
         """Write error log entry.
@@ -243,7 +266,7 @@ def log_error(self, message: str, to_console: Optional[bool] = None) -> None:
             message: Message to log
             to_console: If True, log to console instead of IRIS
         """
-        self.logger.error(message, extra={'to_console': to_console})
+        self._logging(message, logging.ERROR, to_console)
 
     def log_assert(self, message: str) -> None:
         """Write a log entry of type "assert". Log entries can be viewed in the management portal.

src/iop/_log_manager.py

@@ -1,3 +1,4 @@
+import traceback
 import iris
 import logging
 from typing import Optional, Tuple
@@ -6,7 +7,7 @@ class LogManager:
     """Manages logging integration between Python's logging module and IRIS."""
 
     @staticmethod
-    def get_logger(class_name: str, method_name: Optional[str] = None, to_console: bool = False) -> logging.Logger:
+    def get_logger(class_name: str, to_console: bool = False) -> logging.Logger:
         """Get a logger instance configured for IRIS integration.
         
         Args:
@@ -17,11 +18,11 @@ def get_logger(class_name: str, method_name: Optional[str] = None, to_console: b
         Returns:
             Logger instance configured for IRIS integration
         """
-        logger = logging.getLogger(f"{class_name}.{method_name}" if method_name else class_name)
+        logger = logging.Logger(f"{class_name}")
 
         # Only add handler if none exists
         if not logger.handlers:
-            handler = IRISLogHandler(class_name, method_name, to_console)
+            handler = IRISLogHandler(to_console=to_console)
             formatter = logging.Formatter('%(message)s')
             handler.setFormatter(formatter)
             logger.addHandler(handler)
@@ -33,17 +34,9 @@ def get_logger(class_name: str, method_name: Optional[str] = None, to_console: b
 class IRISLogHandler(logging.Handler):
     """Custom logging handler that routes Python logs to IRIS logging system."""
 
-    def __init__(self, class_name: str, method_name: Optional[str] = None, to_console: bool = False):
-        """Initialize the handler with context information.
-        
-        Args:
-            class_name: Name of the class logging the message
-            method_name: Optional name of the method logging the message
-            console: If True, log to the console instead of IRIS
-        """
+    def __init__(self, to_console: bool = False):
+        """Initialize the IRIS logging handler."""
         super().__init__()
-        self.class_name = class_name
-        self.method_name = method_name
         self.to_console = to_console
 
         # Map Python logging levels to IRIS logging methods
@@ -80,10 +73,11 @@ def emit(self, record: logging.LogRecord) -> None:
         Args:
             record: The logging record to emit
         """
-
-        log_func = self.level_map.get(record.levelno, iris.cls("Ens.Util.Log").LogInfo)
+        class_name = record.class_name if hasattr(record, "class_name") else record.name
+        method_name = record.method_name if hasattr(record, "method_name") else record.funcName
         if self.to_console or (hasattr(record, "to_console") and record.to_console):
             iris.cls("%SYS.System").WriteToConsoleLog(self.format(record),
-                0,self.level_map_console.get(record.levelno, 0),record.name)
+                0,self.level_map_console.get(record.levelno, 0),class_name+"."+method_name)
         else:
-            log_func(self.class_name, self.method_name, self.format(record))
+            log_func = self.level_map.get(record.levelno, iris.cls("Ens.Util.Log").LogInfo)
+            log_func(class_name, method_name, self.format(record))

src/tests/test_commun.py

@@ -45,6 +45,20 @@ def test_is_iris_object_instance(self):
         assert is_iris_object_instance(msg_job) == False
 
 class TestLogging:
+
+    def test_log_info_loggger(self, common, random_string):
+        common.logger.info(random_string)
+        rs = self._check_log_entry(random_string, 'test_log_info_loggger')
+        assert len(rs) == 1
+
+    def test_log_info_loggger_to_console(self, common, random_string):
+        common.log_to_console = True
+        common.logger.info(random_string)
+
+        with open(MESSAGE_LOG_PATH, 'r') as file:
+            last_line = file.readlines()[-1]
+            assert random_string in last_line
+
     def test_log_info_to_console(self, common, random_string):
         common.log_to_console = True
         common.log_info(random_string)