Files
Medios-Macina/SYS/models.py

1642 lines
54 KiB
Python
Raw Normal View History

2025-11-25 20:09:33 -08:00
"""Data models for the pipeline."""
import datetime
import hashlib
import json
import os
import shutil
import sys
2025-12-19 15:20:08 -08:00
import time
2025-11-25 20:09:33 -08:00
from dataclasses import dataclass, field
from pathlib import Path
2025-12-20 23:57:44 -08:00
from typing import Any, Callable, Dict, List, Optional, Protocol, TextIO
from rich.console import Console
2025-12-21 05:10:09 -08:00
from rich.console import ConsoleOptions
from rich.console import Group
from rich.live import Live
from rich.panel import Panel
2025-12-20 23:57:44 -08:00
from rich.progress import (
BarColumn,
DownloadColumn,
Progress,
2025-12-21 05:10:09 -08:00
SpinnerColumn,
2025-12-20 23:57:44 -08:00
TaskID,
TaskProgressColumn,
TextColumn,
TimeRemainingColumn,
2025-12-21 05:10:09 -08:00
TimeElapsedColumn,
2025-12-20 23:57:44 -08:00
TransferSpeedColumn,
)
2025-11-25 20:09:33 -08:00
@dataclass(slots=True)
class PipeObject:
2025-12-11 23:21:45 -08:00
"""Unified pipeline object for tracking files, metadata, tag values, and relationships through the pipeline.
2025-12-29 17:05:03 -08:00
2025-12-11 12:47:30 -08:00
This is the single source of truth for all result data in the pipeline. Uses the hash+store
canonical pattern for file identification.
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
Attributes:
2025-12-11 12:47:30 -08:00
hash: SHA-256 hash of the file (canonical identifier)
store: Storage backend name (e.g., 'default', 'hydrus', 'test', 'home')
2025-12-11 23:21:45 -08:00
tag: List of extracted or assigned tag values
2025-11-25 20:09:33 -08:00
title: Human-readable title if applicable
source_url: URL where the object came from
duration: Duration in seconds if applicable
metadata: Full metadata dictionary from source
warnings: Any warnings or issues encountered
2025-12-11 12:47:30 -08:00
path: Path to the file if this object represents a file
relationships: Relationship data (king/alt/related hashes)
2025-11-25 20:09:33 -08:00
is_temp: If True, this is a temporary/intermediate artifact that may be cleaned up
2025-12-11 12:47:30 -08:00
action: The cmdlet that created this object (format: 'cmdlet:cmdlet_name')
parent_hash: Hash of the parent file in the pipeline chain (for tracking provenance/lineage)
2025-11-25 20:09:33 -08:00
extra: Additional fields not covered above
"""
2025-12-29 17:05:03 -08:00
2025-12-11 12:47:30 -08:00
hash: str
store: str
2025-12-19 02:29:42 -08:00
provider: Optional[str] = None
2025-12-11 23:21:45 -08:00
tag: List[str] = field(default_factory=list)
2025-11-25 20:09:33 -08:00
title: Optional[str] = None
2025-12-11 12:47:30 -08:00
url: Optional[str] = None
2025-11-25 20:09:33 -08:00
source_url: Optional[str] = None
duration: Optional[float] = None
metadata: Dict[str, Any] = field(default_factory=dict)
warnings: List[str] = field(default_factory=list)
2025-12-11 12:47:30 -08:00
path: Optional[str] = None
relationships: Dict[str, Any] = field(default_factory=dict)
2025-11-25 20:09:33 -08:00
is_temp: bool = False
action: Optional[str] = None
2025-12-11 12:47:30 -08:00
parent_hash: Optional[str] = None
2025-11-25 20:09:33 -08:00
extra: Dict[str, Any] = field(default_factory=dict)
2025-12-11 12:47:30 -08:00
def add_relationship(self, rel_type: str, rel_hash: str) -> None:
"""Add a relationship hash.
2025-12-29 17:05:03 -08:00
2025-12-11 12:47:30 -08:00
Args:
rel_type: Relationship type ('king', 'alt', 'related')
rel_hash: Hash to add to the relationship
"""
if rel_type not in self.relationships:
self.relationships[rel_type] = []
2025-12-29 17:05:03 -08:00
2025-12-11 12:47:30 -08:00
if isinstance(self.relationships[rel_type], list):
if rel_hash not in self.relationships[rel_type]:
self.relationships[rel_type].append(rel_hash)
else:
# Single value (e.g., king), convert to that value
self.relationships[rel_type] = rel_hash
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
def get_relationships(self) -> Dict[str, Any]:
"""Get all relationships for this object."""
2025-12-11 12:47:30 -08:00
return self.relationships.copy() if self.relationships else {}
def debug_table(self) -> None:
2025-12-20 23:57:44 -08:00
"""Rich-inspect the PipeObject when debug logging is enabled."""
2025-12-11 12:47:30 -08:00
try:
2025-12-20 23:57:44 -08:00
from SYS.logger import is_debug_enabled, debug_inspect
2025-12-11 12:47:30 -08:00
except Exception:
return
2025-12-20 23:57:44 -08:00
if not is_debug_enabled():
return
# Prefer a stable, human-friendly title:
2026-01-01 20:37:27 -08:00
# "1 - download-file", "2 - download-file", ...
2025-12-20 23:57:44 -08:00
# The index is preserved when possible via `pipe_index` in the PipeObject's extra.
idx = None
2025-12-16 01:45:01 -08:00
try:
2025-12-20 23:57:44 -08:00
if isinstance(self.extra, dict):
idx = self.extra.get("pipe_index")
2025-12-16 01:45:01 -08:00
except Exception:
2025-12-20 23:57:44 -08:00
idx = None
cmdlet_name = "PipeObject"
try:
from SYS import pipeline as ctx
2025-12-29 17:05:03 -08:00
current = (
ctx.get_current_cmdlet_name("")
if hasattr(ctx,
"get_current_cmdlet_name") else ""
2025-12-29 17:05:03 -08:00
)
2025-12-20 23:57:44 -08:00
if current:
cmdlet_name = current
else:
action = str(self.action or "").strip()
if action.lower().startswith("cmdlet:"):
cmdlet_name = action.split(":", 1)[1].strip() or cmdlet_name
elif action:
cmdlet_name = action
except Exception:
cmdlet_name = "PipeObject"
title_text = cmdlet_name
try:
if idx is not None and str(idx).strip():
title_text = f"{idx} - {cmdlet_name}"
except Exception:
title_text = cmdlet_name
# Color the title (requested: yellow instead of Rich's default blue-ish title).
debug_inspect(self, title=f"[yellow]{title_text}[/yellow]")
2025-11-25 20:09:33 -08:00
def to_dict(self) -> Dict[str, Any]:
"""Serialize to dictionary, excluding None and empty values."""
data: Dict[str,
Any] = {
"hash": self.hash,
"store": self.store,
}
2025-12-19 02:29:42 -08:00
if self.provider:
data["provider"] = self.provider
2025-12-29 17:05:03 -08:00
2025-12-11 23:21:45 -08:00
if self.tag:
data["tag"] = self.tag
2025-11-25 20:09:33 -08:00
if self.title:
data["title"] = self.title
2025-12-11 12:47:30 -08:00
if self.url:
data["url"] = self.url
2025-11-25 20:09:33 -08:00
if self.source_url:
data["source_url"] = self.source_url
if self.duration is not None:
data["duration"] = self.duration
if self.metadata:
data["metadata"] = self.metadata
if self.warnings:
data["warnings"] = self.warnings
2025-12-11 12:47:30 -08:00
if self.path:
data["path"] = self.path
if self.relationships:
data["relationships"] = self.relationships
2025-11-25 20:09:33 -08:00
if self.is_temp:
data["is_temp"] = self.is_temp
if self.action:
data["action"] = self.action
2025-12-11 12:47:30 -08:00
if self.parent_hash:
data["parent_hash"] = self.parent_hash
2025-12-29 17:05:03 -08:00
2025-12-11 12:47:30 -08:00
# Add extra fields
data.update({
k: v
for k, v in self.extra.items() if v is not None
})
2025-11-25 20:09:33 -08:00
return data
class FileRelationshipTracker:
"""Track relationships between files for sidecar creation.
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
Allows tagging files with their relationships to other files:
- king: The primary/master version of a file
- alt: Alternate versions of the same content
- related: Related files (e.g., screenshots of a book)
"""
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
def __init__(self) -> None:
self.relationships: Dict[str,
Dict[str,
Any]] = {}
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
def register_king(self, file_path: str, file_hash: str) -> None:
"""Register a file as the king (primary) version."""
if file_path not in self.relationships:
self.relationships[file_path] = {}
self.relationships[file_path]["king"] = file_hash
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
def add_alt(self, file_path: str, alt_hash: str) -> None:
"""Add an alternate version of a file."""
if file_path not in self.relationships:
self.relationships[file_path] = {}
if "alt" not in self.relationships[file_path]:
self.relationships[file_path]["alt"] = []
if alt_hash not in self.relationships[file_path]["alt"]:
self.relationships[file_path]["alt"].append(alt_hash)
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
def add_related(self, file_path: str, related_hash: str) -> None:
"""Add a related file."""
if file_path not in self.relationships:
self.relationships[file_path] = {}
if "related" not in self.relationships[file_path]:
self.relationships[file_path]["related"] = []
if related_hash not in self.relationships[file_path]["related"]:
self.relationships[file_path]["related"].append(related_hash)
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
def get_relationships(self, file_path: str) -> Optional[Dict[str, Any]]:
"""Get relationships for a file."""
return self.relationships.get(file_path)
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
def link_files(self, primary_path: str, king_hash: str, *alt_paths: str) -> None:
"""Link files together with primary as king and others as alternates.
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
Args:
primary_path: Path to the primary file (will be marked as 'king')
king_hash: Hash of the primary file
alt_paths: Paths to alternate versions (will be marked as 'alt')
"""
self.register_king(primary_path, king_hash)
for alt_path in alt_paths:
try:
alt_hash = _get_file_hash(alt_path)
self.add_alt(primary_path, alt_hash)
except Exception as e:
import sys
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
print(f"Error hashing {alt_path}: {e}", file=sys.stderr)
def _get_file_hash(filepath: str) -> str:
"""Calculate SHA256 hash of a file."""
sha256_hash = hashlib.sha256()
with open(filepath, "rb") as f:
for byte_block in iter(lambda: f.read(4096), b""):
sha256_hash.update(byte_block)
return sha256_hash.hexdigest()
# ============= Download Module Classes =============
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
class DownloadError(RuntimeError):
"""Raised when the download or Hydrus import fails."""
@dataclass(slots=True)
class DownloadOptions:
"""Configuration for downloading media.
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
Use the add-file cmdlet separately for Hydrus import.
"""
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
url: str
mode: str # "audio" or "video"
output_dir: Path
cookies_path: Optional[Path] = None
ytdl_format: Optional[str] = None
extra_tags: Optional[List[str]] = None
debug_log: Optional[Path] = None
native_progress: bool = False
clip_sections: Optional[str] = None
playlist_items: Optional[
str] = None # yt-dlp --playlist-items format (e.g., "1-3,5,8")
2025-11-25 20:09:33 -08:00
no_playlist: bool = False # If True, pass --no-playlist to yt-dlp
2025-12-11 12:47:30 -08:00
quiet: bool = False # If True, suppress all console output (progress, debug logs)
2025-12-16 23:23:43 -08:00
embed_chapters: bool = False # If True, pass yt-dlp --embed-chapters / embedchapters
write_sub: bool = False # If True, download subtitles (writesubtitles/writeautomaticsub)
2025-11-25 20:09:33 -08:00
class SendFunc(Protocol):
"""Protocol for event sender function."""
2025-12-29 17:05:03 -08:00
def __call__(self, event: str, **payload: Any) -> None:
...
2025-11-25 20:09:33 -08:00
@dataclass(slots=True)
class DownloadMediaResult:
"""Result of a successful media download."""
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
path: Path
info: Dict[str, Any]
2025-12-11 23:21:45 -08:00
tag: List[str]
2025-11-25 20:09:33 -08:00
source_url: Optional[str]
hash_value: Optional[str] = None
2025-12-01 14:42:30 -08:00
paths: Optional[List[Path]] = None # For multiple files (e.g., section downloads)
2025-11-25 20:09:33 -08:00
@dataclass(slots=True)
class DebugLogger:
"""Logs events to a JSON debug file for troubleshooting downloads."""
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
path: Path
file: Optional[TextIO] = None
session_started: bool = False
def ensure_open(self) -> None:
"""Open the debug log file if not already open."""
if self.file is not None:
return
try:
parent = self.path.parent
if parent and not parent.exists():
parent.mkdir(parents=True, exist_ok=True)
self.file = self.path.open("a", encoding="utf-8")
except OSError as exc: # pragma: no cover - surfaces to stderr
print(f"Failed to open debug log {self.path}: {exc}", file=sys.stderr)
self.file = None
return
self._write_session_header()
def _write_session_header(self) -> None:
"""Write session start marker to log."""
if self.session_started:
return
self.session_started = True
self.write_record("session-start",
{
"pid": os.getpid(),
"exe": sys.executable
})
2025-11-25 20:09:33 -08:00
def write_raw(self, text: str) -> None:
"""Write raw text to debug log."""
self.ensure_open()
if self.file is None:
return
self.file.write(text + "\n")
self.file.flush()
def write_record(
self,
event: str,
payload: Optional[Dict[str,
Any]] = None
) -> None:
2025-11-25 20:09:33 -08:00
"""Write a structured event record to debug log."""
record = {
"timestamp": datetime.datetime.utcnow().isoformat(timespec="seconds") + "Z",
"event": event,
"payload": payload,
}
self.write_raw(json.dumps(_sanitise_for_json(record), ensure_ascii=False))
def close(self) -> None:
"""Close the debug log file."""
if self.file is None:
return
try:
self.file.close()
finally:
self.file = None
def _sanitise_for_json(
value: Any,
*,
max_depth: int = 8,
_seen: Optional[set[int]] = None
) -> Any:
2025-11-25 20:09:33 -08:00
"""Best-effort conversion to JSON-serialisable types without raising on cycles."""
import math
from dataclasses import asdict, is_dataclass
if value is None or isinstance(value, (str, bool)):
return value
if isinstance(value, (int, float)):
if isinstance(value, float) and not math.isfinite(value):
return repr(value)
return value
if isinstance(value, Path):
return str(value)
if isinstance(value, bytes):
try:
return value.decode()
except Exception:
return value.hex()
if max_depth <= 0:
return repr(value)
if _seen is None:
_seen = set()
obj_id = id(value)
if obj_id in _seen:
return "<circular>"
_seen.add(obj_id)
try:
if isinstance(value, dict):
return {
str(key): _sanitise_for_json(val,
max_depth=max_depth - 1,
_seen=_seen)
2025-11-25 20:09:33 -08:00
for key, val in value.items()
}
if isinstance(value, (list, tuple, set)):
iterable = value if not isinstance(value, set) else list(value)
return [
_sanitise_for_json(item,
max_depth=max_depth - 1,
_seen=_seen) for item in iterable
2025-11-25 20:09:33 -08:00
]
if is_dataclass(value) and not isinstance(value, type):
return _sanitise_for_json(
asdict(value),
max_depth=max_depth - 1,
_seen=_seen
)
2025-11-25 20:09:33 -08:00
finally:
_seen.discard(obj_id)
return repr(value)
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
class ProgressBar:
2025-12-20 23:57:44 -08:00
"""Rich progress helper for byte-based transfers.
Opinionated: requires `rich` and always renders via Rich.
"""
2025-11-25 20:09:33 -08:00
def __init__(self, width: Optional[int] = None):
2025-12-20 23:57:44 -08:00
"""Initialize progress bar with optional custom width."""
2025-11-25 20:09:33 -08:00
if width is None:
width = shutil.get_terminal_size((80, 20))[0]
self.width = max(40, width) # Minimum 40 chars for readability
2025-12-20 23:57:44 -08:00
self._console: Optional[Console] = None
self._progress: Optional[Progress] = None
self._task_id: Optional[TaskID] = None
2025-12-21 05:10:09 -08:00
# Optional: when a PipelineLiveProgress is active, prefer rendering
# transfers inside it instead of creating a nested Rich Progress.
self._pipeline_ui: Any = None
self._pipeline_label: Optional[str] = None
def _ensure_started(
self,
*,
label: str,
total: Optional[int],
file: Any = None
) -> None:
2025-12-21 05:10:09 -08:00
if self._pipeline_ui is not None and self._pipeline_label:
# Pipeline-backed transfer task is already registered; update its total if needed.
try:
if total is not None and total > 0:
2025-12-29 17:05:03 -08:00
self._pipeline_ui.update_transfer(
label=self._pipeline_label,
completed=None,
total=int(total)
2025-12-29 17:05:03 -08:00
)
2025-12-21 05:10:09 -08:00
except Exception:
pass
return
2025-12-20 23:57:44 -08:00
if self._progress is not None and self._task_id is not None:
if total is not None and total > 0:
self._progress.update(self._task_id, total=int(total))
return
2025-12-21 05:10:09 -08:00
# Prefer integrating with the pipeline Live UI to avoid nested Rich Live instances.
try:
from SYS import pipeline as pipeline_context
2025-12-21 05:10:09 -08:00
ui = pipeline_context.get_live_progress()
if ui is not None and hasattr(ui,
"begin_transfer") and hasattr(
ui,
"update_transfer"):
2025-12-21 05:10:09 -08:00
self._pipeline_ui = ui
self._pipeline_label = str(label or "download")
try:
2025-12-29 17:05:03 -08:00
ui.begin_transfer(
label=self._pipeline_label,
total=int(total) if isinstance(total,
int) and total > 0 else None,
2025-12-29 17:05:03 -08:00
)
2025-12-21 05:10:09 -08:00
except Exception:
# If pipeline integration fails, fall back to standalone progress.
self._pipeline_ui = None
self._pipeline_label = None
else:
return
except Exception:
pass
2025-12-20 23:57:44 -08:00
stream = file if file is not None else sys.stderr
2025-12-21 05:10:09 -08:00
# Use shared stderr console when rendering to stderr (cooperates with PipelineLiveProgress).
if stream is sys.stderr:
try:
from SYS.rich_display import stderr_console
2025-12-21 05:10:09 -08:00
console = stderr_console()
except Exception:
console = Console(file=stream)
else:
console = Console(file=stream)
2025-12-20 23:57:44 -08:00
progress = Progress(
TextColumn("[progress.description]{task.description}"),
BarColumn(),
TaskProgressColumn(),
DownloadColumn(),
TransferSpeedColumn(),
TimeRemainingColumn(),
console=console,
transient=True,
)
progress.start()
task_total = int(total) if isinstance(total, int) and total > 0 else None
task_id: TaskID = progress.add_task(str(label or "download"), total=task_total)
self._console = console
self._progress = progress
self._task_id = task_id
def update(
self,
*,
downloaded: Optional[int],
total: Optional[int],
label: str = "download",
file: Any = None,
) -> None:
if downloaded is None and total is None:
return
self._ensure_started(label=label, total=total, file=file)
2025-12-21 05:10:09 -08:00
if self._pipeline_ui is not None and self._pipeline_label:
try:
self._pipeline_ui.update_transfer(
label=self._pipeline_label,
completed=int(downloaded or 0) if downloaded is not None else None,
total=int(total) if isinstance(total,
int) and total > 0 else None,
2025-12-21 05:10:09 -08:00
)
except Exception:
pass
return
2025-12-20 23:57:44 -08:00
if self._progress is None or self._task_id is None:
return
if total is not None and total > 0:
2025-12-29 17:05:03 -08:00
self._progress.update(
self._task_id,
completed=int(downloaded or 0),
total=int(total),
refresh=True
2025-12-29 17:05:03 -08:00
)
2025-12-20 23:57:44 -08:00
else:
self._progress.update(
self._task_id,
completed=int(downloaded or 0),
refresh=True
)
2025-12-20 23:57:44 -08:00
def finish(self) -> None:
2025-12-21 05:10:09 -08:00
if self._pipeline_ui is not None and self._pipeline_label:
try:
self._pipeline_ui.finish_transfer(label=self._pipeline_label)
except Exception:
pass
finally:
self._pipeline_ui = None
self._pipeline_label = None
return
2025-12-20 23:57:44 -08:00
if self._progress is None:
return
try:
self._progress.stop()
finally:
self._console = None
self._progress = None
self._task_id = None
2025-11-25 20:09:33 -08:00
def format_bytes(self, bytes_val: Optional[float]) -> str:
"""Format bytes to human-readable size.
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
Args:
bytes_val: Number of bytes or None.
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
Returns:
Formatted string (e.g., "123.4 MB", "1.2 GB").
"""
if bytes_val is None or bytes_val <= 0:
return "?.? B"
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
for unit in ("B", "KB", "MB", "GB", "TB"):
if bytes_val < 1024:
return f"{bytes_val:.1f} {unit}"
bytes_val /= 1024
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
return f"{bytes_val:.1f} PB"
2025-12-20 23:57:44 -08:00
# NOTE: rich.Progress handles the visual formatting; format_bytes remains as a general utility.
2025-11-25 20:09:33 -08:00
2025-12-19 15:20:08 -08:00
class ProgressFileReader:
"""File-like wrapper that prints a ProgressBar as bytes are read.
Intended for uploads: pass this wrapper as the file object to httpx/requests.
Progress is written to stderr (so pipelines remain clean).
"""
2025-12-29 17:05:03 -08:00
def __init__(
self,
fileobj: Any,
*,
total_bytes: Optional[int],
label: str = "upload",
min_interval_s: float = 0.25,
):
2025-12-19 15:20:08 -08:00
self._f = fileobj
self._total = int(total_bytes) if total_bytes not in (None, 0, "") else 0
self._label = str(label or "upload")
self._min_interval_s = max(0.05, float(min_interval_s))
self._bar = ProgressBar()
self._start = time.time()
self._last = self._start
self._read = 0
self._done = False
def _render(self) -> None:
if self._done:
return
if self._total <= 0:
return
now = time.time()
if now - self._last < self._min_interval_s:
return
2025-12-29 17:05:03 -08:00
self._bar.update(
downloaded=int(self._read),
total=int(self._total),
label=str(self._label or "upload"),
file=sys.stderr,
)
2025-12-19 15:20:08 -08:00
self._last = now
def _finish(self) -> None:
if self._done:
return
self._done = True
2025-12-20 23:57:44 -08:00
self._bar.finish()
2025-12-19 15:20:08 -08:00
def read(self, size: int = -1) -> Any:
chunk = self._f.read(size)
try:
if chunk:
self._read += len(chunk)
self._render()
else:
# EOF
self._finish()
except Exception:
pass
return chunk
def seek(self, offset: int, whence: int = 0) -> Any:
out = self._f.seek(offset, whence)
try:
pos = int(self._f.tell())
if pos <= 0:
self._read = 0
self._start = time.time()
self._last = self._start
else:
self._read = pos
except Exception:
pass
return out
def tell(self) -> Any:
return self._f.tell()
def close(self) -> None:
try:
self._finish()
except Exception:
pass
return self._f.close()
def __getattr__(self, name: str) -> Any:
return getattr(self._f, name)
2025-11-25 20:09:33 -08:00
# ============================================================================
# PIPELINE EXECUTION CONTEXT
# Consolidated from pipeline_context.py
# ============================================================================
# Note: Pipeline functions and state variables moved to pipeline.py
2025-12-21 05:10:09 -08:00
def _pipeline_progress_item_label(value: Any, *, max_len: int = 72) -> str:
2025-12-21 05:10:09 -08:00
def _clip(text: str) -> str:
text = str(text or "").strip()
if not text:
return "(item)"
if len(text) <= max_len:
return text
return text[:max(0, max_len - 1)] + ""
2025-12-21 05:10:09 -08:00
try:
if isinstance(value, PipeObject):
if value.title:
return _clip(value.title)
if value.url:
return _clip(value.url)
if value.source_url:
return _clip(value.source_url)
if value.path:
return _clip(value.path)
if value.hash:
return _clip(value.hash)
if isinstance(value, dict):
for key in ("title", "url", "source_url", "path", "hash", "target"):
raw = value.get(key)
if raw is not None and str(raw).strip():
return _clip(str(raw))
return _clip(str(value))
except Exception:
return "(item)"
class PipelineLiveProgress:
"""Multi-level pipeline progress UI.
- Each pipeline step (pipe) is a persistent bar.
- Each per-item operation is shown as a transient sub-task (spinner).
Designed to render to stderr so pipelines remain clean.
"""
def __init__(self, pipe_labels: List[str], *, enabled: bool = True) -> None:
self._enabled = bool(enabled)
self._pipe_labels = [str(x) for x in (pipe_labels or [])]
self._console: Optional[Console] = None
self._live: Optional[Live] = None
self._overall: Optional[Progress] = None
self._pipe_progress: Optional[Progress] = None
self._subtasks: Optional[Progress] = None
2025-12-21 16:59:37 -08:00
self._status: Optional[Progress] = None
2025-12-21 05:10:09 -08:00
self._transfers: Optional[Progress] = None
self._overall_task: Optional[TaskID] = None
self._pipe_tasks: List[TaskID] = []
self._transfer_tasks: Dict[str,
TaskID] = {}
2025-12-21 05:10:09 -08:00
2025-12-21 16:59:37 -08:00
# Per-pipe status line shown below the pipe bars.
self._status_tasks: Dict[int,
TaskID] = {}
2025-12-21 16:59:37 -08:00
# When a pipe is operating on a single item, allow percent-based progress
# updates on the pipe bar (0..100) so it doesn't sit at 0% until emit().
self._pipe_percent_mode: Dict[int,
bool] = {}
2025-12-21 16:59:37 -08:00
# Per-pipe step counters used for status lines and percent mapping.
self._pipe_step_total: Dict[int,
int] = {}
self._pipe_step_done: Dict[int,
int] = {}
2025-12-21 16:59:37 -08:00
2025-12-21 05:10:09 -08:00
# Per-pipe state
self._pipe_totals: List[int] = [0 for _ in self._pipe_labels]
self._pipe_done: List[int] = [0 for _ in self._pipe_labels]
self._subtask_ids: List[List[TaskID]] = [[] for _ in self._pipe_labels]
self._subtask_active_index: List[int] = [0 for _ in self._pipe_labels]
# Title line state (active per-item context)
self._active_subtask_text: Optional[str] = None
def _title_text(self) -> str:
"""Compute the Pipeline panel title.
2025-12-21 16:59:37 -08:00
The title remains stable ("Pipeline"). Per-item step detail is rendered
using a dedicated progress bar within the panel.
2025-12-21 05:10:09 -08:00
"""
2025-12-21 16:59:37 -08:00
return "Pipeline"
2025-12-21 05:10:09 -08:00
def set_active_subtask_text(self, text: Optional[str]) -> None:
"""Update the Pipeline panel title to reflect the current in-item step.
This is intentionally lightweight: it does not affect pipe counters.
Cmdlets may call this to surface step-level progress for long-running
single-item work (e.g. Playwright page load -> capture -> convert).
"""
if not self._enabled:
return
try:
value = str(text or "").strip()
except Exception:
value = ""
self._active_subtask_text = value or None
def __rich_console__(self, console: "Console", options: "ConsoleOptions"):
"""Renderable hook used by Rich Live.
Using a dynamic renderable keeps the panel title up to date and animates
the spinner without needing manual Live.update() calls.
"""
pipe_progress = self._pipe_progress
2025-12-21 16:59:37 -08:00
status = self._status
2025-12-21 05:10:09 -08:00
transfers = self._transfers
overall = self._overall
if pipe_progress is None or transfers is None or overall is None:
# Not started (or stopped).
yield Panel("", title="Pipeline", expand=False)
return
2025-12-21 16:59:37 -08:00
body_parts: List[Any] = [pipe_progress]
if status is not None and self._status_tasks:
body_parts.append(status)
body_parts.append(transfers)
yield Group(
Panel(Group(*body_parts),
title=self._title_text(),
expand=False),
overall
)
2025-12-21 05:10:09 -08:00
def _render_group(self) -> Group:
# Backward-compatible helper (some callers may still expect a Group).
pipe_progress = self._pipe_progress
2025-12-21 16:59:37 -08:00
status = self._status
2025-12-21 05:10:09 -08:00
transfers = self._transfers
overall = self._overall
assert pipe_progress is not None
assert transfers is not None
assert overall is not None
2025-12-21 16:59:37 -08:00
body_parts: List[Any] = [pipe_progress]
if status is not None and self._status_tasks:
body_parts.append(status)
body_parts.append(transfers)
return Group(
Panel(Group(*body_parts),
title=self._title_text(),
expand=False),
overall
)
2025-12-21 05:10:09 -08:00
def start(self) -> None:
if not self._enabled:
return
if self._live is not None:
return
# IMPORTANT: use the shared stderr Console instance so that any
# `stderr_console().print(...)` calls from inside cmdlets (e.g. preflight
2026-01-01 20:37:27 -08:00
# tables/prompts in download-file) cooperate with Rich Live rendering.
2025-12-21 05:10:09 -08:00
# If we create a separate Console(file=sys.stderr), output will fight for
# terminal cursor control and appear "blocked"/truncated.
from SYS.rich_display import stderr_console
2025-12-21 05:10:09 -08:00
self._console = stderr_console()
# Persistent per-pipe bars.
self._pipe_progress = Progress(
TextColumn("{task.description}"),
TimeElapsedColumn(),
BarColumn(),
TaskProgressColumn(),
console=self._console,
transient=False,
)
# Transient, per-item spinner for the currently-active subtask.
self._subtasks = Progress(
TextColumn(" "),
SpinnerColumn("simpleDots"),
TextColumn("{task.description}"),
console=self._console,
transient=False,
)
2025-12-21 16:59:37 -08:00
# Status line below the pipe bars. Kept simple (no extra bar) so it
# doesn't visually offset the main pipe bar columns.
self._status = Progress(
TextColumn(" [bold]└─ {task.description}[/bold]"),
console=self._console,
transient=False,
)
2025-12-21 05:10:09 -08:00
# Byte-based transfer bars (download/upload) integrated into the Live view.
self._transfers = Progress(
TextColumn(" {task.description}"),
BarColumn(),
TaskProgressColumn(),
DownloadColumn(),
TransferSpeedColumn(),
TimeRemainingColumn(),
console=self._console,
transient=False,
)
self._overall = Progress(
TimeElapsedColumn(),
BarColumn(),
TextColumn("{task.description}"),
console=self._console,
transient=False,
)
# Create pipe tasks up-front so the user sees the pipe structure immediately.
self._pipe_tasks = []
for idx, label in enumerate(self._pipe_labels):
# Start timers only when the pipe actually begins.
task_id = self._pipe_progress.add_task(
f"{idx + 1}/{len(self._pipe_labels)} {label}",
total=1,
start=False,
)
self._pipe_progress.update(task_id, completed=0, total=1)
self._pipe_tasks.append(task_id)
self._overall_task = self._overall.add_task(
f"Pipeline: 0/{len(self._pipe_labels)} pipes completed",
total=max(1,
len(self._pipe_labels)),
2025-12-21 05:10:09 -08:00
)
self._live = Live(
self,
console=self._console,
refresh_per_second=10,
transient=True
)
2025-12-21 05:10:09 -08:00
self._live.start()
def pause(self) -> None:
"""Temporarily stop Live rendering without losing progress state."""
if self._live is None:
return
try:
self._live.stop()
finally:
self._live = None
def resume(self) -> None:
"""Resume Live rendering after pause()."""
if not self._enabled:
return
if self._live is not None:
return
if (self._console is None or self._pipe_progress is None
or self._subtasks is None or self._transfers is None
or self._overall is None):
2025-12-21 05:10:09 -08:00
# Not initialized yet; start fresh.
self.start()
return
self._live = Live(
self,
console=self._console,
refresh_per_second=10,
transient=True
)
2025-12-21 05:10:09 -08:00
self._live.start()
def stop(self) -> None:
# Safe to call whether Live is running or paused.
if self._live is not None:
try:
self._live.stop()
except Exception:
pass
self._live = None
self._console = None
self._overall = None
self._pipe_progress = None
self._subtasks = None
2025-12-21 16:59:37 -08:00
self._status = None
2025-12-21 05:10:09 -08:00
self._transfers = None
self._overall_task = None
self._pipe_tasks = []
self._transfer_tasks = {}
2025-12-21 16:59:37 -08:00
self._status_tasks = {}
self._pipe_percent_mode = {}
self._pipe_step_total = {}
self._pipe_step_done = {}
2025-12-21 05:10:09 -08:00
self._active_subtask_text = None
2025-12-21 16:59:37 -08:00
def _hide_pipe_subtasks(self, pipe_index: int) -> None:
"""Hide any visible per-item spinner rows for a pipe."""
subtasks = self._subtasks
if subtasks is None:
return
try:
for sub_id in self._subtask_ids[int(pipe_index)]:
try:
subtasks.stop_task(sub_id)
subtasks.update(sub_id, visible=False)
except Exception:
pass
except Exception:
pass
def set_pipe_status_text(self, pipe_index: int, text: str) -> None:
"""Set a status line under the pipe bars for the given pipe."""
if not self._enabled:
return
if not self._ensure_pipe(int(pipe_index)):
return
prog = self._status
if prog is None:
return
try:
pidx = int(pipe_index)
msg = str(text or "").strip()
except Exception:
return
# For long single-item work, hide the per-item spinner line and use this
# dedicated status line instead.
if self._pipe_percent_mode.get(pidx, False):
try:
self._hide_pipe_subtasks(pidx)
except Exception:
pass
task_id = self._status_tasks.get(pidx)
if task_id is None:
try:
task_id = prog.add_task(msg)
except Exception:
return
self._status_tasks[pidx] = task_id
try:
prog.update(task_id, description=msg, refresh=True)
except Exception:
pass
def clear_pipe_status_text(self, pipe_index: int) -> None:
prog = self._status
if prog is None:
return
try:
pidx = int(pipe_index)
except Exception:
return
task_id = self._status_tasks.pop(pidx, None)
if task_id is None:
return
try:
prog.remove_task(task_id)
except Exception:
pass
def set_pipe_percent(self, pipe_index: int, percent: int) -> None:
"""Update the pipe bar as a percent (only when single-item mode is enabled)."""
if not self._enabled:
return
if not self._ensure_pipe(int(pipe_index)):
return
pipe_progress = self._pipe_progress
if pipe_progress is None:
return
try:
pidx = int(pipe_index)
except Exception:
return
if not self._pipe_percent_mode.get(pidx, False):
return
try:
pct = max(0, min(100, int(percent)))
pipe_task = self._pipe_tasks[pidx]
pipe_progress.update(pipe_task, completed=pct, total=100, refresh=True)
except Exception:
pass
def begin_pipe_steps(self, pipe_index: int, *, total_steps: int) -> None:
"""Initialize step tracking for a pipe.
The cmdlet must call this once up-front so we can map steps to percent.
"""
if not self._enabled:
return
if not self._ensure_pipe(int(pipe_index)):
return
try:
pidx = int(pipe_index)
tot = max(1, int(total_steps))
except Exception:
return
self._pipe_step_total[pidx] = tot
self._pipe_step_done[pidx] = 0
# Reset status line and percent.
try:
self.clear_pipe_status_text(pidx)
except Exception:
pass
try:
self.set_pipe_percent(pidx, 0)
except Exception:
pass
def advance_pipe_step(self, pipe_index: int, text: str) -> None:
"""Advance the pipe's step counter by one.
Each call is treated as a new step (no in-place text rewrites).
Updates:
- status line: "i/N step: {text}"
- pipe percent (single-item pipes only): round(i/N*100)
"""
if not self._enabled:
return
if not self._ensure_pipe(int(pipe_index)):
return
try:
pidx = int(pipe_index)
except Exception:
return
total = int(self._pipe_step_total.get(pidx, 0) or 0)
if total <= 0:
# If steps weren't declared, treat as a single-step operation.
total = 1
self._pipe_step_total[pidx] = total
done = int(self._pipe_step_done.get(pidx, 0) or 0) + 1
done = min(done, total)
self._pipe_step_done[pidx] = done
msg = str(text or "").strip()
line = f"{done}/{total} step: {msg}" if msg else f"{done}/{total} step"
try:
self.set_pipe_status_text(pidx, line)
except Exception:
pass
# Percent mapping only applies when the pipe is in percent mode (single-item).
try:
pct = 100 if done >= total else int(round((done / max(1, total)) * 100.0))
self.set_pipe_percent(pidx, pct)
except Exception:
pass
2025-12-21 05:10:09 -08:00
def begin_transfer(self, *, label: str, total: Optional[int] = None) -> None:
if not self._enabled:
return
if self._transfers is None:
return
key = str(label or "transfer")
if key in self._transfer_tasks:
# If it already exists, treat as an update to total.
try:
if total is not None and total > 0:
self._transfers.update(self._transfer_tasks[key], total=int(total))
except Exception:
pass
return
task_total = int(total) if isinstance(total, int) and total > 0 else None
try:
task_id = self._transfers.add_task(key, total=task_total)
self._transfer_tasks[key] = task_id
except Exception:
pass
2025-12-29 17:05:03 -08:00
def update_transfer(
self,
*,
label: str,
completed: Optional[int],
total: Optional[int] = None
2025-12-29 17:05:03 -08:00
) -> None:
2025-12-21 05:10:09 -08:00
if not self._enabled:
return
if self._transfers is None:
return
key = str(label or "transfer")
if key not in self._transfer_tasks:
self.begin_transfer(label=key, total=total)
task_id = self._transfer_tasks.get(key)
if task_id is None:
return
try:
kwargs: Dict[str,
Any] = {}
2025-12-21 05:10:09 -08:00
if completed is not None:
kwargs["completed"] = int(completed)
if total is not None and total > 0:
kwargs["total"] = int(total)
self._transfers.update(task_id, refresh=True, **kwargs)
except Exception:
pass
def finish_transfer(self, *, label: str) -> None:
if self._transfers is None:
return
key = str(label or "transfer")
task_id = self._transfer_tasks.pop(key, None)
if task_id is None:
return
try:
self._transfers.remove_task(task_id)
except Exception:
pass
def _ensure_pipe(self, pipe_index: int) -> bool:
if not self._enabled:
return False
if self._pipe_progress is None or self._subtasks is None or self._overall is None:
return False
if pipe_index < 0 or pipe_index >= len(self._pipe_labels):
return False
return True
2025-12-29 17:05:03 -08:00
def begin_pipe(
self,
pipe_index: int,
*,
total_items: int,
items_preview: Optional[List[Any]] = None
2025-12-29 17:05:03 -08:00
) -> None:
2025-12-21 05:10:09 -08:00
if not self._ensure_pipe(pipe_index):
return
pipe_progress = self._pipe_progress
subtasks = self._subtasks
assert pipe_progress is not None
assert subtasks is not None
total_items = int(total_items) if isinstance(total_items, int) else 0
total_items = max(1, total_items)
self._pipe_totals[pipe_index] = total_items
self._pipe_done[pipe_index] = 0
self._subtask_active_index[pipe_index] = 0
self._subtask_ids[pipe_index] = []
2025-12-21 16:59:37 -08:00
# Reset per-item step progress for this pipe.
try:
self.clear_pipe_status_text(pipe_index)
except Exception:
pass
try:
self._pipe_step_total.pop(pipe_index, None)
self._pipe_step_done.pop(pipe_index, None)
except Exception:
pass
# If this pipe will process exactly one item, allow percent-based updates.
percent_mode = bool(int(total_items) == 1)
self._pipe_percent_mode[pipe_index] = percent_mode
2025-12-21 05:10:09 -08:00
pipe_task = self._pipe_tasks[pipe_index]
pipe_progress.update(
pipe_task,
completed=0,
total=(100 if percent_mode else total_items)
)
2025-12-21 05:10:09 -08:00
# Start the per-pipe timer now that the pipe is actually running.
try:
pipe_progress.start_task(pipe_task)
except Exception:
pass
labels: List[str] = []
if isinstance(items_preview, list) and items_preview:
labels = [_pipeline_progress_item_label(x) for x in items_preview]
2025-12-21 16:59:37 -08:00
# For single-item pipes, keep the UI clean: don't show a spinner row.
if percent_mode:
self._subtask_ids[pipe_index] = []
self._active_subtask_text = None
return
2025-12-21 05:10:09 -08:00
for i in range(total_items):
suffix = labels[i] if i < len(labels) else f"item {i + 1}/{total_items}"
# Use start=False so elapsed time starts when we explicitly start_task().
sub_id = subtasks.add_task(
f"{self._pipe_labels[pipe_index]}: {suffix}",
start=False
)
2025-12-21 05:10:09 -08:00
subtasks.update(sub_id, visible=False)
self._subtask_ids[pipe_index].append(sub_id)
# Show the first subtask spinner.
if self._subtask_ids[pipe_index]:
first = self._subtask_ids[pipe_index][0]
subtasks.update(first, visible=True)
subtasks.start_task(first)
try:
t = subtasks.tasks[first]
self._active_subtask_text = str(getattr(t,
"description",
"") or "").strip() or None
2025-12-21 05:10:09 -08:00
except Exception:
self._active_subtask_text = None
def on_emit(self, pipe_index: int, emitted: Any) -> None:
if not self._ensure_pipe(pipe_index):
return
pipe_progress = self._pipe_progress
subtasks = self._subtasks
assert pipe_progress is not None
assert subtasks is not None
done = self._pipe_done[pipe_index]
total = self._pipe_totals[pipe_index]
active = self._subtask_active_index[pipe_index]
# If a stage emits more than expected, extend totals dynamically.
if done >= total:
total = done + 1
self._pipe_totals[pipe_index] = total
pipe_task = self._pipe_tasks[pipe_index]
pipe_progress.update(pipe_task, total=total)
# Add a placeholder subtask.
sub_id = subtasks.add_task(
f"{self._pipe_labels[pipe_index]}: {_pipeline_progress_item_label(emitted)}"
)
subtasks.stop_task(sub_id)
subtasks.update(sub_id, visible=False)
self._subtask_ids[pipe_index].append(sub_id)
# Complete & hide current active subtask.
if active < len(self._subtask_ids[pipe_index]):
current = self._subtask_ids[pipe_index][active]
try:
# If we didnt have a preview label, set it now.
subtasks.update(
current,
description=
f"{self._pipe_labels[pipe_index]}: {_pipeline_progress_item_label(emitted)}",
2025-12-21 05:10:09 -08:00
)
except Exception:
pass
subtasks.stop_task(current)
subtasks.update(current, visible=False)
done += 1
self._pipe_done[pipe_index] = done
pipe_task = self._pipe_tasks[pipe_index]
2025-12-21 16:59:37 -08:00
if self._pipe_percent_mode.get(pipe_index, False):
pipe_progress.update(pipe_task, completed=100, total=100)
else:
pipe_progress.update(pipe_task, completed=done)
# Clear any status line now that it emitted.
try:
self.clear_pipe_status_text(pipe_index)
except Exception:
pass
try:
self._pipe_step_total.pop(pipe_index, None)
self._pipe_step_done.pop(pipe_index, None)
except Exception:
pass
2025-12-21 05:10:09 -08:00
# Start next subtask spinner.
next_index = active + 1
self._subtask_active_index[pipe_index] = next_index
if next_index < len(self._subtask_ids[pipe_index]):
nxt = self._subtask_ids[pipe_index][next_index]
subtasks.update(nxt, visible=True)
subtasks.start_task(nxt)
try:
t = subtasks.tasks[nxt]
self._active_subtask_text = str(getattr(t,
"description",
"") or "").strip() or None
2025-12-21 05:10:09 -08:00
except Exception:
self._active_subtask_text = None
else:
self._active_subtask_text = None
def finish_pipe(self, pipe_index: int, *, force_complete: bool = True) -> None:
if not self._ensure_pipe(pipe_index):
return
pipe_progress = self._pipe_progress
subtasks = self._subtasks
overall = self._overall
assert pipe_progress is not None
assert subtasks is not None
assert overall is not None
total = self._pipe_totals[pipe_index]
done = self._pipe_done[pipe_index]
# Ensure the pipe bar finishes even if cmdlet didnt emit per item.
if force_complete and done < total:
pipe_task = self._pipe_tasks[pipe_index]
2025-12-21 16:59:37 -08:00
if self._pipe_percent_mode.get(pipe_index, False):
pipe_progress.update(pipe_task, completed=100, total=100)
else:
pipe_progress.update(pipe_task, completed=total)
2025-12-21 05:10:09 -08:00
self._pipe_done[pipe_index] = total
# Hide any remaining subtask spinners.
for sub_id in self._subtask_ids[pipe_index]:
try:
subtasks.stop_task(sub_id)
subtasks.update(sub_id, visible=False)
except Exception:
pass
# If we just finished the active pipe, clear the title context.
self._active_subtask_text = None
2025-12-21 16:59:37 -08:00
# Ensure status line is cleared when a pipe finishes.
try:
self.clear_pipe_status_text(pipe_index)
except Exception:
pass
try:
self._pipe_step_total.pop(pipe_index, None)
self._pipe_step_done.pop(pipe_index, None)
except Exception:
pass
2025-12-21 05:10:09 -08:00
# Stop the per-pipe timer once the pipe is finished.
try:
pipe_task = self._pipe_tasks[pipe_index]
pipe_progress.stop_task(pipe_task)
except Exception:
pass
if self._overall_task is not None:
completed = 0
try:
2025-12-29 17:05:03 -08:00
completed = sum(
1 for i in range(len(self._pipe_labels))
2025-12-29 17:05:03 -08:00
if self._pipe_done[i] >= max(1, self._pipe_totals[i])
)
2025-12-21 05:10:09 -08:00
except Exception:
completed = 0
overall.update(
self._overall_task,
completed=min(completed,
max(1,
len(self._pipe_labels))),
description=
f"Pipeline: {completed}/{len(self._pipe_labels)} pipes completed",
2025-12-21 05:10:09 -08:00
)
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
class PipelineStageContext:
2025-12-21 05:10:09 -08:00
"""Context information for the current pipeline stage."""
def __init__(
self,
stage_index: int,
total_stages: int,
2025-12-21 16:59:37 -08:00
pipe_index: Optional[int] = None,
2025-12-21 05:10:09 -08:00
worker_id: Optional[str] = None,
on_emit: Optional[Callable[[Any],
None]] = None,
2025-12-21 05:10:09 -08:00
):
self.stage_index = stage_index
self.total_stages = total_stages
2025-12-29 17:05:03 -08:00
self.is_last_stage = stage_index == total_stages - 1
2025-12-21 16:59:37 -08:00
self.pipe_index = int(pipe_index) if pipe_index is not None else None
2025-12-21 05:10:09 -08:00
self.worker_id = worker_id
self._on_emit = on_emit
self.emits: List[Any] = []
def emit(self, obj: Any) -> None:
"""Emit an object to the next pipeline stage."""
self.emits.append(obj)
cb = getattr(self, "_on_emit", None)
if cb:
try:
cb(obj)
except Exception:
pass
def get_current_command_text(self) -> str:
"""Get the current command text (for backward compatibility)."""
# This is maintained for backward compatibility with old code
# In a real implementation, this would come from the stage context
return ""
def __repr__(self) -> str:
return (
f"PipelineStageContext(stage={self.stage_index}/{self.total_stages}, "
2025-12-21 16:59:37 -08:00
f"pipe_index={self.pipe_index}, is_last={self.is_last_stage}, worker_id={self.worker_id})"
2025-12-21 05:10:09 -08:00
)
2025-11-25 20:09:33 -08:00
# ============================================================================
# RESULT TABLE CLASSES
# Consolidated from result_table.py
# ============================================================================
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
@dataclass
class InputOption:
"""Represents an interactive input option (cmdlet argument) in a table.
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
Allows users to select options that translate to cmdlet arguments,
enabling interactive configuration right from the result table.
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
Example:
# Create an option for location selection
location_opt = InputOption(
"location",
type="enum",
choices=["local", "hydrus", "0x0"],
description="Download destination"
)
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
# Use in result table
table.add_input_option(location_opt)
selected = table.select_option("location") # Returns user choice
"""
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
name: str
"""Option name (maps to cmdlet argument)"""
type: str = "string"
"""Option type: 'string', 'enum', 'flag', 'integer'"""
choices: List[str] = field(default_factory=list)
"""Valid choices for enum type"""
default: Optional[str] = None
"""Default value if not specified"""
description: str = ""
"""Description of what this option does"""
validator: Optional[Callable[[str], bool]] = None
"""Optional validator function: takes value, returns True if valid"""
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
def to_dict(self) -> Dict[str, Any]:
"""Convert to dictionary."""
return {
"name": self.name,
"type": self.type,
"choices": self.choices if self.choices else None,
"default": self.default,
"description": self.description,
}
@dataclass
class TUIResultCard:
"""Represents a result as a UI card with title, metadata, and actions.
2025-12-29 17:05:03 -08:00
Used in hub-ui and TUI contexts to render individual search results
2025-11-25 20:09:33 -08:00
as grouped components with visual structure.
"""
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
title: str
subtitle: Optional[str] = None
metadata: Optional[Dict[str, str]] = None
media_kind: Optional[str] = None
2025-12-11 23:21:45 -08:00
tag: Optional[List[str]] = None
2025-11-25 20:09:33 -08:00
file_hash: Optional[str] = None
file_size: Optional[str] = None
duration: Optional[str] = None
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
def __post_init__(self):
"""Initialize default values."""
if self.metadata is None:
self.metadata = {}
2025-12-11 23:21:45 -08:00
if self.tag is None:
self.tag = []
2025-11-25 20:09:33 -08:00
@dataclass
class ResultColumn:
"""Represents a single column in a result table."""
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
name: str
value: str
width: Optional[int] = None
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
def __str__(self) -> str:
"""String representation of the column."""
return f"{self.name}: {self.value}"
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
def to_dict(self) -> Dict[str, str]:
"""Convert to dictionary."""
return {
"name": self.name,
"value": self.value
}
2025-11-25 20:09:33 -08:00
@dataclass
class ResultRow:
"""Represents a single row in a result table."""
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
columns: List[ResultColumn] = field(default_factory=list)
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
def add_column(self, name: str, value: Any) -> None:
"""Add a column to this row."""
str_value = str(value) if value is not None else ""
self.columns.append(ResultColumn(name, str_value))
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
def get_column(self, name: str) -> Optional[str]:
"""Get column value by name."""
for col in self.columns:
if col.name.lower() == name.lower():
return col.value
return None
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
def to_dict(self) -> List[Dict[str, str]]:
"""Convert to list of column dicts."""
return [col.to_dict() for col in self.columns]
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
def to_list(self) -> List[tuple[str, str]]:
"""Convert to list of (name, value) tuples."""
return [(col.name, col.value) for col in self.columns]
2025-12-29 17:05:03 -08:00
2025-11-25 20:09:33 -08:00
def __str__(self) -> str:
"""String representation of the row."""
2025-12-29 17:05:03 -08:00
return " | ".join(str(col) for col in self.columns)