Spaces:
Running
Running
File size: 17,484 Bytes
0a4529c |
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 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 |
# DEPENDENCIES
import time
import uuid
from enum import Enum
from typing import Any
from typing import Dict
from typing import List
from typing import Optional
from datetime import datetime
from dataclasses import dataclass
from config.settings import get_settings
from config.logging_config import get_logger
from utils.error_handler import handle_errors
# Setup Settings and Logging
settings = get_settings()
logger = get_logger(__name__)
class TaskStatus(str, Enum):
"""
Task status enumeration
"""
PENDING = "pending"
RUNNING = "running"
COMPLETED = "completed"
FAILED = "failed"
CANCELLED = "cancelled"
@dataclass
class TaskProgress:
"""
Progress tracking data structure
"""
task_id : str
description : str
status : TaskStatus
total_items : int
processed_items : int
current_item : Optional[str]
current_status : str
start_time : datetime
end_time : Optional[datetime]
progress_percent : float
estimated_seconds_remaining : Optional[float]
metadata : Dict[str, Any]
class ProgressTracker:
"""
Comprehensive progress tracking for long-running operations: Provides real-time progress monitoring and status updates
"""
def __init__(self, max_completed_tasks: int = 100):
"""
Initialize progress tracker
Arguments:
----------
max_completed_tasks { int } : Maximum number of completed tasks to keep in history
"""
self.logger = logger
self.max_completed_tasks = max_completed_tasks
# Task storage
self.active_tasks : Dict[str, TaskProgress] = dict()
self.completed_tasks : List[TaskProgress] = list()
self.failed_tasks : List[TaskProgress] = list()
self.logger.info("Initialized ProgressTracker")
def start_task(self, total_items: int, description: str, metadata: Optional[Dict[str, Any]] = None) -> str:
"""
Start tracking a new task
Arguments:
----------
total_items { int } : Total number of items to process
description { str } : Task description
metadata { dict } : Additional task metadata
Returns:
--------
{ str } : Generated task ID
"""
task_id = self._generate_task_id()
task_progress = TaskProgress(task_id = task_id,
description = description,
status = TaskStatus.RUNNING,
total_items = total_items,
processed_items = 0,
current_item = None,
current_status = "Starting...",
start_time = datetime.now(),
end_time = None,
progress_percent = 0.0,
estimated_seconds_remaining = None,
metadata = metadata or {},
)
self.active_tasks[task_id] = task_progress
self.logger.info(f"Started task {task_id}: {description} ({total_items} items)")
return task_id
def update_task(self, task_id: str, processed_items: Optional[int] = None, current_item: Optional[str] = None,
current_status: Optional[str] = None, metadata_update: Optional[Dict[str, Any]] = None) -> bool:
"""
Update task progress
Arguments:
----------
task_id { str } : Task ID to update
processed_items { int } : Number of items processed
current_item { str } : Current item being processed
current_status { str } : Current status message
metadata_update { dict } : Metadata updates
Returns:
--------
{ bool } : True if update successful
"""
if task_id not in self.active_tasks:
self.logger.warning(f"Task {task_id} not found in active tasks")
return False
task = self.active_tasks[task_id]
# Update fields
if processed_items is not None:
task.processed_items = processed_items
if current_item is not None:
task.current_item = current_item
if current_status is not None:
task.current_status = current_status
if metadata_update:
task.metadata.update(metadata_update)
# Calculate progress
if (task.total_items > 0):
task.progress_percent = (task.processed_items / task.total_items) * 100.0
# Estimate remaining time
if (task.processed_items > 0):
elapsed_seconds = (datetime.now() - task.start_time).total_seconds()
items_per_second = task.processed_items / elapsed_seconds
if (items_per_second > 0):
remaining_items = task.total_items - task.processed_items
task.estimated_seconds_remaining = remaining_items / items_per_second
# Ensure progress doesn't exceed 100%
if (task.progress_percent > 100.0):
task.progress_percent = 100.0
self.logger.debug(f"Updated task {task_id}: {task.progress_percent:.1f}% complete")
return True
def complete_task(self, task_id: str, final_metadata: Optional[Dict[str, Any]] = None) -> bool:
"""
Mark task as completed
Arguments:
----------
task_id { str } : Task ID to complete
final_metadata { dict } : Final metadata updates
Returns:
--------
{ bool } : True if completion successful
"""
if task_id not in self.active_tasks:
self.logger.warning(f"Task {task_id} not found for completion")
return False
task = self.active_tasks[task_id]
# Update task
task.status = TaskStatus.COMPLETED
task.end_time = datetime.now()
task.processed_items = task.total_items # Ensure 100% completion
task.progress_percent = 100.0
task.estimated_seconds_remaining = 0.0
task.current_status = "Completed"
if final_metadata:
task.metadata.update(final_metadata)
# Move to completed tasks
self.completed_tasks.append(task)
del self.active_tasks[task_id]
# Maintain history size
if (len(self.completed_tasks) > self.max_completed_tasks):
self.completed_tasks = self.completed_tasks[-self.max_completed_tasks:]
total_time = (task.end_time - task.start_time).total_seconds()
self.logger.info(f"Completed task {task_id}: {task.description} in {total_time:.2f}s")
return True
def fail_task(self, task_id: str, error_message: str, error_details: Optional[Dict[str, Any]] = None) -> bool:
"""
Mark task as failed
Arguments:
----------
task_id { str } : Task ID to mark as failed
error_message { str } : Error message
error_details { dict } : Additional error details
Returns:
--------
{ bool } : True if failure marking successful
"""
if (task_id not in self.active_tasks):
self.logger.warning(f"Task {task_id} not found for failure marking")
return False
task = self.active_tasks[task_id]
# Update task
task.status = TaskStatus.FAILED
task.end_time = datetime.now()
task.current_status = f"Failed: {error_message}"
if error_details:
task.metadata["error_details"] = error_details
task.metadata["error_message"] = error_message
# Move to failed tasks
self.failed_tasks.append(task)
del self.active_tasks[task_id]
total_time = (task.end_time - task.start_time).total_seconds()
self.logger.error(f"Task {task_id} failed after {total_time:.2f}s: {error_message}")
return True
def cancel_task(self, task_id: str, reason: str = "User cancelled") -> bool:
"""
Cancel a running task
Arguments:
----------
task_id { str } : Task ID to cancel
reason { str } : Cancellation reason
Returns:
--------
{ bool } : True if cancellation successful
"""
if task_id not in self.active_tasks:
self.logger.warning(f"Task {task_id} not found for cancellation")
return False
task = self.active_tasks[task_id]
# Update task
task.status = TaskStatus.CANCELLED
task.end_time = datetime.now()
task.current_status = f"Cancelled: {reason}"
task.metadata["cancellation_reason"] = reason
# Move to completed tasks (as cancelled)
self.completed_tasks.append(task)
del self.active_tasks[task_id]
total_time = (task.end_time - task.start_time).total_seconds()
self.logger.info(f"Cancelled task {task_id} after {total_time:.2f}s: {reason}")
return True
def get_task_progress(self, task_id: str) -> Optional[TaskProgress]:
"""
Get current progress for a task
Arguments:
----------
task_id { str } : Task ID
Returns:
--------
{ TaskProgress } : Task progress or None if not found
"""
# Check active tasks first
if task_id in self.active_tasks:
return self.active_tasks[task_id]
# Check completed tasks
for task in self.completed_tasks:
if (task.task_id == task_id):
return task
# Check failed tasks
for task in self.failed_tasks:
if (task.task_id == task_id):
return task
return None
def get_all_active_tasks(self) -> List[TaskProgress]:
"""
Get all active tasks
Returns:
--------
{ list } : List of active task progresses
"""
return list(self.active_tasks.values())
def get_active_task_count(self) -> int:
"""
Get number of active tasks
Returns:
--------
{ int } : Number of active tasks
"""
return len(self.active_tasks)
def get_recent_completed_tasks(self, limit: int = 10) -> List[TaskProgress]:
"""
Get recently completed tasks
Arguments:
----------
limit { int } : Maximum number of tasks to return
Returns:
--------
{ list } : List of completed tasks (newest first)
"""
# Return newest first
return self.completed_tasks[-limit:][::-1]
def get_task_statistics(self, task_id: str) -> Optional[Dict[str, Any]]:
"""
Get detailed statistics for a task
Arguments:
----------
task_id { str } : Task ID
Returns:
--------
{ dict } : Task statistics or None
"""
task = self.get_task_progress(task_id)
if not task:
return None
stats = {"task_id" : task.task_id,
"description" : task.description,
"status" : task.status.value,
"progress_percent" : task.progress_percent,
"processed_items" : task.processed_items,
"total_items" : task.total_items,
"current_item" : task.current_item,
"current_status" : task.current_status,
"start_time" : task.start_time.isoformat(),
"metadata" : task.metadata,
}
if task.end_time:
total_seconds = (task.end_time - task.start_time).total_seconds()
stats["total_time_seconds"] = total_seconds
stats["end_time"] = task.end_time.isoformat()
if task.estimated_seconds_remaining:
stats["estimated_seconds_remaining"] = task.estimated_seconds_remaining
return stats
def get_global_statistics(self) -> Dict[str, Any]:
"""
Get global progress statistics
Returns:
--------
{ dict } : Global statistics
"""
total_completed = len(self.completed_tasks)
total_failed = len(self.failed_tasks)
total_tasks = total_completed + total_failed + len(self.active_tasks)
# Calculate average completion time
avg_completion_time = 0.0
if (total_completed > 0):
total_time = sum((task.end_time - task.start_time).total_seconds() for task in self.completed_tasks if task.end_time)
avg_completion_time = total_time / total_completed
return {"active_tasks" : len(self.active_tasks),
"completed_tasks" : total_completed,
"failed_tasks" : total_failed,
"total_tasks" : total_tasks,
"success_rate" : (total_completed / total_tasks * 100) if total_tasks > 0 else 0,
"avg_completion_time_seconds" : avg_completion_time,
"max_completed_tasks" : self.max_completed_tasks,
}
def cleanup_completed_tasks(self, older_than_hours: int = 24):
"""
Clean up old completed tasks
Arguments:
----------
older_than_hours { int } : Remove tasks older than this many hours
"""
cutoff_time = datetime.now().timestamp() - (older_than_hours * 3600)
initial_count = len(self.completed_tasks)
self.completed_tasks = [task for task in self.completed_tasks if task.end_time and task.end_time.timestamp() > cutoff_time]
removed_count = initial_count - len(self.completed_tasks)
if (removed_count > 0):
self.logger.info(f"Cleaned up {removed_count} completed tasks older than {older_than_hours} hours")
@staticmethod
def _generate_task_id() -> str:
"""
Generate unique task ID
Returns:
--------
{ str } : Generated task ID
"""
return f"task_{uuid.uuid4().hex[:8]}_{int(time.time())}"
def __del__(self):
"""
Cleanup on destruction
"""
try:
self.cleanup_completed_tasks()
except Exception:
# Ignore cleanup errors during destruction
pass
# Global progress tracker instance
_progress_tracker = None
def get_progress_tracker() -> ProgressTracker:
"""
Get global progress tracker instance
Returns:
--------
{ ProgressTracker } : ProgressTracker instance
"""
global _progress_tracker
if _progress_tracker is None:
_progress_tracker = ProgressTracker()
return _progress_tracker
def start_progress_task(total_items: int, description: str, **kwargs) -> str:
"""
Convenience function to start a progress task
Arguments:
----------
total_items { int } : Total items
description { str } : Task description
**kwargs : Additional arguments
Returns:
--------
{ str } : Task ID
"""
tracker = get_progress_tracker()
return tracker.start_task(total_items, description, **kwargs) |