Improve CLI logging

Author: jsurrea

antares-python/src/antares/cli.py

@@ -1,79 +1,112 @@
+import sys
 import asyncio
-
+import json
 import typer
+import logging
 from rich.console import Console
 from rich.theme import Theme
 
-from antares import AntaresClient, ShipConfig
+from antares import ShipConfig, AntaresClient
 from antares.config_loader import load_config
-
-app = typer.Typer(help="Antares Simulation CLI")
-
-console = Console(
-    theme=Theme(
-        {
-            "info": "green",
-            "warn": "yellow",
-            "error": "bold red",
-        }
-    )
+from antares.errors import (
+    ConnectionError,
+    SimulationError,
+    SubscriptionError
 )
-
-
-def build_client(config_path: str | None, verbose: bool) -> AntaresClient:
-    settings = load_config(config_path)
-
-    if verbose:
-        console.print(f"[info]Using settings: {settings.model_dump()}")
-
-    return AntaresClient(
-        base_url=settings.base_url,
-        tcp_host=settings.tcp_host,
-        tcp_port=settings.tcp_port,
-        timeout=settings.timeout,
-        auth_token=settings.auth_token,
-    )
+from antares.logger import setup_logging
+
+app = typer.Typer(name="antares", help="Antares CLI for ship simulation")
+console = Console(theme=Theme({
+    "info": "green",
+    "warn": "yellow",
+    "error": "bold red"
+}))
+
+
+def handle_error(message: str, code: int, json_output: bool = False):
+    logger = logging.getLogger("antares.cli")
+    if json_output:
+        typer.echo(json.dumps({"error": message}), err=True)
+    else:
+        console.print(f"[error]{message}")
+    logger.error("Exiting with error: %s", message)
+    raise typer.Exit(code)
+
+
+def build_client(config_path: str | None, verbose: bool, json_output: bool) -> AntaresClient:
+    setup_logging(level=logging.DEBUG if verbose else logging.INFO)
+    logger = logging.getLogger("antares.cli")
+
+    try:
+        settings = load_config(config_path)
+        if verbose:
+            console.print(f"[info]Using settings: {settings.model_dump()}")
+            logger.debug("Loaded settings: %s", settings.model_dump())
+        return AntaresClient(
+            base_url=settings.base_url,
+            tcp_host=settings.tcp_host,
+            tcp_port=settings.tcp_port,
+            timeout=settings.timeout,
+            auth_token=settings.auth_token,
+        )
+    except Exception as e:
+        handle_error(f"Failed to load configuration: {e}", code=1, json_output=json_output)
 
 
 @app.command()
 def reset(
-    config: str = typer.Option(None, help="Path to config TOML file"),
+    config: str = typer.Option(None),
     verbose: bool = typer.Option(False, "--verbose", "-v"),
+    json_output: bool = typer.Option(False, "--json", help="Output in JSON format")
 ):
-    """Reset the simulation."""
-    client = build_client(config, verbose)
-    client.reset_simulation()
-    console.print("[info]✅ Simulation reset.")
+    client = build_client(config, verbose, json_output)
+    try:
+        client.reset_simulation()
+        msg = "✅ Simulation reset."
+        typer.echo(json.dumps({"message": msg}) if json_output else msg)
+    except (ConnectionError, SimulationError) as e:
+        handle_error(str(e), code=2, json_output=json_output)
 
 
 @app.command()
 def add_ship(
     x: float,
     y: float,
-    config: str = typer.Option(None, help="Path to config TOML file"),
+    config: str = typer.Option(None),
     verbose: bool = typer.Option(False, "--verbose", "-v"),
+    json_output: bool = typer.Option(False, "--json", help="Output in JSON format")
 ):
-    """Add a ship to the simulation at (x, y)."""
-    client = build_client(config, verbose)
-    ship = ShipConfig(initial_position=(x, y))
-    client.add_ship(ship)
-    console.print(f"[info]🚢 Added ship at ({x}, {y})")
+    client = build_client(config, verbose, json_output)
+    try:
+        ship = ShipConfig(initial_position=(x, y))
+        client.add_ship(ship)
+        msg = f"🚢 Added ship at ({x}, {y})"
+        typer.echo(json.dumps({"message": msg}) if json_output else msg)
+    except (ConnectionError, SimulationError) as e:
+        handle_error(str(e), code=2, json_output=json_output)
 
 
 @app.command()
 def subscribe(
-    config: str = typer.Option(None, help="Path to config TOML file"),
+    config: str = typer.Option(None),
     verbose: bool = typer.Option(False, "--verbose", "-v"),
+    json_output: bool = typer.Option(False, "--json", help="Output in JSON format"),
+    log_file: str = typer.Option("antares.log", help="Path to log file")
 ):
-    """Subscribe to simulation data stream."""
-    client = build_client(config, verbose)
+    setup_logging(log_file=log_file, level=logging.DEBUG if verbose else logging.INFO)
+    logger = logging.getLogger("antares.cli")
+
+    client = build_client(config, verbose, json_output)
 
     async def _sub():
-        async for event in client.subscribe():
-            console.print_json(data=event)
+        try:
+            async for event in client.subscribe():
+                if json_output:
+                    typer.echo(json.dumps(event))
+                else:
+                    console.print_json(data=event)
+                logger.debug("Received event: %s", event)
+        except SubscriptionError as e:
+            handle_error(str(e), code=3, json_output=json_output)
 
     asyncio.run(_sub())
-
-
-if __name__ == "__main__":
-    app()

antares-python/src/antares/logger.py

@@ -0,0 +1,17 @@
+import logging
+from pathlib import Path
+from rich.logging import RichHandler
+
+def setup_logging(log_file: str = "antares.log", level: int = logging.INFO) -> None:
+    """Configure logging to both rich console and a file."""
+    Path(log_file).parent.mkdir(parents=True, exist_ok=True)
+
+    logging.basicConfig(
+        level=level,
+        format="%(asctime)s [%(levelname)s] %(name)s: %(message)s",
+        datefmt="[%Y-%m-%d %H:%M:%S]",
+        handlers=[
+            RichHandler(rich_tracebacks=True, show_path=False),
+            logging.FileHandler(log_file, encoding="utf-8")
+        ]
+    )