feat: add nocolor logging config, simplify logging init, remove circular import

Add log.nocolor config field and move logging init logic into
LogConfig.init_logging() so the config object encapsulates its own setup.
This simplifies _init_logging() in __main__.py from 6 lines to 2.

Break the circular dependency between log_utils and config by making
print_horizontal_line accept explicit show/width params instead of
importing Config internally. Remove horizontal_line_width config field
in favor of a fixed 80-column width.

Author: Yiannis128

esbmc_ai/__main__.py

@@ -3,7 +3,6 @@
 # Author: Yiannis Charalambous 2023
 
 import json
-import logging
 import sys
 from time import perf_counter
 
@@ -19,7 +18,7 @@
 from esbmc_ai.addon_loader import AddonLoader
 from esbmc_ai.base_component import BaseComponent
 from esbmc_ai.command_result import CommandResult
-from esbmc_ai.log_utils import LogCategories, get_log_level, init_logging
+from esbmc_ai.log_utils import LogCategories
 from esbmc_ai.verifiers import BaseSourceVerifier, ESBMC, CommandOracle
 from esbmc_ai.component_manager import ComponentManager
 import esbmc_ai.commands
@@ -140,16 +139,8 @@ def _init_builtin_components() -> None:
 
 
 def _init_logging() -> None:
-    # Add logging handlers with config options
     config = Config()
-    logging_handlers: list[logging.Handler] = config.log.logging_handlers
-
-    # Reinit logging
-    init_logging(
-        level=get_log_level(config.verbose_level),
-        file_handlers=logging_handlers,
-        init_basic=config.log.basic,
-    )
+    config.log.init_logging(config.verbose_level)
 
 
 def main() -> None:

esbmc_ai/commands/help_config.py

@@ -147,7 +147,10 @@ def execute(self) -> CommandResult | None:
 
         from esbmc_ai.log_utils import print_horizontal_line
 
-        print_horizontal_line()
+        config = Config()
+        hl_kwargs = dict(show=config.show_horizontal_lines)
+
+        print_horizontal_line(**hl_kwargs)
 
         # Get component manager to access builtin and addon components
         component_manager = ComponentManager()
@@ -158,7 +161,7 @@ def execute(self) -> CommandResult | None:
             dict(component_manager.builtin_components),
         )
 
-        print_horizontal_line()
+        print_horizontal_line(**hl_kwargs)
 
         # Print addon component config fields
         self._print_components_section(

esbmc_ai/config.py

@@ -114,6 +114,21 @@ class LogConfig(BaseModel):
         "noisy libs.",
     )
 
+    nocolor: bool = Field(
+        default=False,
+        description="Disable color output in the logger.",
+    )
+
+    def init_logging(self, verbose_level: int) -> None:
+        from esbmc_ai.log_utils import get_log_level, init_logging
+
+        init_logging(
+            level=get_log_level(verbose_level),
+            file_handlers=self.logging_handlers,
+            init_basic=self.basic,
+            nocolor=self.nocolor,
+        )
+
     @property
     def logging_handlers(self) -> list[logging.Handler]:
         logging_handlers: list[logging.Handler] = []
@@ -445,13 +460,6 @@ def on_set_addon_modules(cls, mods: list[str]) -> list[str]:
         "Makes it easier to read.",
     )
 
-    horizontal_line_width: int | None = Field(
-        default=None,
-        validation_alias="horizontal_line_width",
-        description="Sets the width of the horizontal lines to draw. "
-        "Don't set a value to use the terminal width. Needs to have "
-        "show_horizontal_lines set to true.",
-    )
 
     ai_custom: dict[str, AICustomModelConfig] = Field(
         default_factory=defaultdict,

esbmc_ai/log_utils.py

@@ -3,7 +3,6 @@
 """Horizontal line logging integrated with Structlog."""
 
 from enum import Enum
-from os import get_terminal_size
 import logging
 import structlog
 from structlog.typing import EventDict
@@ -36,6 +35,7 @@ def _init_logging_basic(
     *,
     level: int,
     logging_format: str = _logging_format,
+    nocolor: bool = False,
 ) -> None:
     """Initializes the logging system in basic mode, good for debugging since
     it can easily change the logging_format."""
@@ -46,7 +46,7 @@ def _init_logging_basic(
             structlog.processors.add_log_level,
             _add_category_field,
             _render_prefix_category_to_event,
-            structlog.dev.ConsoleRenderer(),
+            structlog.dev.ConsoleRenderer(colors=not nocolor),
         ],
         wrapper_class=structlog.stdlib.BoundLogger,
         logger_factory=structlog.stdlib.LoggerFactory(),
@@ -66,6 +66,7 @@ def init_logging(
     level: int,
     file_handlers: list[logging.Handler] = [],
     init_basic: bool = False,
+    nocolor: bool = False,
 ) -> None:
     """Initializes the logging system.
 
@@ -95,7 +96,7 @@ def init_logging(
 
     # Use the basic unformatted logger instead.
     if init_basic:
-        _init_logging_basic(level=level)
+        _init_logging_basic(level=level, nocolor=nocolor)
         return
 
     structlog.configure(
@@ -116,7 +117,7 @@ def init_logging(
         structlog.stdlib.ProcessorFormatter(
             processors=[
                 _filter_keys_processor,
-                structlog.dev.ConsoleRenderer(),
+                structlog.dev.ConsoleRenderer(colors=not nocolor),
             ]
         )
     )
@@ -154,17 +155,17 @@ def print_horizontal_line(
     *,
     char: str = "=",
     category: Enum | str = LogCategories.ALL,
-    width: int | None = None,
+    show: bool = True,
     logger: structlog.stdlib.BoundLogger | None = None,
 ) -> None:
     """
     Print a horizontal line if logging is enabled for the specified level. Both
-    an int of the level or the verbose name could be surprised.
-    """
-    # Import Config locally to avoid circular import
-    from esbmc_ai.config import Config
+    an int of the level or the verbose name could be supplied.
 
-    if not Config().show_horizontal_lines:
+    Args:
+        show: Whether to actually print. Pass Config().show_horizontal_lines.
+    """
+    if not show:
         return
 
     # Convert level name to numeric value (e.g., "info" -> logging.INFO)
@@ -174,26 +175,11 @@ def print_horizontal_line(
         else level
     )
 
-    # Determine line width
-    line_width: int
-    if width is not None:
-        line_width = width
-
-    else:
-        config_hlw: int | None = Config().horizontal_line_width
-        if config_hlw is not None:
-            line_width = config_hlw
-        else:
-            try:
-                line_width = get_terminal_size().columns
-            except OSError:
-                line_width = 80 - _largest_cat_len
-
     if logger is None:
         logger = structlog.get_logger()
         assert logger is not None
 
-    logger.log(level=level_no, event=char * line_width, category=category)
+    logger.log(level=level_no, event=char * 80, category=category)
 
 
 def _render_prefix_category_to_event(