|
| 1 | +from __future__ import annotations |
| 2 | + |
| 3 | +import time |
| 4 | +from dataclasses import dataclass |
| 5 | +from typing import Literal |
| 6 | + |
| 7 | +import numpy as np |
| 8 | +from bec_lib.endpoints import MessageEndpoints |
| 9 | +from qtpy.QtCore import QObject, QTimer, Signal |
| 10 | + |
| 11 | + |
| 12 | +@dataclass(frozen=True) |
| 13 | +class ProgressSnapshot: |
| 14 | + value: float |
| 15 | + max_value: float |
| 16 | + done: bool |
| 17 | + status: Literal["open", "paused", "aborted", "halt", "halted", "closed", "user_completed"] |
| 18 | + scan_id: str | None = None |
| 19 | + scan_number: int | None = None |
| 20 | + rid: str | None = None |
| 21 | + is_new_scan: bool = False |
| 22 | + |
| 23 | + |
| 24 | +class ProgressTask(QObject): |
| 25 | + """ |
| 26 | + Class to store progress information. |
| 27 | + Inspired by https://github.com/Textualize/rich/blob/master/rich/progress.py |
| 28 | + """ |
| 29 | + |
| 30 | + def __init__( |
| 31 | + self, parent: QObject | None, value: float = 0, max_value: float = 0, done: bool = False |
| 32 | + ): |
| 33 | + super().__init__(parent=parent) |
| 34 | + self.start_time = time.monotonic() |
| 35 | + self.done = done |
| 36 | + self.value = value |
| 37 | + self.max_value = max_value |
| 38 | + self._elapsed_time = 0 |
| 39 | + |
| 40 | + self.timer = QTimer(self) |
| 41 | + self.timer.timeout.connect(self.update_elapsed_time) |
| 42 | + self.timer.start(1000) |
| 43 | + |
| 44 | + def update(self, value: float, max_value: float, done: bool = False): |
| 45 | + """ |
| 46 | + Update the progress. |
| 47 | + """ |
| 48 | + self.max_value = max_value |
| 49 | + self.done = done |
| 50 | + self.value = value |
| 51 | + if done: |
| 52 | + self.timer.stop() |
| 53 | + |
| 54 | + def update_elapsed_time(self): |
| 55 | + """ |
| 56 | + Update the time estimates. This is called every second by a QTimer. |
| 57 | + """ |
| 58 | + self._elapsed_time = max(0.0, time.monotonic() - self.start_time) |
| 59 | + |
| 60 | + @property |
| 61 | + def percentage(self) -> float: |
| 62 | + """float: Get progress of task as a percentage. If a None total was set, returns 0""" |
| 63 | + if not self.max_value: |
| 64 | + return 0.0 |
| 65 | + completed = (self.value / self.max_value) * 100.0 |
| 66 | + completed = min(100.0, max(0.0, completed)) |
| 67 | + return completed |
| 68 | + |
| 69 | + @property |
| 70 | + def speed(self) -> float: |
| 71 | + """Get the estimated speed in steps per second.""" |
| 72 | + if self._elapsed_time == 0: |
| 73 | + return 0.0 |
| 74 | + |
| 75 | + return self.value / self._elapsed_time |
| 76 | + |
| 77 | + @property |
| 78 | + def frequency(self) -> float: |
| 79 | + """Get the estimated frequency in steps per second.""" |
| 80 | + if self.speed == 0: |
| 81 | + return 0.0 |
| 82 | + return 1 / self.speed |
| 83 | + |
| 84 | + @property |
| 85 | + def time_elapsed(self) -> str: |
| 86 | + return self._format_time(int(self._elapsed_time)) |
| 87 | + |
| 88 | + @property |
| 89 | + def remaining(self) -> float: |
| 90 | + """Get the estimated remaining steps.""" |
| 91 | + if self.done: |
| 92 | + return 0.0 |
| 93 | + remaining = self.max_value - self.value |
| 94 | + return remaining |
| 95 | + |
| 96 | + @property |
| 97 | + def time_remaining(self) -> str: |
| 98 | + """ |
| 99 | + Get the estimated remaining time in the format HH:MM:SS. |
| 100 | + """ |
| 101 | + if self.done or not self.speed or not self.remaining: |
| 102 | + return self._format_time(0) |
| 103 | + estimate = int(np.round(self.remaining / self.speed)) |
| 104 | + |
| 105 | + return self._format_time(estimate) |
| 106 | + |
| 107 | + @staticmethod |
| 108 | + def _format_time(seconds: float) -> str: |
| 109 | + """ |
| 110 | + Format the time in seconds to a string in the format HH:MM:SS. |
| 111 | + """ |
| 112 | + return f"{seconds // 3600:02}:{(seconds // 60) % 60:02}:{seconds % 60:02}" |
| 113 | + |
| 114 | + |
| 115 | +class BECProgressTracker(QObject): |
| 116 | + """ |
| 117 | + Shared backend for BEC scan progress messages. |
| 118 | + """ |
| 119 | + |
| 120 | + progress_started = Signal(object) |
| 121 | + progress_updated = Signal(object) |
| 122 | + progress_finished = Signal(object) |
| 123 | + progress_cleared = Signal() |
| 124 | + |
| 125 | + def __init__(self, bec_dispatcher, parent: QObject | None = None): |
| 126 | + super().__init__(parent=parent) |
| 127 | + self.bec_dispatcher = bec_dispatcher |
| 128 | + self._connected = False |
| 129 | + self.task: ProgressTask | None = None |
| 130 | + self.scan_number: int | None = None |
| 131 | + self._active_scan_id: str | None = None |
| 132 | + self._active_rid: str | None = None |
| 133 | + |
| 134 | + def start(self) -> None: |
| 135 | + if self._connected: |
| 136 | + return |
| 137 | + self.bec_dispatcher.connect_slot( |
| 138 | + self.process_progress_message, MessageEndpoints.scan_progress() |
| 139 | + ) |
| 140 | + self._connected = True |
| 141 | + |
| 142 | + def _start_task(self, scan_id: str | None, rid: str | None = None) -> None: |
| 143 | + if self.task is not None: |
| 144 | + self.task.timer.stop() |
| 145 | + self.task.deleteLater() |
| 146 | + self.task = ProgressTask(parent=self) |
| 147 | + self._active_scan_id = scan_id |
| 148 | + self._active_rid = rid |
| 149 | + self.progress_started.emit( |
| 150 | + ProgressSnapshot( |
| 151 | + value=0, |
| 152 | + max_value=100, |
| 153 | + done=False, |
| 154 | + status="open", |
| 155 | + scan_id=self._active_scan_id, |
| 156 | + scan_number=self.scan_number, |
| 157 | + rid=self._active_rid, |
| 158 | + ) |
| 159 | + ) |
| 160 | + |
| 161 | + def clear_task(self, *, emit_finished: bool = True) -> None: |
| 162 | + if self.task is None: |
| 163 | + self._active_scan_id = None |
| 164 | + self._active_rid = None |
| 165 | + self.progress_cleared.emit() |
| 166 | + return |
| 167 | + self.task.timer.stop() |
| 168 | + self.task.deleteLater() |
| 169 | + self.task = None |
| 170 | + self._active_scan_id = None |
| 171 | + self._active_rid = None |
| 172 | + self.progress_cleared.emit() |
| 173 | + if emit_finished: |
| 174 | + self.progress_finished.emit( |
| 175 | + ProgressSnapshot( |
| 176 | + value=0, |
| 177 | + max_value=100, |
| 178 | + done=True, |
| 179 | + status="open", |
| 180 | + scan_id=self._active_scan_id, |
| 181 | + scan_number=self.scan_number, |
| 182 | + rid=self._active_rid, |
| 183 | + ) |
| 184 | + ) |
| 185 | + |
| 186 | + def process_progress_message( |
| 187 | + self, |
| 188 | + msg_content: dict, |
| 189 | + metadata: dict, |
| 190 | + ) -> ProgressSnapshot | None: |
| 191 | + done = msg_content.get("done", False) |
| 192 | + value = msg_content.get("value", 0) |
| 193 | + max_value = msg_content.get("max_value", 100) |
| 194 | + status: Literal[ |
| 195 | + "open", "paused", "aborted", "halt", "halted", "closed", "user_completed" |
| 196 | + ] = metadata.get("status", "open") |
| 197 | + scan_id = metadata.get("scan_id") or metadata.get("RID") |
| 198 | + rid = metadata.get("RID") |
| 199 | + scan_number = metadata.get("scan_number") |
| 200 | + if scan_number is not None: |
| 201 | + self.scan_number = scan_number |
| 202 | + is_new_scan = False |
| 203 | + previous_scan_id = self._active_scan_id |
| 204 | + previous_rid = self._active_rid |
| 205 | + identity_changed = ( |
| 206 | + (scan_id is not None and scan_id != previous_scan_id) |
| 207 | + or (rid is not None and rid != previous_rid) |
| 208 | + or (previous_scan_id is None and previous_rid is None) |
| 209 | + ) |
| 210 | + |
| 211 | + if self.task is None: |
| 212 | + self._start_task(scan_id, rid=rid) |
| 213 | + is_new_scan = identity_changed |
| 214 | + elif scan_id is not None and scan_id != self._active_scan_id: |
| 215 | + self._start_task(scan_id, rid=rid) |
| 216 | + is_new_scan = True |
| 217 | + elif rid is not None and rid != self._active_rid: |
| 218 | + self._start_task(scan_id or self._active_scan_id, rid=rid) |
| 219 | + is_new_scan = True |
| 220 | + |
| 221 | + if self.task is None: |
| 222 | + return None |
| 223 | + |
| 224 | + self.task.update(value, max_value, done) |
| 225 | + snapshot = ProgressSnapshot( |
| 226 | + value=value, |
| 227 | + max_value=max_value, |
| 228 | + done=done, |
| 229 | + status=status, |
| 230 | + scan_id=self._active_scan_id, |
| 231 | + scan_number=self.scan_number, |
| 232 | + rid=self._active_rid, |
| 233 | + is_new_scan=is_new_scan, |
| 234 | + ) |
| 235 | + self.progress_updated.emit(snapshot) |
| 236 | + if done: |
| 237 | + self.clear_task() |
| 238 | + return snapshot |
| 239 | + |
| 240 | + def cleanup(self) -> None: |
| 241 | + self.clear_task(emit_finished=False) |
| 242 | + if self._connected: |
| 243 | + self.bec_dispatcher.disconnect_slot( |
| 244 | + self.process_progress_message, MessageEndpoints.scan_progress() |
| 245 | + ) |
| 246 | + self._connected = False |
0 commit comments