exonware-xwsystem 0.1.0.1__py3-none-any.whl → 0.1.0.4__py3-none-any.whl

exonware/xwsystem/{cli → console/cli}/progress.py

@@ -1,3 +1,4 @@
+#exonware/xwsystem/src/exonware/xwsystem/console/cli/progress.py
 """
 Progress Bar Utilities
 =====================
@@ -7,24 +8,27 @@ Production-grade progress indicators for XSystem.
 Company: eXonware.com
 Author: Eng. Muhammad AlShehri
 Email: connect@exonware.com
-Version: 0.1.0.1
+Version: 0.1.0.4
 Generation Date: September 05, 2025
 """
 
+from __future__ import annotations
+
 import sys
 import time
 import threading
-from typing import Optional, TextIO, Union
+from typing import Optional, TextIO
 from dataclasses import dataclass
 import math
 
-# Import colors from our existing color module
-# Explicit import - colors module is part of the same package
-from .colors import colorize, Colors, Style
+# Import general console enums from console level (priority)
+from ..defs import Colors, Style
+# Import CLI-specific color utilities
+from .colors import colorize
 
 
 @dataclass
-class ProgressConfig:
+class CliProgressConfig:
     """Configuration for progress indicators."""
     width: int = 50
     show_percentage: bool = True
@@ -36,7 +40,7 @@ class ProgressConfig:
     style: str = Style.BOLD
 
 
-class ProgressBar:
+class CliProgressBar:
     """
     Production-grade progress bar with ETA and rate calculation.
     
@@ -52,7 +56,7 @@ class ProgressBar:
     def __init__(self, 
                  total: int,
                  description: str = "",
-                 config: ProgressConfig = None,
+                 config: CliProgressConfig = None,
                  file: TextIO = None):
         """
         Initialize progress bar.
@@ -65,7 +69,7 @@ class ProgressBar:
         """
         self.total = total
         self.description = description
-        self.config = config or ProgressConfig()
+        self.config = config or CliProgressConfig()
         self.file = file or sys.stderr
         
         # Progress tracking
@@ -100,7 +104,7 @@ class ProgressBar:
                 self._update_rate(current_time)
                 self._last_rate_update = current_time
             
-            # Check if we should refresh display
+            # Check if to refresh display
             if (current_time - self.last_update >= self.config.refresh_rate or 
                 self.current >= self.total):
                 self._refresh_display()
@@ -240,7 +244,7 @@ class ProgressBar:
         self.close()
 
 
-class SpinnerProgress:
+class CliSpinnerProgress:
     """
     Spinning progress indicator for indeterminate tasks.
     
@@ -283,7 +287,7 @@ class SpinnerProgress:
         self._frame_index = 0
         self._lock = threading.Lock()
     
-    def start(self) -> 'SpinnerProgress':
+    def start(self) -> CliSpinnerProgress:
         """Start the spinner animation."""
         with self._lock:
             if not self._running:
@@ -330,7 +334,7 @@ class SpinnerProgress:
         self.stop()
 
 
-class MultiProgress:
+class CliMultiProgress:
     """
     Multiple progress bars manager.
     
@@ -357,7 +361,7 @@ class MultiProgress:
                 bar_id: str, 
                 total: int, 
                 description: str = "",
-                config: ProgressConfig = None) -> ProgressBar:
+                config: CliProgressConfig = None) -> CliProgressBar:
         """
         Add a new progress bar.
         
@@ -375,7 +379,7 @@ class MultiProgress:
                 raise ValueError(f"Progress bar '{bar_id}' already exists")
             
             # Create progress bar with custom file to prevent direct output
-            bar = ProgressBar(total, description, config, file=self)
+            bar = CliProgressBar(total, description, config, file=self)
             self._bars[bar_id] = bar
             self._active = True
             return bar
@@ -436,14 +440,14 @@ class MultiProgress:
 
 
 # Utility functions
