[ENH]: Rich console formatting

Author: bosd

pyproject.toml

@@ -10,7 +10,7 @@ authors = [
 ]
 classifiers = ["Development Status :: 3 - Alpha"]
 
-dependencies = ["click >=8.0.1", "odoo-client-lib", "requests", "lxml"]
+dependencies = ["click >=8.0.1", "odoo-client-lib", "requests", "lxml", "rich"]
 
 
 [project.urls]
@@ -27,7 +27,7 @@ dev = [
     "pytest >=6.2.5",
     "pygments >=2.10.0",
     "nox >=2024.04.14",
-    "pytest-mock"
+    "pytest-mock",
 ]
 lint = ["ruff >=0.5.5", "pydoclint >=0.5.0"]
 docs = [

src/odoo_data_flow/logging_config.py

@@ -1,9 +1,10 @@
 """Centralized logging configuration for the odoo-data-flow application."""
 
 import logging
-import sys
 from typing import Optional
 
+from rich.logging import RichHandler
+
 # Get the root logger for the application package
 log = logging.getLogger("odoo_data_flow")
 
@@ -12,7 +13,8 @@ def setup_logging(verbose: bool = False, log_file: Optional[str] = None) -> None
     """Configures the root logger for the application.
 
     This function sets up handlers to print logs to the console and optionally
-    to a specified file.
+    to a specified file. It uses the 'rich' library to provide colorful,
+    easy-to-read console output.
 
     Args:
         verbose: If True, the logging level is set to DEBUG.
@@ -28,20 +30,23 @@ def setup_logging(verbose: bool = False, log_file: Optional[str] = None) -> None
     if log.hasHandlers():
         log.handlers.clear()
 
-    # Create a formatter to be used by all handlers
-    formatter = logging.Formatter("%(asctime)s - %(levelname)s - %(message)s")
-
-    # Always create a handler to print to the console
-    console_handler = logging.StreamHandler(sys.stdout)
-    console_handler.setFormatter(formatter)
+    # Create a rich handler for beautiful, colorful console output
+    console_handler = RichHandler(
+        rich_tracebacks=True,
+        markup=True,
+        log_time_format="[%X]",
+    )
     log.addHandler(console_handler)
 
-    # If a log file is specified, create a file handler as well
+    # If a log file is specified, create a standard file handler as well.
+    # We use a standard handler here to ensure the log file contains plain text
+    # without any color codes.
     if log_file:
         try:
-            file_handler = logging.FileHandler(log_file)
+            file_handler = logging.FileHandler(log_file, mode="a")
+            formatter = logging.Formatter("%(asctime)s - %(levelname)s - %(message)s")
             file_handler.setFormatter(formatter)
             log.addHandler(file_handler)
-            log.info(f"Logging to file: {log_file}")
+            log.info(f"Logging to file: [bold cyan]{log_file}[/bold cyan]")
         except Exception as e:
             log.error(f"Failed to set up log file at {log_file}: {e}")

tests/test_logging.py

@@ -4,6 +4,8 @@
 from pathlib import Path
 from unittest.mock import MagicMock, patch
 
+from rich.logging import RichHandler
+
 from odoo_data_flow.logging_config import log, setup_logging
 
 
@@ -19,8 +21,8 @@ def test_setup_logging_console_only() -> None:
     assert len(log.handlers) == 1, (
         "There should be exactly one handler for the console."
     )
-    assert isinstance(log.handlers[0], logging.StreamHandler)
-    assert not isinstance(log.handlers[0], logging.FileHandler)
+    # The console handler should now be a RichHandler
+    assert isinstance(log.handlers[0], RichHandler)
 
 
 def test_setup_logging_with_file(tmp_path: Path) -> None:
@@ -41,7 +43,7 @@ def test_setup_logging_with_file(tmp_path: Path) -> None:
 
     # Check that we have one of each type of handler
     handler_types = [type(h) for h in log.handlers]
-    assert logging.StreamHandler in handler_types
+    assert RichHandler in handler_types
     assert logging.FileHandler in handler_types
 
     # Find the file handler and check its path
@@ -57,7 +59,6 @@ def test_setup_logging_with_file(tmp_path: Path) -> None:
     # 3. Assertions
     # We should only have the new console handler, not the old NullHandler
     assert len(log.handlers) == 1
-    assert isinstance(log.handlers[0], logging.StreamHandler)
 
 
 def test_setup_logging_clears_existing_handlers() -> None:
@@ -77,7 +78,7 @@ def test_setup_logging_clears_existing_handlers() -> None:
     # 3. Assertions
     # We should only have the new console handler, not the old NullHandler
     assert len(log.handlers) == 1
-    assert isinstance(log.handlers[0], logging.StreamHandler)
+    assert isinstance(log.handlers[0], RichHandler)
 
 
 def test_log_output_is_written_to_file(tmp_path: Path) -> None: