add better cli dashboard

Author: HenriqueAssumpcao

src/codeevolve/cli.py

@@ -73,11 +73,6 @@ def parse_args() -> argparse.Namespace:
         default=0,
         help="Checkpoint to load: 0 for new run, -1 for latest, or specific epoch number",
     )
-    parser.add_argument(
-        "--terminal_logging",
-        action="store_true",
-        help="Enable dynamic log display from all islands in terminal",
-    )
     parser.add_argument(
         "--y",
         action="store_true",

src/codeevolve/runner.py

@@ -25,7 +25,7 @@
 from codeevolve.islands.sync import GlobalSyncData
 from codeevolve.utils.constants import CRASH_LOG_FILE
 from codeevolve.utils.lock import DirectoryLock
-from codeevolve.utils.logging import cli_logger
+from codeevolve.utils.logging import DashboardShutdown, ShutdownReason, cli_dashboard
 
 # ---------------------------------------------------------------------------
 # Global cleanup state for signal handlers
@@ -93,7 +93,7 @@ def _cleanup_on_signal(signum: int, frame: Any) -> None:
     log_queue: Optional[mp.Queue] = _cleanup_state["log_queue"]
     if log_daemon and log_daemon.is_alive():
         if log_queue:
-            log_queue.put(None)
+            log_queue.put(DashboardShutdown(reason=ShutdownReason.INTERRUPTED))
         log_daemon.join(timeout=2.0)
         if log_daemon.is_alive():
             log_daemon.terminate()
@@ -220,7 +220,7 @@ def start_log_daemon(
         return None
 
     log_daemon: mp.Process = mp.Process(
-        target=cli_logger,
+        target=cli_dashboard,
         args=(args, global_data, global_data.log_queue, num_islands),
         daemon=True,
     )
@@ -231,20 +231,25 @@ def start_log_daemon(
 def cleanup_log_daemon(
     log_daemon: Optional[mp.Process],
     log_queue: mp.Queue,
+    shutdown: Optional[DashboardShutdown] = None,
     timeout: float = 2.0,
 ) -> None:
     """Shuts down the log daemon process.
 
-    Sends a sentinel value to signal shutdown, waits for termination,
-    and force-terminates if necessary.
+    Sends a :class:`~codeevolve.utils.logging.DashboardShutdown` sentinel to
+    signal shutdown, waits for termination, and force-terminates if necessary.
 
     Args:
         log_daemon: The logging daemon process to shut down (may be None).
         log_queue: Queue to send shutdown signal through.
+        shutdown: Shutdown context forwarded to the dashboard so it can render
+            the appropriate final banner.  Defaults to
+            ``DashboardShutdown(ShutdownReason.FINISHED)`` when not provided.
         timeout: Maximum seconds to wait for shutdown.
     """
     if log_daemon and log_daemon.is_alive():
-        log_queue.put(None)
+        sentinel = shutdown if shutdown is not None else DashboardShutdown(reason=ShutdownReason.FINISHED)
+        log_queue.put(sentinel)
         log_daemon.join(timeout=timeout)
         if log_daemon.is_alive():
             log_daemon.terminate()
@@ -354,20 +359,21 @@ def monitor_island_processes(
                     completed[i] = True
 
                     if process.exitcode != 0:
-                        cleanup_log_daemon(log_daemon, global_data.log_queue)
-
                         error_msg: str = (
                             f"Island {i} died unexpectedly with exit code {process.exitcode}"
                         )
+                        crash_log_path: str = str(out_dir / CRASH_LOG_FILE.format(time=time))
                         _write_crash_summary(out_dir, i, process.exitcode, error_msg, time)
 
-                        print(f"\n{'=' * 46} ERROR {'=' * 47}", file=sys.stderr)
-                        print(f"{error_msg}", file=sys.stderr)
-                        print(
-                            f"See {out_dir}/{CRASH_LOG_FILE.format(time=time)} and island logs for details.",
-                            file=sys.stderr,
+                        cleanup_log_daemon(
+                            log_daemon,
+                            global_data.log_queue,
+                            DashboardShutdown(
+                                reason=ShutdownReason.ERROR,
+                                error_msg=error_msg,
+                                crash_log_path=crash_log_path,
+                            ),
                         )
-                        print(f"{'='*100}\n", file=sys.stderr)
 
                         other_processes: List[mp.Process] = [
                             other_process
@@ -378,12 +384,19 @@ def monitor_island_processes(
 
                         return 1
 
-        cleanup_log_daemon(log_daemon, global_data.log_queue)
-        print("=" * 45 + " FINISHED " + "=" * 45)
+        cleanup_log_daemon(
+            log_daemon,
+            global_data.log_queue,
+            DashboardShutdown(reason=ShutdownReason.FINISHED),
+        )
         return 0
 
     except KeyboardInterrupt:
-        cleanup_log_daemon(log_daemon, global_data.log_queue)
+        cleanup_log_daemon(
+            log_daemon,
+            global_data.log_queue,
+            DashboardShutdown(reason=ShutdownReason.INTERRUPTED),
+        )
 
         _terminate_processes(processes)
 

src/codeevolve/utils/logging.py

@@ -16,12 +16,45 @@
 import re
 import time
 from collections import deque
+from dataclasses import dataclass, field
+from enum import Enum, auto
 from pathlib import Path
 from typing import Any, Dict, Optional
 
 from codeevolve.islands.sync import GlobalSyncData
 from codeevolve.utils.constants import ASCII_NAME, DEFAULT_MAX_LOG_MSG_SIZE, ISLAND_LOG_FILE
 
+# ---------------------------------------------------------------------------
+# Dashboard shutdown signalling
+# ---------------------------------------------------------------------------
+
+
+class ShutdownReason(Enum):
+    """Reason why the CLI dashboard is being shut down."""
+
+    FINISHED = auto()
+    ERROR = auto()
+    INTERRUPTED = auto()
+
+
+@dataclass
+class DashboardShutdown:
+    """Sentinel message sent to the dashboard queue to trigger a clean shutdown.
+
+    Replaces the bare ``None`` sentinel so the dashboard can render an
+    appropriate final banner depending on *why* it is being stopped.
+
+    Attributes:
+        reason: The high-level cause of shutdown.
+        error_msg: Human-readable error summary (populated for ERROR reason).
+        crash_log_path: Path to the crash log file (populated for ERROR reason).
+    """
+
+    reason: ShutdownReason
+    error_msg: Optional[str] = field(default=None)
+    crash_log_path: Optional[str] = field(default=None)
+
+
 # ---------------------------------------------------------------------------
 # Time formatting utilities
 # ---------------------------------------------------------------------------
@@ -235,7 +268,7 @@ def get_logger(
 
 
 # ---------------------------------------------------------------------------
-# CLI dashboard logger
+# CLI dashboard
 # ---------------------------------------------------------------------------
 
 
@@ -262,7 +295,7 @@ def _print_global_status(args: Dict[str, Any], global_data: GlobalSyncData) -> N
     print(f"> GLOBAL EARLY STOPPING COUNTER = {global_data.early_stop_counter.value}")
 
 
-def cli_logger(
+def cli_dashboard(
     args: Dict[str, Any],
     global_data: GlobalSyncData,
     queue: mp.Queue,
@@ -276,6 +309,13 @@ def cli_logger(
     and display them in a continuously updating console dashboard showing the status
     of each island and global progress.
 
+    Shutdown is triggered by placing a :class:`DashboardShutdown` message on the
+    queue.  The ``reason`` field controls which final banner is rendered:
+
+    * ``FINISHED``    — normal algorithm completion
+    * ``ERROR``       — an island crashed; ``error_msg`` and ``crash_log_path`` are shown
+    * ``INTERRUPTED`` — the run was cancelled by the user or a signal
+
     Args:
         args: Dictionary containing command-line arguments and configuration.
         global_data: Shared data structure containing global algorithm state.
@@ -293,9 +333,20 @@ def cli_logger(
     while True:
         while not queue.empty():
             message = queue.get_nowait()
-            if message is None:
+            if isinstance(message, DashboardShutdown):
                 os.system("cls" if os.name == "nt" else "clear")
                 _print_global_status(args, global_data)
+                if message.reason == ShutdownReason.FINISHED:
+                    print("=" * 45 + " FINISHED " + "=" * 45)
+                elif message.reason == ShutdownReason.ERROR:
+                    print(f"\n{'=' * 46} ERROR {'=' * 47}")
+                    if message.error_msg:
+                        print(message.error_msg)
+                    if message.crash_log_path:
+                        print(f"See {message.crash_log_path} and island logs for details.")
+                    print("=" * 100)
+                elif message.reason == ShutdownReason.INTERRUPTED:
+                    print("=" * 43 + " INTERRUPTED " + "=" * 44)
                 return
 
             match = island_id_pattern.search(message)

tests/test_logging.py

@@ -11,13 +11,20 @@
 # ===--------------------------------------------------------------------------------------===#
 
 import logging
+import multiprocessing as mp
+import threading
+import time
 from pathlib import Path
-from typing import Optional
+from typing import Any, Dict, Optional
+from unittest.mock import MagicMock, patch
 
 import pytest
 
 from codeevolve.utils.logging import (
+    DashboardShutdown,
+    ShutdownReason,
     SizeLimitedFormatter,
+    cli_dashboard,
     format_elapsed_time,
     get_logger,
 )
@@ -154,3 +161,51 @@ def test_logger_unique_names(self, tmp_path: Path):
         logger1: logging.Logger = get_logger(island_id=0, logs_dir=dir1)
         logger2: logging.Logger = get_logger(island_id=1, logs_dir=dir2)
         assert logger1.name != logger2.name
+
+
+# ---------------------------------------------------------------------------
+# DashboardShutdown
+# ---------------------------------------------------------------------------
+
+
+class TestDashboardShutdown:
+    """Test suite for the DashboardShutdown dataclass and ShutdownReason enum."""
+
+    def test_finished_defaults(self):
+        """Tests that FINISHED shutdown has None error fields by default."""
+        shutdown: DashboardShutdown = DashboardShutdown(reason=ShutdownReason.FINISHED)
+        assert shutdown.reason == ShutdownReason.FINISHED
+        assert shutdown.error_msg is None
+        assert shutdown.crash_log_path is None
+
+    def test_interrupted_defaults(self):
+        """Tests that INTERRUPTED shutdown has None error fields by default."""
+        shutdown: DashboardShutdown = DashboardShutdown(reason=ShutdownReason.INTERRUPTED)
+        assert shutdown.reason == ShutdownReason.INTERRUPTED
+        assert shutdown.error_msg is None
+        assert shutdown.crash_log_path is None
+
+    def test_error_with_details(self):
+        """Tests that ERROR shutdown carries error_msg and crash_log_path."""
+        shutdown: DashboardShutdown = DashboardShutdown(
+            reason=ShutdownReason.ERROR,
+            error_msg="Island 1 died unexpectedly",
+            crash_log_path="/out/crash_42.log",
+        )
+        assert shutdown.reason == ShutdownReason.ERROR
+        assert shutdown.error_msg == "Island 1 died unexpectedly"
+        assert shutdown.crash_log_path == "/out/crash_42.log"
+
+    def test_error_partial_fields(self):
+        """Tests that ERROR shutdown can be created with only some fields set."""
+        shutdown: DashboardShutdown = DashboardShutdown(
+            reason=ShutdownReason.ERROR,
+            error_msg="crash",
+        )
+        assert shutdown.error_msg == "crash"
+        assert shutdown.crash_log_path is None
+
+    def test_all_reasons_are_distinct(self):
+        """Tests that each ShutdownReason value is distinct."""
+        reasons = {ShutdownReason.FINISHED, ShutdownReason.ERROR, ShutdownReason.INTERRUPTED}
+        assert len(reasons) == 3