-
Notifications
You must be signed in to change notification settings - Fork 23
Expand file tree
/
Copy path_console.py
More file actions
405 lines (325 loc) · 12.5 KB
/
_console.py
File metadata and controls
405 lines (325 loc) · 12.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
from __future__ import annotations
from contextlib import contextmanager
from enum import Enum
from typing import Any, Iterator, NoReturn, Type
import click
from rich.console import Console
from rich.live import Live
from rich.progress import (
Progress,
SpinnerColumn,
TaskID,
TextColumn,
TimeElapsedColumn,
)
from rich.spinner import Spinner as RichSpinner
from rich.text import Text
class LogLevel(Enum):
"""Enum for log levels with corresponding emojis."""
INFO = ""
SUCCESS = click.style("✓ ", fg="green", bold=True)
WARNING = "⚠️"
ERROR = "❌"
HINT = "💡"
CONFIG = "🔧"
SELECT = "👇"
LINK = "🔗"
MAGIC = "✨"
class CLIError(Exception):
"""Raised by CliLogger.error() in non-console output modes.
Caught by LazyGroup.invoke() to emit structured error output.
"""
def __init__(self, message: str, messages: list[dict[str, str]] | None = None):
self.message = message
self.messages = messages or []
super().__init__(message)
class CliLogger:
"""A singleton wrapper class for terminal output with emoji support and spinners."""
# Class variable to hold the singleton instance
_instance: CliLogger | None = None
def __new__(cls: Type[CliLogger]) -> CliLogger:
"""Ensure only one instance of CliLogger is created.
Returns:
The singleton instance of CliLogger
"""
if cls._instance is None:
cls._instance = super(CliLogger, cls).__new__(cls)
cls._instance._initialized = False
return cls._instance
def __init__(self):
"""Initialize the CliLogger (only once)."""
# Only initialize once
if not getattr(self, "_initialized", False):
self._console = Console()
self._spinner_live: Live | None = None
self._spinner = RichSpinner("dots")
self._progress: Progress | None = None
self._progress_tasks: dict[str, TaskID] = {}
self._initialized = True
self._output_mode: str = "console"
self._messages: list[dict[str, str]] = []
self._result: Any = None
@property
def output_mode(self) -> str:
"""Get the current output mode."""
return self._output_mode
@output_mode.setter
def output_mode(self, value: str) -> None:
"""Set the output mode and reset collected state."""
self._output_mode = value
self._messages = []
self._result = None
def _stop_spinner_if_active(self) -> None:
"""Internal method to stop the spinner if it's active."""
if self._spinner_live and self._spinner_live.is_started:
self._spinner_live.stop()
self._spinner_live = None
def _stop_progress_if_active(self) -> None:
"""Internal method to stop the progress if it's active."""
if self._progress:
self._progress.stop()
self._progress = None
self._progress_tasks.clear()
def log(
self, message: str, level: LogLevel = LogLevel.INFO, fg: str | None = None
) -> None:
"""Log a message with the specified level and optional color.
Args:
message: The message to log
level: The log level (determines the emoji)
fg: Optional foreground color for the message
"""
if self._output_mode != "console":
level_name = level.name.lower()
self._messages.append({"level": level_name, "message": message})
return
# Stop any active spinner before logging
self._stop_spinner_if_active()
if not level == LogLevel.INFO:
emoji = level.value
if fg:
formatted_message = f"{emoji} {click.style(message, fg=fg)}"
else:
formatted_message = f"{emoji} {message}"
else:
formatted_message = message
click.echo(formatted_message, err=LogLevel.ERROR in (level,))
def success(self, message: str) -> None:
"""Log a success message."""
self.log(message, LogLevel.SUCCESS)
def error(self, message: str, include_traceback: bool = False) -> NoReturn:
"""Log an error message with optional traceback.
Args:
message: The error message to display
include_traceback: Whether to include the current exception traceback
"""
if include_traceback:
import sys
import traceback
exc_type, exc_value, exc_tb = sys.exc_info()
if exc_value is not None:
tb = "".join(
traceback.format_exception(exc_type, exc_value, exc_tb, chain=False)
)
message = f"{message}\n{tb}"
if self._output_mode != "console":
raise CLIError(message, messages=list(self._messages))
self.log(message, LogLevel.ERROR, "red")
click.get_current_context().exit(1)
def warning(self, message: str) -> None:
"""Log a warning message."""
self.log(message, LogLevel.WARNING, "yellow")
def info(self, message: str) -> None:
"""Log an informational message."""
self.log(message, LogLevel.INFO)
def hint(self, message: str) -> None:
"""Log a hint message."""
self.log(message, LogLevel.HINT)
def magic(self, message: str) -> None:
"""Log a magic message."""
self.log(message, LogLevel.MAGIC, "green")
def config(self, message: str) -> None:
"""Log a configuration message."""
self.log(message, LogLevel.CONFIG)
def select(self, message: str) -> None:
"""Log a selection message."""
self.log(message, LogLevel.SELECT)
def link(self, message: str, url: str) -> None:
"""Log a clickable link.
Args:
message: The message to display
url: The URL to link to
"""
formatted_url = f"\u001b]8;;{url}\u001b\\{url}\u001b]8;;\u001b\\"
self.log(
f"{message} {click.style(formatted_url, fg='bright_blue', bold=True)}",
LogLevel.LINK,
)
def prompt(self, message: str, **kwargs: Any) -> Any:
"""Wrapper for click.prompt with emoji.
Args:
message: The prompt message
**kwargs: Additional arguments to pass to click.prompt
Returns:
The user's input
"""
# Stop any active spinner before prompting
self._stop_spinner_if_active()
return click.prompt(click.style(f"{message}", fg="yellow", bold=True), **kwargs)
def confirm(
self, message: str, default: bool = False, fg: str = "cyan", **kwargs: Any
) -> bool:
"""Wrapper for click.confirm with styled text.
Args:
message: The confirmation message
default: Default value if user just presses Enter
fg: Foreground color for the message (default: cyan)
**kwargs: Additional arguments to pass to click.confirm
Returns:
True if user confirms, False otherwise
"""
# Stop any active spinner before prompting
self._stop_spinner_if_active()
return click.confirm(click.style(message, fg=fg), default=default, **kwargs)
def display_options(
self, options: list[Any], message: str = "Select an option:"
) -> None:
"""Display a list of options with indices.
Args:
options: List of options to display
message: Optional message to display before the options
"""
self.select(message)
for idx, option in enumerate(options, start=0):
click.echo(f" {idx}: {option}")
@contextmanager
def spinner(self, message: str = "") -> Iterator[None]:
"""Context manager for spinner operations.
Args:
message: The message to display alongside the spinner
Yields:
None
"""
if self._output_mode != "console":
yield
return
try:
# Stop any existing spinner before starting a new one
self._stop_spinner_if_active()
self._spinner.text = Text(message)
self._spinner_live = Live(
self._spinner,
console=self._console,
refresh_per_second=10,
transient=False,
auto_refresh=True,
)
self._spinner_live.start()
yield
finally:
self._stop_spinner_if_active()
def update_spinner(self, message: str) -> None:
"""Update the message of an active spinner.
Args:
message: The new message to display
"""
if self._spinner_live and self._spinner_live.is_started:
self._spinner.text = Text(message)
@contextmanager
def evaluation_progress(
self, evaluations: list[dict[str, str]]
) -> Iterator["EvaluationProgressManager"]:
"""Context manager for evaluation progress tracking.
Args:
evaluations: List of evaluation items with 'id' and 'name' keys
Yields:
EvaluationProgressManager instance
"""
try:
# Stop any existing progress or spinner
self._stop_spinner_if_active()
self._stop_progress_if_active()
# Create progress with custom columns
self._progress = Progress(
SpinnerColumn(),
TextColumn("[bold blue]{task.description}"),
TimeElapsedColumn(),
console=self._console,
transient=False,
)
# Add tasks for each evaluation
for eval_item in evaluations:
task_id = self._progress.add_task(eval_item["name"], total=1)
self._progress_tasks[eval_item["id"]] = task_id
self._progress.start()
yield EvaluationProgressManager(self._progress, self._progress_tasks)
finally:
self._stop_progress_if_active()
def set_result(self, data: Any) -> None:
"""Store structured result data for JSON output."""
self._result = data
def emit(self) -> None:
"""Emit collected output. Only does something in non-console modes."""
if self._output_mode == "console":
return
import json
output: dict[str, Any] = {"status": "success"}
if self._messages:
output["messages"] = self._messages
if self._result is not None:
output["data"] = self._result
click.echo(json.dumps(output, indent=2, default=str))
self._messages = []
self._result = None
@classmethod
def get_instance(cls) -> "CliLogger":
"""Get the singleton instance of CliLogger.
Returns:
The singleton instance
"""
if cls._instance is None:
return cls()
return cls._instance
ConsoleLogger = CliLogger
class EvaluationProgressManager:
"""Manager for evaluation progress updates."""
def __init__(self, progress: Progress, tasks: dict[str, TaskID]):
"""Initialize the progress manager.
Args:
progress: The Rich Progress instance
tasks: Mapping of evaluation IDs to task IDs
"""
self.progress = progress
self.tasks = tasks
def complete_evaluation(self, eval_id: str) -> None:
"""Mark an evaluation as completed.
Args:
eval_id: The evaluation ID
"""
if eval_id in self.tasks:
task_id = self.tasks[eval_id]
# Update description to show completion
current_desc = self.progress.tasks[task_id].description
self.progress.update(
task_id,
completed=1,
description=f"[green]✅ {current_desc}[/green]",
)
def fail_evaluation(self, eval_id: str, error_message: str) -> None:
"""Mark an evaluation as failed.
Args:
eval_id: The evaluation ID
error_message: The error message
"""
if eval_id in self.tasks:
task_id = self.tasks[eval_id]
# Truncate error message if too long
short_error = (
error_message[:40] + "..." if len(error_message) > 40 else error_message
)
# Update the description to show failure
current_desc = self.progress.tasks[task_id].description
self.progress.update(
task_id,
description=f"[red]❌ {current_desc} - {short_error}[/red]",
)