Merge pull request #237 from Radio-Spectrum/hotfix/logging_facility

fix(simulation): Fixed simulator log facility setup

Author: artistrea

sharc/main_cli.py

@@ -7,9 +7,9 @@
 
 import os
 import sys
-import getopt
+import argparse
 
-from sharc.support.sharc_logger import Logging, SimulationLogger
+from sharc.support.sharc_logger import setup_logging, SimulationLogger
 from sharc.controller import Controller
 from sharc.gui.view_cli import ViewCli
 from sharc.model import Model
@@ -34,28 +34,25 @@ def main(argv):
 
     param_file = ""
 
-    try:
-        opts, _ = getopt.getopt(argv, "hp:")
-    except getopt.GetoptError:
-        print("usage: main_cli.py -p <param_file>")
-        sys.exit(2)
-
-    if not opts:
-        param_file = os.path.join(os.getcwd(), "input", "parameters.yaml")
-    else:
-        for opt, arg in opts:
-            if opt == "-h":
-                print("usage: main_cli.py -p <param_file>")
-                sys.exit()
-            elif opt == "-p":
-                param_file = os.path.join(os.getcwd(), arg)
+    parser = argparse.ArgumentParser(description="SHARC - Radio Sharing and Compatiblity Monte Carlo Simulator")
+    parser.add_argument("-p", "--param-file", default=os.path.join(os.getcwd(), "input", "parameters.yaml"),
+                        help="Path to parameter file (default: input/parameters.yaml)")
+    parser.add_argument("-l", "--log-file", default=None,
+                        help="Path to output log file (optional)")
+
+    args = parser.parse_args(argv)
+    param_file = os.path.join(os.getcwd(), args.param_file) if not os.path.isabs(args.param_file) else args.param_file
+
+    log_file = None
+    if args.log_file is not None:
+        log_file = os.path.join(os.getcwd(), args.log_file) if not os.path.isabs(args.log_file) else args.log_file
+
+    setup_logging(log_file=log_file)
 
     # Logger setup start
     sim_logger = SimulationLogger(param_file)
     sim_logger.start()
 
-    Logging.setup_logging()
-
     model = Model()
     view_cli = ViewCli()
     controller = Controller()

sharc/support/logging.yaml

@@ -2,33 +2,41 @@
 import os
 import sys
 import yaml
-import logging
+import logging.config
 import subprocess
 from pathlib import Path
 from datetime import datetime
-from typing import Optional
-
-
-class Logging:
-    """Logging utility class for configuring application logging."""
-
-    @staticmethod
-    def setup_logging(
-        default_path="support/logging.yaml",
-        default_level=logging.INFO,
-        env_key="LOG_CFG",
-    ):
-        """Set up logging configuration for the application."""
-        path = default_path
-        value = os.getenv(env_key, None)
-        if value:
-            path = value
-        if os.path.exists(path):
-            with open(path, "rt") as f:
-                config = yaml.safe_load(f.read())
-            logging.config.dictConfig(config)
-        else:
-            logging.basicConfig(level=default_level)
+from typing import Optional, List
+
+level_mapping = logging.getLevelNamesMapping()
+
+
+def setup_logging(log_file=None, default_level="INFO"):
+    """Setup logging configuration for the root logger.
+
+    Run this function in the beginning of the simulation to setup the root logger.
+    """
+
+    try:
+        level = level_mapping[default_level]
+    except KeyError:
+        raise ValueError("Invalid log level option {}".format(default_level))
+
+    root_logger = logging.getLogger()
+    root_logger.setLevel(level)
+    formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+    root_logger.handlers = []
+
+    # Stream to stdout
+    handler = logging.StreamHandler(sys.stdout)
+    handler.setFormatter(formatter)
+    root_logger.addHandler(handler)
+
+    # Stream to file if specified
+    if log_file is not None:
+        file_handler = logging.FileHandler(log_file)
+        file_handler.setFormatter(formatter)
+        root_logger.addHandler(file_handler)
 
 
 class SimulationLogger:
@@ -102,7 +110,7 @@ def _find_root_dir(self, folder_name: str) -> Optional[Path]:
                 return parent
         return None
 
-    def _run_git_cmd(self, args: list[str]) -> Optional[str]:
+    def _run_git_cmd(self, args: List[str]) -> Optional[str]:
         try:
             return (
                 subprocess.check_output(["git"] + args, stderr=subprocess.DEVNULL)
@@ -132,7 +140,7 @@ def _get_invocation_command(self) -> str:
     def _get_python_version(self) -> str:
         return sys.version.replace("\n", " ")
 
-    def _get_installed_packages(self) -> list[str]:
+    def _get_installed_packages(self) -> List[str]:
         try:
             output = subprocess.check_output(
                 [sys.executable, "-m", "pip", "freeze"], stderr=subprocess.DEVNULL