Merge pull request #227 from posit-dev/fix-cli-scan-improve-display

fix: improve display of tables in CLI utility

Author: rich-iannone

pointblank/cli.py

@@ -284,6 +284,13 @@ def _rich_print_gt_table(gt_table: Any, preview_info: dict | None = None) -> Non
                 table_type = preview_info["table_type"]
                 table_title = f"Data Preview / {source_type} / {table_type}"
 
+                # Add dimensions subtitle in gray if available
+                if "total_rows" in preview_info and "total_columns" in preview_info:
+                    total_rows = preview_info["total_rows"]
+                    total_columns = preview_info["total_columns"]
+                    if total_rows is not None and total_columns is not None:
+                        table_title += f"\n[dim]{total_rows:,} rows / {total_columns} columns[/dim]"
+
             rich_table = Table(
                 title=table_title,
                 show_header=True,
@@ -951,6 +958,7 @@ def preview(
                 processed_data = data
 
                 total_dataset_rows = pb.get_row_count(processed_data)
+                total_dataset_columns = pb.get_column_count(processed_data)
 
                 # Determine source type and table type for enhanced preview title
                 if data_source in ["small_table", "game_revenue", "nycflights", "global_sales"]:
@@ -962,6 +970,7 @@ def preview(
             except Exception:
                 # If we can't get metadata, set defaults
                 total_dataset_rows = None
+                total_dataset_columns = None
                 source_type = f"Data source: {data_source}"
                 table_type = "unknown"
 
@@ -992,6 +1001,7 @@ def preview(
 
                 preview_info = {
                     "total_rows": total_dataset_rows,
+                    "total_columns": total_dataset_columns,
                     "head_rows": head,
                     "tail_rows": tail,
                     "is_complete": is_complete,
@@ -1118,11 +1128,13 @@ def scan(
                 source_type = f"External source: {data_source}"
 
             table_type = _get_tbl_type(data)
-            # Get row count for footer
+            # Get row count and column count for header
             try:
                 total_rows = pb.get_row_count(data)
+                total_columns = pb.get_column_count(data)
             except Exception:
                 total_rows = None
+                total_columns = None
 
         scan_time = time.time() - start_time
 
@@ -1142,7 +1154,7 @@ def scan(
             # Display detailed column summary using rich formatting
             try:
                 _rich_print_scan_table(
-                    scan_result, data_source, source_type, table_type, total_rows
+                    scan_result, data_source, source_type, table_type, total_rows, total_columns
                 )
 
             except Exception as e:
@@ -1756,6 +1768,7 @@ def _rich_print_scan_table(
     source_type: str,
     table_type: str,
     total_rows: int | None = None,
+    total_columns: int | None = None,
 ) -> None:
     """
     Display scan results as a Rich table in the terminal with statistical measures.
@@ -1766,6 +1779,7 @@ def _rich_print_scan_table(
         source_type: Type of data source (e.g., "Pointblank dataset: small_table")
         table_type: Type of table (e.g., "polars.LazyFrame")
         total_rows: Total number of rows in the dataset
+        total_columns: Total number of columns in the dataset
     """
     try:
         import re
@@ -1787,6 +1801,10 @@ def _rich_print_scan_table(
         # Create a comprehensive title with data source, source type, and table type
         title_text = f"Column Summary / {source_type} / {table_type}"
 
+        # Add dimensions subtitle in gray if available
+        if total_rows is not None and total_columns is not None:
+            title_text += f"\n[dim]{total_rows:,} rows / {total_columns} columns[/dim]"
+
         scan_table = Table(
             title=title_text,
             show_header=True,
@@ -2003,26 +2021,7 @@ def format_value(
 
         # Display the results
         console.print()
-        console.print(scan_table)  # Add informational footer about the scan scope
-        try:
-            if total_rows is not None:
-                # Full table scan
-                footer_text = f"[dim]Scan from all {total_rows:,} rows in the table.[/dim]"
-
-                # Create a simple footer
-                footer_table = Table(
-                    show_header=False,
-                    show_lines=False,
-                    box=None,
-                    padding=(0, 0),
-                )
-                footer_table.add_column("", style="dim", width=80)
-                footer_table.add_row(footer_text)
-                console.print(footer_table)
-
-        except Exception:
-            # If we can't determine the scan scope, don't show a footer
-            pass
+        console.print(scan_table)
 
     except Exception as e:
         # Fallback to simple message if table creation fails
@@ -2225,9 +2224,7 @@ def validate_simple(
                 # Get the result
                 all_passed = validation.all_passed()
 
-                console.print(
-                    f"[green]✓[/green] {check.replace('-', ' ').title()} validation completed"
-                )
+                console.print(f"[green]✓[/green] {check} validation completed")
             elif check == "col-vals-not-null":
                 # Create validation for not null values in specified column
                 validation = (
@@ -2243,9 +2240,7 @@ def validate_simple(
                 # Get the result
                 all_passed = validation.all_passed()
 
-                console.print(
-                    f"[green]✓[/green] {check.replace('-', ' ').title()} validation completed"
-                )
+                console.print(f"[green]✓[/green] {check} validation completed")
             elif check == "rows-complete":
                 # Create validation for complete rows (no missing values in any column)
                 validation = (
@@ -2261,9 +2256,7 @@ def validate_simple(
                 # Get the result
                 all_passed = validation.all_passed()
 
-                console.print(
-                    f"[green]✓[/green] {check.replace('-', ' ').title()} validation completed"
-                )
+                console.print(f"[green]✓[/green] {check} validation completed")
             elif check == "col-exists":
                 # Create validation for column existence
                 validation = (
@@ -2279,9 +2272,7 @@ def validate_simple(
                 # Get the result
                 all_passed = validation.all_passed()
 
-                console.print(
-                    f"[green]✓[/green] {check.replace('-', ' ').title()} validation completed"
-                )
+                console.print(f"[green]✓[/green] {check} validation completed")
             elif check == "col-vals-in-set":
                 # Parse the comma-separated set values
                 allowed_values = [value.strip() for value in set.split(",")]
@@ -2300,9 +2291,7 @@ def validate_simple(
                 # Get the result
                 all_passed = validation.all_passed()
 
-                console.print(
-                    f"[green]✓[/green] {check.replace('-', ' ').title()} validation completed"
-                )
+                console.print(f"[green]✓[/green] {check} validation completed")
             elif check == "col-vals-gt":
                 # Create validation for values greater than threshold
                 validation = (
@@ -2318,9 +2307,7 @@ def validate_simple(
                 # Get the result
                 all_passed = validation.all_passed()
 
-                console.print(
-                    f"[green]✓[/green] {check.replace('-', ' ').title()} validation completed"
-                )
+                console.print(f"[green]✓[/green] {check} validation completed")
             elif check == "col-vals-ge":
                 # Create validation for values greater than or equal to threshold
                 validation = (
@@ -2336,9 +2323,7 @@ def validate_simple(
                 # Get the result
                 all_passed = validation.all_passed()
 
-                console.print(
-                    f"[green]✓[/green] {check.replace('-', ' ').title()} validation completed"
-                )
+                console.print(f"[green]✓[/green] {check} validation completed")
             elif check == "col-vals-lt":
                 # Create validation for values less than threshold
                 validation = (
@@ -2354,9 +2339,7 @@ def validate_simple(
                 # Get the result
                 all_passed = validation.all_passed()
 
-                console.print(
-                    f"[green]✓[/green] {check.replace('-', ' ').title()} validation completed"
-                )
+                console.print(f"[green]✓[/green] {check} validation completed")
             elif check == "col-vals-le":
                 # Create validation for values less than or equal to threshold
                 validation = (
@@ -2372,9 +2355,7 @@ def validate_simple(
                 # Get the result
                 all_passed = validation.all_passed()
 
-                console.print(
-                    f"[green]✓[/green] {check.replace('-', ' ').title()} validation completed"
-                )
+                console.print(f"[green]✓[/green] {check} validation completed")
             else:
                 # This shouldn't happen due to click.Choice, but just in case
                 console.print(f"[red]Error:[/red] Unknown check type: {check}")