-def create_progress_bar(total: int, description: str = "") -> ProgressBar:
+def create_progress_bar(total: int, description: str = "") -> CliProgressBar:
     """Create a simple progress bar."""
-    return ProgressBar(total, description)
+    return CliProgressBar(total, description)
 
 
-def create_spinner(message: str = "Processing...") -> SpinnerProgress:
+def create_spinner(message: str = "Processing...") -> CliSpinnerProgress:
     """Create a simple spinner."""
-    return SpinnerProgress(message)
+    return CliSpinnerProgress(message)
 
 
 def progress_range(iterable, description: str = ""):
@@ -451,12 +455,12 @@ def progress_range(iterable, description: str = ""):
     total = len(iterable) if hasattr(iterable, '__len__') else None
     
     if total is not None:
-        with ProgressBar(total, description) as pbar:
+        with CliProgressBar(total, description) as pbar:
             for item in iterable:
                 yield item
                 pbar.update(1)
     else:
         # Use spinner for unknown length iterables
-        with SpinnerProgress(description) as spinner:
+        with CliSpinnerProgress(description) as spinner:
             for item in iterable:
                 yield item

exonware/xwsystem/{cli → console/cli}/prompts.py

@@ -1,8 +1,9 @@
+#exonware/xwsystem/src/exonware/xwsystem/console/cli/prompts.py
 """
 Company: eXonware.com
 Author: Eng. Muhammad AlShehri
 Email: connect@exonware.com
-Version: 0.1.0.1
+Version: 0.1.0.4
 Generation Date: September 04, 2025
 
 Interactive prompts - Placeholder.
@@ -21,7 +22,7 @@ def multiselect(message, choices):
     return choices
 
 
-class Prompts:
+class CliPrompts:
     """Interactive prompts manager for CLI operations."""
     
     def __init__(self):

exonware/xwsystem/{cli → console/cli}/tables.py

@@ -1,3 +1,4 @@
+#exonware/xwsystem/src/exonware/xwsystem/console/cli/tables.py
 """
 Table Formatting Utilities
 ==========================
@@ -7,21 +8,23 @@ Production-grade table formatting for XWSystem.
 Company: eXonware.com
 Author: Eng. Muhammad AlShehri
 Email: connect@exonware.com
-Version: 0.1.0.1
+Version: 0.1.0.4
 Generation Date: September 05, 2025
 """
 
+from __future__ import annotations
+
 import sys
-from typing import Any, Optional, Union, TextIO, Callable
+from typing import Any, Optional, TextIO, Callable
 from dataclasses import dataclass
-# Import colors from our existing color module
-# Explicit import - colors module is part of the same package
-from .colors import colorize, Colors, Style
-from .defs import Alignment, BorderStyle
+# Import general console enums from console level (priority)
+from ..defs import Alignment, BorderStyle, Colors, Style
+# Import CLI-specific color utilities
+from .colors import colorize
 
 
 @dataclass
-class Column:
+class CliColumn:
     """
     Table column definition.
     
@@ -51,7 +54,7 @@ class Column:
                 self.width = min(self.width, self.max_width)
 
 
-class TableFormatter:
+class CliTableFormatter:
     """
     Production-grade table formatter.
     
@@ -90,7 +93,7 @@ class TableFormatter:
         self.padding = padding
         self.border_chars = self.BORDER_CHARS.get(border_style, self.BORDER_CHARS[BorderStyle.ROUNDED])
     
-    def format_cell(self, value: Any, column: Column, width: int) -> str:
+    def format_cell(self, value: Any, column: CliColumn, width: int) -> str:
         """Format a cell value according to column specifications."""
         # Apply custom formatter if provided
         if column.formatter:
@@ -116,7 +119,7 @@ class TableFormatter:
         
         return text
     
-    def calculate_widths(self, columns: list[Column], data: list[list[Any]]) -> list[int]:
+    def calculate_widths(self, columns: list[CliColumn], data: list[list[Any]]) -> list[int]:
         """Calculate optimal column widths."""
         widths = []
         
@@ -138,7 +141,7 @@ class TableFormatter:
         return widths
 
 
-class Table:
+class CliTable:
     """
     Production-grade table with advanced formatting capabilities.
     
