feat(exporter): Add progress bar and rich panels to export command

Use rich.progress to display a progress bar during the export process, and rich.panel to display success and error messages, providing better feedback to the user.

Author: bosd

src/odoo_data_flow/export_threaded.py

@@ -7,7 +7,7 @@
 import csv
 import sys
 from time import time
-from typing import Any, Optional
+from typing import Any, Optional, overload
 
 from .lib import conf_lib
 from .lib.internal.rpc_thread import RpcThread
@@ -82,6 +82,36 @@ def get_data(self) -> list[list[Any]]:
         return all_data
 
 
+@overload
+def export_data(
+    config_file: str,
+    model: str,
+    domain: list[Any],
+    header: list[str],
+    context: Optional[dict[str, Any]],
+    output: str,
+    max_connection: int,
+    batch_size: int,
+    separator: str,
+    encoding: str,
+) -> tuple[bool, str]: ...
+
+
+@overload
+def export_data(
+    config_file: str,
+    model: str,
+    domain: list[Any],
+    header: list[str],
+    context: Optional[dict[str, Any]],
+    output: None,
+    max_connection: int,
+    batch_size: int,
+    separator: str,
+    encoding: str,
+) -> tuple[list[str], Optional[list[list[Any]]]]: ...
+
+
 def export_data(
     config_file: str,
     model: str,
@@ -93,7 +123,7 @@ def export_data(
     batch_size: int = 100,
     separator: str = ";",
     encoding: str = "utf-8",
-) -> tuple[Optional[list[str]], Optional[list[list[Any]]]]:
+) -> Any:
     """Export Data.
 
     The main function for exporting data. It can either write to a file or
@@ -103,11 +133,12 @@ def export_data(
         connection = conf_lib.get_connection_from_config(config_file)
         model_obj = connection.get_model(model)
     except Exception as e:
-        log.error(
+        message = (
             f"Failed to connect to Odoo or get model '{model}'. "
             f"Please check your configuration. Error: {e}"
         )
-        return None, None
+        log.error(message)
+        return (False, message) if output else (None, None)
 
     rpc_thread = RPCThreadExport(max_connection, model_obj, header, context)
     start_time = time()
@@ -139,9 +170,11 @@ def export_data(
                 writer.writerow(header)
                 writer.writerows(all_exported_data)
             log.info("File writing complete.")
+            return True, "Export complete."
         except OSError as e:
-            log.error(f"Failed to write to output file {output}: {e}")
-        return None, None
+            message = f"Failed to write to output file {output}: {e}"
+            log.error(message)
+            return False, message
     else:
         log.info("Returning exported data in-memory.")
         return header, all_exported_data

src/odoo_data_flow/exporter.py

@@ -3,10 +3,19 @@
 import ast
 from typing import Any, Optional
 
+from rich.console import Console
+from rich.panel import Panel
+
 from . import export_threaded
 from .logging_config import log
 
 
+def _show_error_panel(title: str, message: str) -> None:
+    """Displays a formatted error panel to the console."""
+    console = Console(stderr=True, style="bold red")
+    console.print(Panel(message, title=title, border_style="red"))
+
+
 def run_export(
     config: str,
     filename: str,
@@ -32,16 +41,21 @@ def run_export(
         if not isinstance(parsed_domain, list):
             raise TypeError("Domain must be a list of tuples.")
     except Exception as e:
-        log.error(f"Invalid domain provided. Must be a valid Python list string. {e}")
+        _show_error_panel(
+            "Invalid Domain",
+            f"The --domain argument must be a valid Python list string.\nError: {e}",
+        )
         return
 
     try:
         parsed_context = ast.literal_eval(context)
         if not isinstance(parsed_context, dict):
             raise TypeError("Context must be a dictionary.")
     except Exception as e:
-        log.error(
-            f"Invalid context provided. Must be a valid Python dictionary string. {e}"
+        _show_error_panel(
+            "Invalid Context",
+            "The --context argument must be a valid Python dictionary string."
+            f"\nError: {e}",
         )
         return
 
@@ -53,7 +67,7 @@ def run_export(
     log.info(f"Workers: {worker}, Batch Size: {batch_size}")
 
     # Call the core export function with an output filename
-    export_threaded.export_data(
+    success, message = export_threaded.export_data(
         config,
         model,
         parsed_domain,
@@ -66,7 +80,18 @@ def run_export(
         encoding=encoding,
     )
 
-    log.info("Export process finished.")
+    console = Console()
+    if success:
+        console.print(
+            Panel(
+                f"Export process for model [bold cyan]{model}[/bold cyan] "
+                f"finished successfully.",
+                title="[bold green]Export Complete[/bold green]",
+                border_style="green",
+            )
+        )
+    else:
+        _show_error_panel("Export Aborted", message)
 
 
 def run_export_for_migration(

src/odoo_data_flow/lib/internal/rpc_thread.py

@@ -7,7 +7,13 @@
 import concurrent.futures
 from typing import Any, Callable, Optional
 
-from rich.progress import Progress
+from rich.progress import (
+    BarColumn,
+    Progress,
+    SpinnerColumn,
+    TextColumn,
+    TimeRemainingColumn,
+)
 
 from ...logging_config import log
 
@@ -60,7 +66,17 @@ def wait(self) -> None:
         """
         log.info(f"Waiting for {len(self.futures)} tasks to complete...")
 
