feat(progress): progress is tracked from bec; unified progress backend

Author: wyzula-jan

bec_widgets/widgets/containers/main_window/main_window.py

@@ -209,6 +209,7 @@ def _add_scan_progress_bar(self):
         self._scan_progress_bar_simple.progressbar.label_template = ""
         self._scan_progress_bar_simple.progressbar.setFixedHeight(self.SCAN_PROGRESS_HEIGHT)
         self._scan_progress_bar_simple.progressbar.setFixedWidth(self.SCAN_PROGRESS_WIDTH)
+        # This one do not need dynamic styling on hover ScanProgressBar since user will hover on it probably later, when progress bar is big enough
         self._scan_progress_bar_full = ScanProgressBar(
             self, rpc_exposed=False, rpc_passthrough_children=False, enable_dynamic_stylesheet=False
         )
@@ -237,16 +238,16 @@ def _add_separator(self, separate_object: bool = False) -> QWidget | None:
 
         # The actual line
         line = QFrame()
-        line.setFrameShape(QFrame.VLine)
-        line.setFrameShadow(QFrame.Sunken)
+        line.setFrameShape(QFrame.Shape.VLine)
+        line.setFrameShadow(QFrame.Shadow.Sunken)
         line.setFixedHeight(status_bar.sizeHint().height() - 2)
 
         # Wrapper to center the line vertically -> work around for QFrame not being able to center itself
         wrapper = QWidget()
         vbox = QVBoxLayout(wrapper)
         vbox.setContentsMargins(0, 0, 0, 0)
         vbox.addStretch()
-        vbox.addWidget(line, alignment=Qt.AlignHCenter)
+        vbox.addWidget(line, alignment=Qt.AlignmentFlag.AlignHCenter)
         vbox.addStretch()
         wrapper.setFixedWidth(line.sizeHint().width())
 

bec_widgets/widgets/progress/bec_progressbar/bec_progressbar.py

@@ -20,16 +20,18 @@ class ProgressState(Enum):
     @classmethod
     def from_bec_status(cls, status: str) -> "ProgressState":
         """
-        Map a BEC status string (open, paused, aborted, halted, closed)
+        Map a BEC status string (open, paused, aborted, halt/halted, closed, user_completed)
         to the corresponding ProgressState.
         Any unknown status falls back to NORMAL.
         """
         mapping = {
             "open": cls.NORMAL,
             "paused": cls.PAUSED,
             "aborted": cls.INTERRUPTED,
+            "halt": cls.PAUSED,
             "halted": cls.PAUSED,
             "closed": cls.COMPLETED,
+            "user_completed": cls.PAUSED,
         }
         return mapping.get(status.lower(), cls.NORMAL)
 
@@ -104,9 +106,6 @@ def __init__(
         self.progressbar.setMinimumHeight(0)
         self.progressbar.setSizePolicy(QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Ignored)
 
-        # Backwards-compatible alias used by existing tests and downstream code.
-        self.center_label = self.progressbar
-
         self._layout = QVBoxLayout(self)
         self._layout.setContentsMargins(self._padding_left_right, 0, self._padding_left_right, 0)
         self._layout.setSpacing(0)
@@ -339,6 +338,7 @@ def _sync_progressbar(self) -> None:
 
     def _setup_style_sheet(self, *, chunk_radius: int) -> None:
         radius = int(round(self._corner_radius))
+        chunk_color = self._state_colors[self._current_visual_state()].name()
         self.progressbar.setStyleSheet(f"""
             QProgressBar {{
                 background-color: palette(mid);
@@ -348,7 +348,7 @@ def _setup_style_sheet(self, *, chunk_radius: int) -> None:
                 text-align: center;
             }}
             QProgressBar::chunk {{
-                background-color: palette(highlight);
+                background-color: {chunk_color};
                 border-radius: {chunk_radius}px;
             }}
             """)
@@ -377,6 +377,11 @@ def _initial_chunk_radius(self) -> int:
         return 0 if self._enable_dynamic_stylesheet else self._target_chunk_radius()
 
     def _calculate_chunk_radius(self, target_radius: int) -> int:
+        """
+        This whole chunk logic is to calculater radius based on the current size.
+        If the radius is smaller than size of the progressbar it is just not applied.
+        The chunk stylesheet logic is smoothing it as much as possible.
+        """
         if target_radius <= 0 or self._maximum <= 0:
             return 0
         fill_width = self.progressbar.width() * min(1.0, max(0.0, self._value / self._maximum))
@@ -385,6 +390,16 @@ def _calculate_chunk_radius(self, target_radius: int) -> int:
         return min(target_radius, max(1, int(fill_width / 2)))
 
     def _apply_state_style(self) -> None:
+        chunk_radius = self._chunk_radius
+        if chunk_radius is None:
+            target_radius = self._target_chunk_radius()
+            chunk_radius = (
+                self._calculate_chunk_radius(target_radius)
+                if self._enable_dynamic_stylesheet
+                else target_radius
+            )
+            self._chunk_radius = chunk_radius
+        self._setup_style_sheet(chunk_radius=chunk_radius)
         color = self._state_colors[self._current_visual_state()]
         palette = self.progressbar.palette()
         palette.setColor(QPalette.ColorRole.Highlight, color)
@@ -406,20 +421,23 @@ def _get_label(self) -> str:
 if __name__ == "__main__":  # pragma: no cover
     app = QApplication(sys.argv)
 
-    progressBar = BECProgressBar()
-    progressBar.show()
-    progressBar.set_minimum(-100)
-    progressBar.set_maximum(0)
+    progress_bar = BECProgressBar()
+    progress_bar.setWindowTitle("BEC Progress Bar")
+    progress_bar.resize(360, 48)
+    progress_bar.set_minimum(-100)
+    progress_bar.set_maximum(0)
+    progress_bar.set_value(-100)
+    progress_bar.show()
 
     # Example of setting values
     def update_progress():
-        value = progressBar._user_value + 2.5
-        if value > progressBar._user_maximum:
-            value = -100  # progressBar._maximum / progressBar._upsampling_factor
-        progressBar.set_value(value)
+        value = progress_bar._user_value + 2.5
+        if value > progress_bar._user_maximum:
+            value = progress_bar._user_minimum
+        progress_bar.set_value(value)
 
-    timer = QTimer()
+    timer = QTimer(progress_bar)
     timer.timeout.connect(update_progress)
-    timer.start(200)  # Update every half second
+    timer.start(200)
 
     sys.exit(app.exec())