htcli 1.1.0__py3-none-any.whl

src/htcli/ui/display.py

@@ -0,0 +1,336 @@
+"""
+HTCLI display utilities and console management.
+Provides consistent display functions across the CLI.
+"""
+
+from typing import Any, Union
+
+from rich.align import Align
+from rich.console import Console
+from rich.panel import Panel
+from rich.rule import Rule
+from rich.text import Text
+
+from .colors import HTCLIColors, HTCLITheme
+
+
+class HTCLIConsole:
+    """Enhanced console with HTCLI theming and utilities."""
+
+    def __init__(self, force_terminal: bool = None):
+        # If force_terminal is None, let Rich auto-detect
+        # But ensure we have proper terminal capabilities for Live displays
+        import sys
+        # Check if stdout is a TTY (terminal) - important for Live displays
+        is_terminal = sys.stdout.isatty() if force_terminal is None else force_terminal
+        
+        self.console = Console(
+            theme=HTCLITheme.get_theme(),
+            force_terminal=is_terminal,
+            width=120,  # Consistent width for better formatting
+            # Ensure proper terminal detection for live updates
+            legacy_windows=False,  # Use modern terminal features
+        )
+
+    def print(self, *args, **kwargs):
+        """Print with HTCLI theming."""
+        self.console.print(*args, **kwargs)
+
+    def print_panel(
+        self,
+        content: Any,
+        title: str = None,
+        title_style: str = "htcli.panel.title",
+        border_style: str = "htcli.border",
+        padding: tuple = (1, 2),
+        expand: bool = False,
+    ):
+        """Print content in a styled panel."""
+        panel = Panel(
+            content,
+            title=title,
+            title_align="left",
+            border_style=border_style,
+            padding=padding,
+            expand=expand,
+        )
+        if title:
+            panel.title = Text(title, style=title_style)
+        self.console.print(panel)
+
+    def print_rule(
+        self, title: str = None, style: str = "htcli.border", align: str = "center"
+    ):
+        """Print a horizontal rule with optional title."""
+        if title:
+            rule = Rule(Text(title, style="htcli.title"), style=style, align=align)
+        else:
+            rule = Rule(style=style)
+        self.console.print(rule)
+
+    def clear(self):
+        """Clear the console."""
+        self.console.clear()
+
+    def input(self, prompt: str = "", style: str = "htcli.prompt") -> str:
+        """Get input with styled prompt."""
+        styled_prompt = Text(prompt, style=style)
+        return self.console.input(styled_prompt)
+
+    def print_json(
+        self, data: Any = None, *, indent: int = 2, sort_keys: bool = False
+    ) -> None:
+        """Proxy to rich Console.print_json for JSON rendering."""
+        self.console.print_json(data=data, indent=indent, sort_keys=sort_keys)
+
+
+# Global console instance
+_console = HTCLIConsole()
+
+
+def get_console() -> HTCLIConsole:
+    """Get the global HTCLI console instance."""
+    return _console
+
+
+def print_success(
+    message: str, title: str = None, emoji: bool = True, panel: bool = False
+):
+    """Print a success message."""
+    prefix = "✅ " if emoji else ""
+    text = f"{prefix}{message}"
+
+    if panel:
+        _console.print_panel(
+            Text(text, style="htcli.status.success"),
+            title=title,
+            border_style="success",
+        )
+    else:
+        _console.print(f"[htcli.status.success]{text}[/]")
+
+
+def print_error(
+    message: str,
+    title: str = None,
+    emoji: bool = True,
+    panel: bool = False,
+    suggestions: list[str] = None,
+):
+    """Print an error message with optional suggestions."""
+    prefix = "❌ " if emoji else ""
+    text = f"{prefix}{message}"
+
+    content = Text(text, style="htcli.status.error")
+
+    if suggestions:
+        content.append("\n\n")
+        content.append("💡 Suggestions:\n", style="htcli.warning")
+        for suggestion in suggestions:
+            content.append(f"• {suggestion}\n", style="htcli.info")
+
+    if panel:
+        _console.print_panel(content, title=title, border_style="error")
+    else:
+        _console.print(content)
+
+
+def print_warning(
+    message: str, title: str = None, emoji: bool = True, panel: bool = False
+):
+    """Print a warning message."""
+    prefix = "⚠️  " if emoji else ""  # Two spaces after emoji for proper spacing
+    text = f"{prefix}{message}"
+
+    if panel:
+        _console.print_panel(
+            Text(text, style="htcli.status.pending"),
+            title=title,
+            border_style="warning",
+        )
+    else:
+        _console.print(f"[htcli.status.pending]{text}[/]")
+
+
+def print_info(
+    message: str, title: str = None, emoji: bool = True, panel: bool = False
+):
+    """Print an info message."""
+    prefix = "ℹ️  " if emoji else ""  # Add space after emoji
+    text = f"{prefix}{message}"
+
+    if panel:
+        _console.print_panel(
+            Text(text, style="htcli.info"), title=title, border_style="info"
+        )
+    else:
+        _console.print(f"[htcli.info]{text}[/]")
+
+
+def print_header(
+    title: str, subtitle: str = None, version: str = None, width: int = 80
+):
+    """Print a styled header for commands."""
+    # Create the main title
+    title_text = Text(title, style="htcli.header")
+    if version:
+        title_text.append(f" v{version}", style="htcli.subtitle")
+
+    header_content = Align.center(title_text)
+
+    if subtitle:
+        subtitle_text = Text(subtitle, style="htcli.subtitle")
+        header_content = Align.center(f"{title_text}\n{subtitle_text}")
+
+    _console.print_panel(
+        header_content, border_style="htcli.primary", padding=(1, 4), expand=False
+    )
+    _console.print()
+
+
+def print_footer(message: str = None, show_help: bool = True, command: str = None):
+    """Print a styled footer."""
+    if not message and not show_help:
+        return
+
+    content = []
+
+    if message:
+        content.append(Text(message, style="htcli.subtitle"))
+
+    if show_help:
+        help_text = "Use --help for more information"
+        if command:
+            help_text = f"Use 'htcli {command} --help' for more information"
+        content.append(Text(help_text, style="htcli.muted"))
+
+    if content:
+        _console.print()
+        for item in content:
+            _console.print(Align.center(item))
+
+
+def print_status(status: str, message: str, emoji_map: dict = None):
+    """Print a status message with appropriate styling."""
+    default_emojis = {
+        "success": "✅",
+        "error": "❌",
+        "warning": "⚠️",
+        "info": "ℹ️",
+        "loading": "⏳",
+        "active": "🟢",
+        "inactive": "⚪",
+        "pending": "🟡",
+    }
+
+    emojis = emoji_map or default_emojis
+    emoji = emojis.get(status.lower(), "•")
+    color = HTCLIColors.get_status_color(status)
+
+    _console.print(f"[{color}]{emoji} {message}[/]")
+
+
+def print_blockchain_data(title: str, data: dict, highlight_keys: list[str] = None):
+    """Print blockchain data in a formatted way."""
+    highlight_keys = highlight_keys or []
+
+    content = []
+    for key, value in data.items():
+        key_style = "htcli.highlight" if key in highlight_keys else "htcli.subtitle"
+
+        # Format different types of blockchain data
+        if key.lower() in ["address", "account", "validator"]:
+            formatted_value = f"[htcli.address]{value}[/]"
+        elif key.lower() in ["amount", "balance", "stake", "reward"]:
+            formatted_value = f"[htcli.amount]{value}[/]"
+        elif key.lower() in ["hash", "block_hash", "tx_hash"]:
+            formatted_value = f"[htcli.hash]{value}[/]"
+        elif key.lower() in ["status", "state"]:
+            formatted_value = f"[htcli.status.{value.lower()}]{value}[/]"
+        else:
+            formatted_value = f"[htcli.value]{value}[/]"
+
+        content.append(f"[{key_style}]{key}:[/] {formatted_value}")
+
+    _console.print_panel("\n".join(content), title=title, border_style="htcli.border")
+
+
+def print_command_result(
+    success: bool,
+    message: str,
+    data: dict = None,
+    transaction_hash: str = None,
+    suggestions: list[str] = None,
+):
+    """Print standardized command result."""
+    if success:
+        print_success(message, panel=True)
+        if transaction_hash:
+            _console.print(
+                f"\n[htcli.subtitle]Transaction Hash:[/] [htcli.hash]{transaction_hash}[/]"
+            )
+        if data:
+            print_blockchain_data("Result Details", data)
+    else:
+        print_error(message, panel=True, suggestions=suggestions)
+
+
+def print_separator(char: str = "─", style: str = "htcli.border"):
+    """Print a separator line."""
+    _console.print(Rule(style=style, characters=char))
+
+
+def print_logo():
+    """Print the HTCLI logo."""
+    logo = """
+    ██╗  ██╗████████╗ ██████╗██╗     ██╗
+    ██║  ██║╚══██╔══╝██╔════╝██║     ██║
+    ███████║   ██║   ██║     ██║     ██║
+    ██╔══██║   ██║   ██║     ██║     ██║
+    ██║  ██║   ██║   ╚██████╗███████╗██║
+    ╚═╝  ╚═╝   ╚═╝    ╚═════╝╚══════╝╚═╝
+
+    Hypertensor Command Line Interface
+    """
+
+    _console.print(Align.center(Text(logo, style="htcli.primary", justify="center")))
+
+
+# Utility functions for quick formatting
+def format_address(address: str, truncate: bool = True) -> str:
+    """Format a blockchain address with truncation."""
+    if truncate and len(address) > 20:
+        return f"{address[:8]}...{address[-8:]}"
+    return address
+
+
+def format_amount(
+    amount: Union[int, float], decimals: int = 6, currency: str = "TENSOR"
+) -> str:
+    """Format an amount with proper decimals and currency."""
+    if isinstance(amount, int):
+        formatted = f"{amount / (10**18):.{decimals}f}"
+    else:
+        formatted = f"{amount:.{decimals}f}"
+    return f"{formatted} {currency}"
+
+
+def format_hash(hash_value: str, truncate: bool = True) -> str:
+    """Format a hash value with optional truncation."""
+    if truncate and len(hash_value) > 16:
+        return f"{hash_value[:8]}...{hash_value[-8:]}"
+    return hash_value
+
+
+def format_status(status: str) -> str:
+    """Format a status with appropriate emoji."""
+    status_emojis = {
+        "active": "🟢 Active",
+        "inactive": "⚪ Inactive",
+        "pending": "🟡 Pending",
+        "success": "✅ Success",
+        "failed": "❌ Failed",
+        "error": "❌ Error",
+        "warning": "⚠️ Warning",
+    }
+    return status_emojis.get(status.lower(), f"• {status}")