@@ -150,39 +153,39 @@ class Table:
     """
     
     def __init__(self, 
-                 columns: list[Union[str, Column]] = None,
-                 formatter: TableFormatter = None,
+                 columns: list[str | CliColumn] = None,
+                 formatter: CliTableFormatter = None,
                  title: str = ""):
         """Initialize table."""
         self.title = title
-        self.formatter = formatter or TableFormatter()
+        self.formatter = formatter or CliTableFormatter()
         
         # Process columns
         self.columns = []
         if columns:
             for col in columns:
                 if isinstance(col, str):
-                    self.columns.append(Column(header=col))
+                    self.columns.append(CliColumn(header=col))
                 else:
                     self.columns.append(col)
         
         # Data storage
         self.rows = []
     
-    def add_column(self, column: Union[str, Column]) -> 'Table':
+    def add_column(self, column: str | CliColumn) -> CliTable:
         """Add a column to the table."""
         if isinstance(column, str):
-            self.columns.append(Column(header=column))
+            self.columns.append(CliColumn(header=column))
         else:
             self.columns.append(column)
         return self
     
-    def add_row(self, *values) -> 'Table':
+    def add_row(self, *values) -> CliTable:
         """Add a row to the table."""
         self.rows.append(list(values))
         return self
     
-    def add_rows(self, rows: list[list[Any]]) -> 'Table':
+    def add_rows(self, rows: list[list[Any]]) -> CliTable:
         """Add multiple rows to the table."""
         self.rows.extend(rows)
         return self
@@ -236,18 +239,18 @@ class Table:
 
 
 # Utility functions
-def create_simple_table(headers: list[str], rows: list[list[Any]]) -> Table:
+def create_simple_table(headers: list[str], rows: list[list[Any]]) -> CliTable:
     """Create a simple table with basic formatting."""
-    table = Table(headers)
+    table = CliTable(headers)
     table.add_rows(rows)
     return table
 
 
 def print_key_value_table(data: dict[str, Any], title: str = ""):
     """Print a key-value table."""
-    table = Table([
-        Column("Property", header_color=Colors.BLUE, header_style=Style.BOLD),
-        Column("Value", header_color=Colors.GREEN, header_style=Style.BOLD)
+    table = CliTable([
+        CliColumn("Property", header_color=Colors.BLUE, header_style=Style.BOLD),
+        CliColumn("Value", header_color=Colors.GREEN, header_style=Style.BOLD)
     ], title=title)
     
     for key, value in data.items():

exonware/xwsystem/console/contracts.py

@@ -0,0 +1,113 @@
+#!/usr/bin/env python3
+#exonware/xwsystem/src/exonware/xwsystem/console/contracts.py
+#exonware/xwsystem/console/contracts.py
+"""
+Company: eXonware.com
+Author: Eng. Muhammad AlShehri
+Email: connect@exonware.com
+Version: 0.1.0.4
+Generation Date: 2025-01-27
+
+Console module contracts - interfaces for console functionality.
+"""
+
+from typing import Protocol, runtime_checkable, Optional, Any
+from .defs import LogLevel, ConsoleEventType, ConsoleEvent
+
+
+@runtime_checkable
+class IEventLogger(Protocol):
+    """Interface for event logging operations."""
+    
+    def log(
+        self,
+        msg: str,
+        source: Optional[str] = None,
+        data: Optional[Any] = None,
+        color: Optional[str] = None,
+        label: Optional[str] = None
+    ) -> ConsoleEvent:
+        """Log a general message."""
+        ...
+    
+    def info(
+        self,
+        msg: str,
+        source: Optional[str] = None,
+        data: Optional[Any] = None
+    ) -> ConsoleEvent:
+        """Log an info message."""
+        ...
+    
+    def warn(
+        self,
+        msg: str,
+        source: Optional[str] = None,
+        data: Optional[Any] = None
+    ) -> ConsoleEvent:
+        """Log a warning message."""
+        ...
+    
+    def error(
+        self,
+        msg: str,
+        source: Optional[str] = None,
+        data: Optional[Any] = None,
+        stack: Optional[str] = None
+    ) -> ConsoleEvent:
+        """Log an error message."""
+        ...
+    
+    def debug(
+        self,
+        msg: str,
+        source: Optional[str] = None,
+        data: Optional[Any] = None
+    ) -> ConsoleEvent:
+        """Log a debug message."""
+        ...
+    
+    def get_events(
+        self,
+        event_type: Optional[ConsoleEventType] = None,
+        level: Optional[LogLevel] = None,
+        source: Optional[str] = None,
+        limit: Optional[int] = None
+    ) -> list[dict]:
+        """Get logged events as dictionaries."""
+        ...
+    
+    def clear(self) -> None:
+        """Clear all logged events."""
+        ...
+    
+    def count(self) -> int:
+        """Get the number of logged events."""
+        ...
+
+
+@runtime_checkable
+class IConsoleWriter(Protocol):
+    """Interface for console writing operations (user interaction, not logging)."""
+    
+    def write(self, text: str, **kwargs) -> None:
+        """Write text to console."""
+        ...
+    
+    def write_line(self, text: str = "", **kwargs) -> None:
+        """Write a line to console."""
+        ...
+    
+    def read(self, prompt: str = "") -> str:
+        """Read input from console."""
+        ...
+    
+    def clear(self) -> None:
+        """Clear console screen."""
+        ...
+
+
+__all__ = [
+    'IEventLogger',
+    'IConsoleWriter',
+]

exonware/xwsystem/console/defs.py

@@ -0,0 +1,154 @@
+#!/usr/bin/env python3
+#exonware/xwsystem/src/exonware/xwsystem/console/defs.py
+#exonware/xwsystem/console/defs.py
+"""
+Company: eXonware.com
+Author: Eng. Muhammad AlShehri
+Email: connect@exonware.com
+Version: 0.1.0.4
+Generation Date: 2025-01-27
+
+Type definitions and constants for console module.
+"""
+
+from typing import Literal, Any, Optional
+from dataclasses import dataclass
+from enum import Enum
+
+
+# ============================================================================
+# TYPE DEFINITIONS FOR STRUCTURED LOGGING
+# ============================================================================
+
+LogLevel = Literal['log', 'error', 'warn', 'info', 'debug']
+ConsoleEventType = Literal[
+    'log', 'info', 'warn', 'error', 'debug', 'trace',
+    'group', 'groupCollapsed', 'groupEnd', 'table', 'success', 'system'
+]
+
+
+@dataclass
+class ConsoleEvent:
+    """
+    Console event structure for structured logging.
+    
+    Attributes:
+        id: Unique identifier for the event
+        type: Type of console event
+        timestamp: Unix timestamp (seconds or milliseconds) or ISO string
+        color: CSS color for the event display
+        label: Short label for the badge
+        msg: Human-readable message
+        source: Optional source/operation/module name
+        level: Optional explicit log level (overrides type mapping)
+        data: Optional additional structured data
+    """
+    id: int
+    type: ConsoleEventType
+    timestamp: float | int | str  # Unix timestamp or ISO string
+    color: str
+    label: str
+    msg: str
+    source: Optional[str] = None
+    level: Optional[LogLevel] = None
+    data: Optional[Any] = None
+    
+    def to_dict(self) -> dict:
+        """Convert to dictionary for JSON serialization."""
+        result = {
+            'id': self.id,
+            'type': self.type,
+            'timestamp': self.timestamp,
+            'color': self.color,
+            'label': self.label,
+            'msg': self.msg,
+        }
+        if self.source is not None:
+            result['source'] = self.source
+        if self.level is not None:
+            result['level'] = self.level
+        if self.data is not None:
+            result['data'] = self.data
+        return result
+
+
+# ============================================================================
+# GENERAL CONSOLE ENUMS (moved from CLI - general console concepts)
+# ============================================================================
+
+class Alignment(Enum):
+    """Text alignment options."""
+    LEFT = "left"
+    CENTER = "center"
+    RIGHT = "right"
+
+
+class BorderStyle(Enum):
+    """Table border styles."""
+    NONE = "none"
+    ASCII = "ascii"
+    SIMPLE = "simple"
+    ROUNDED = "rounded"
+    DOUBLE = "double"
+    THICK = "thick"
+
+
+class Colors(Enum):
+    """ANSI color codes."""
+    # Standard colors
+    BLACK = "\033[30m"
+    RED = "\033[31m"
+    GREEN = "\033[32m"
+    YELLOW = "\033[33m"
+    BLUE = "\033[34m"
+    MAGENTA = "\033[35m"
+    CYAN = "\033[36m"
+    WHITE = "\033[37m"
+    
+    # Bright colors
+    BRIGHT_BLACK = "\033[90m"
+    BRIGHT_RED = "\033[91m"
+    BRIGHT_GREEN = "\033[92m"
+    BRIGHT_YELLOW = "\033[93m"
+    BRIGHT_BLUE = "\033[94m"
+    BRIGHT_MAGENTA = "\033[95m"
+    BRIGHT_CYAN = "\033[96m"
+    BRIGHT_WHITE = "\033[97m"
+    
+    # Background colors
+    BG_BLACK = "\033[40m"
+    BG_RED = "\033[41m"
+    BG_GREEN = "\033[42m"
+    BG_YELLOW = "\033[43m"
+    BG_BLUE = "\033[44m"
+    BG_MAGENTA = "\033[45m"
+    BG_CYAN = "\033[46m"
+    BG_WHITE = "\033[47m"
+    
+    # Reset
+    RESET = "\033[0m"
+
+
+class Style(Enum):
+    """ANSI style codes."""
+    RESET = "\033[0m"
+    BOLD = "\033[1m"
+    DIM = "\033[2m"
+    ITALIC = "\033[3m"
+    UNDERLINE = "\033[4m"
+    BLINK = "\033[5m"
+    REVERSE = "\033[7m"
+    STRIKETHROUGH = "\033[9m"
+
+
+__all__ = [
+    # Structured logging types
+    'LogLevel',
+    'ConsoleEventType',
+    'ConsoleEvent',
+    # General console enums
+    'Alignment',
+    'BorderStyle',
+    'Colors',
+    'Style',
+]

exonware/xwsystem/console/errors.py

@@ -0,0 +1,34 @@
+#!/usr/bin/env python3
+#exonware/xwsystem/src/exonware/xwsystem/console/errors.py
+#exonware/xwsystem/console/errors.py
+"""
+Company: eXonware.com
+Author: Eng. Muhammad AlShehri
+Email: connect@exonware.com
+Version: 0.1.0.4
+Generation Date: 2025-01-27
+
+Console module errors - exception classes for console functionality.
+"""
+
+
+class ConsoleError(Exception):
+    """Base exception for console errors."""
+    pass
+
+
+class EventLoggerError(ConsoleError):
+    """Raised when event logger operation fails."""
+    pass
+
+
+class ConsoleWriterError(ConsoleError):
+    """Raised when console writer operation fails."""
+    pass
+
+
+__all__ = [
+    'ConsoleError',
+    'EventLoggerError',
+    'ConsoleWriterError',
+]