-        with Progress() as progress:
+        progress = Progress(
+            SpinnerColumn(),
+            TextColumn("[bold blue]{task.description}", justify="right"),
+            BarColumn(bar_width=None),
+            "[progress.percentage]{task.percentage:>3.0f}%",
+            TextColumn("•"),
+            TextColumn("[green]{task.completed} of {task.total} records"),
+            TextColumn("•"),
+            TimeRemainingColumn(),
+        )
+        with progress:
             task = progress.add_task("[cyan]Processing...", total=len(self.futures))
 
             # Use as_completed to process results as they finish,

tests/test_exporter.py

@@ -13,6 +13,7 @@ def test_run_export(mock_export_data: MagicMock) -> None:
     `export_threaded.export_data` function with the correct parameters.
     """
     # 1. Setup
+    mock_export_data.return_value = (True, "Export complete.")
     config_file = "conf/test.conf"
     filename = "output.csv"
     model = "res.partner"
@@ -86,8 +87,8 @@ def test_run_export_for_migration(mock_export_data: MagicMock) -> None:
     assert data == [["1", "Test Partner"]]
 
 
-@patch("odoo_data_flow.exporter.log.error")
-def test_run_export_invalid_domain(mock_log_error: MagicMock) -> None:
+@patch("odoo_data_flow.exporter._show_error_panel")
+def test_run_export_invalid_domain(mock_show_error_panel: MagicMock) -> None:
     """Tests that `run_export` logs an error for a malformed domain string."""
     # 1. Action
     run_export(
@@ -99,8 +100,8 @@ def test_run_export_invalid_domain(mock_log_error: MagicMock) -> None:
     )
 
     # 2. Assertions
-    mock_log_error.assert_called_once()
-    assert "Invalid domain provided" in mock_log_error.call_args[0][0]
+    mock_show_error_panel.assert_called_once()
+    assert "Invalid Domain" in mock_show_error_panel.call_args[0][0]
 
 
 @patch("odoo_data_flow.export_threaded.conf_lib.get_connection_from_config")
@@ -124,8 +125,8 @@ def test_run_export_calls_rpc_thread_wait(
     assert mock_rpc_thread.return_value.get_data.called
 
 
-@patch("odoo_data_flow.exporter.log.error")
-def test_run_export_invalid_context(mock_log_error: MagicMock) -> None:
+@patch("odoo_data_flow.exporter._show_error_panel")
+def test_run_export_invalid_context(mock_show_error_panel: MagicMock) -> None:
     """Tests that `run_export` logs an error for a malformed context string."""
     # 1. Action
     run_export(
@@ -137,8 +138,8 @@ def test_run_export_invalid_context(mock_log_error: MagicMock) -> None:
     )
 
     # 2. Assertions
-    mock_log_error.assert_called_once()
-    assert "Invalid context provided" in mock_log_error.call_args[0][0]
+    mock_show_error_panel.assert_called_once()
+    assert "Invalid Context" in mock_show_error_panel.call_args[0][0]
 
 
 @patch("odoo_data_flow.exporter.export_threaded.export_data")