bec-widgets 0.57.5__py3-none-any.whl → 0.57.6__py3-none-any.whl

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 
 
+## v0.57.6 (2024-06-06)
+
+### Fix
+
+* fix(bar): docstrings extended ([`edb1775`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/edb1775967c3ff0723d0edad2b764f1ffc832b7c))
+
+
 ## v0.57.5 (2024-06-06)
 
 ### Documentation
@@ -145,15 +152,8 @@
 
 * docs(examples): example apps section deleted ([`ad208a5`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ad208a5ef8495c45a8b83a4850ba9a1041b42717))
 
-### Feature
-
-* feat(utils/ui_loader): universal ui loader for pyside/pyqt ([`0fea8d6`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/0fea8d606574fa99dda3b117da5d5209c251f694))
-
 ### Fix
 
 * fix(examples): outdated examples removed (mca_plot.py, stream_plot.py, motor_example.py) ([`ddc9510`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ddc9510c2ba8dadf291809eeb5b135a105259492))
 
 * fix: compatibility adjustment to .ui loading and tests for PySide6 ([`07b99d9`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/07b99d91a57a645cddd76294f48d78773e4c9ea5))
-
-
-## v0.55.0 (2024-05-24)

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.57.5
+Version: 0.57.6
 Summary: BEC Widgets
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec_widgets/issues
 Project-URL: Homepage, https://gitlab.psi.ch/bec/bec_widgets

bec_widgets/cli/client.py

@@ -1861,43 +1861,66 @@ class Ring(RPCBase):
     @rpc_call
     def set_value(self, value: "int | float"):
         """
-        None
+        Set the value for the ring widget
+
+        Args:
+            value(int | float): Value for the ring widget
         """
 
     @rpc_call
     def set_color(self, color: "str | tuple"):
         """
-        None
+        Set the color for the ring widget
+
+        Args:
+            color(str | tuple): Color for the ring widget. Can be HEX code or tuple (R, G, B, A).
         """
 
     @rpc_call
     def set_background(self, color: "str | tuple"):
         """
-        None
+        Set the background color for the ring widget
+
+        Args:
+            color(str | tuple): Background color for the ring widget. Can be HEX code or tuple (R, G, B, A).
         """
 
     @rpc_call
     def set_line_width(self, width: "int"):
         """
-        None
+        Set the line width for the ring widget
+
+        Args:
+            width(int): Line width for the ring widget
         """
 
     @rpc_call
     def set_min_max_values(self, min_value: "int | float", max_value: "int | float"):
         """
-        None
+        Set the min and max values for the ring widget.
+
+        Args:
+            min_value(int | float): Minimum value for the ring widget
+            max_value(int | float): Maximum value for the ring widget
         """
 
     @rpc_call
     def set_start_angle(self, start_angle: "int"):
         """
-        None
+        Set the start angle for the ring widget
+
+        Args:
+            start_angle(int): Start angle for the ring widget in degrees
         """
 
     @rpc_call
     def set_update(self, mode: "Literal['manual', 'scan', 'device']", device: "str" = None):
         """
-        Set the update mode for the ring widget
+        Set the update mode for the ring widget.
+        Modes:
+        - "manual": Manual update mode, the value is set by the user.
+        - "scan": Update mode for the scan progress. The value is updated by the current scan progress.
+        - "device": Update mode for the device readback. The value is updated by the device readback. Take into account that user has to set the device name and limits.
 
         Args:
             mode(str): Update mode for the ring widget. Can be "manual", "scan" or "device"
@@ -1907,5 +1930,5 @@ class Ring(RPCBase):
     @rpc_call
     def reset_connection(self):
         """
-        None
+        Reset the connections for the ring widget. Disconnect the current slot and endpoint.
         """

bec_widgets/widgets/spiral_progress_bar/ring.py

@@ -114,32 +114,75 @@ class Ring(BECConnector):
             self.set_connections(self.config.connections.slot, self.config.connections.endpoint)
 
     def set_value(self, value: int | float):
+        """
+        Set the value for the ring widget
+
+        Args:
+            value(int | float): Value for the ring widget
+        """
         self.config.value = round(
             float(max(self.config.min_value, min(self.config.max_value, value))),
             self.config.precision,
         )
 
     def set_color(self, color: str | tuple):
+        """
+        Set the color for the ring widget
+
+        Args:
+            color(str | tuple): Color for the ring widget. Can be HEX code or tuple (R, G, B, A).
+        """
         self.config.color = color
         self.color = self.convert_color(color)
 
     def set_background(self, color: str | tuple):
+        """
+        Set the background color for the ring widget
+
+        Args:
+            color(str | tuple): Background color for the ring widget. Can be HEX code or tuple (R, G, B, A).
+        """
         self.config.background_color = color
         self.color = self.convert_color(color)
 
     def set_line_width(self, width: int):
+        """
+        Set the line width for the ring widget
+
+        Args:
+            width(int): Line width for the ring widget
+        """
         self.config.line_width = width
 
     def set_min_max_values(self, min_value: int | float, max_value: int | float):
+        """
+        Set the min and max values for the ring widget.
+
+        Args:
+            min_value(int | float): Minimum value for the ring widget
+            max_value(int | float): Maximum value for the ring widget
+        """
         self.config.min_value = min_value
         self.config.max_value = max_value
 
     def set_start_angle(self, start_angle: int):
+        """
+        Set the start angle for the ring widget
+
+        Args:
+            start_angle(int): Start angle for the ring widget in degrees
+        """
         self.config.start_position = start_angle
         self.start_position = start_angle * 16
 
     @staticmethod
     def convert_color(color):
+        """
+        Convert the color to QColor
+
+        Args:
+            color(str | tuple): Color for the ring widget. Can be HEX code or tuple (R, G, B, A).
+        """
         converted_color = None
         if isinstance(color, str):
             converted_color = QtGui.QColor(color)
@@ -149,7 +192,11 @@ class Ring(BECConnector):
 
     def set_update(self, mode: Literal["manual", "scan", "device"], device: str = None):
         """
-        Set the update mode for the ring widget
+        Set the update mode for the ring widget.
+        Modes:
+        - "manual": Manual update mode, the value is set by the user.
+        - "scan": Update mode for the scan progress. The value is updated by the current scan progress.
+        - "device": Update mode for the device readback. The value is updated by the device readback. Take into account that user has to set the device name and limits.
 
         Args:
             mode(str): Update mode for the ring widget. Can be "manual", "scan" or "device"
@@ -169,6 +216,13 @@ class Ring(BECConnector):
         self.parent_progress_widget.enable_auto_updates(False)
 
     def set_connections(self, slot: str, endpoint: str | EndpointInfo):
+        """
+        Set the connections for the ring widget
+
+        Args:
+            slot(str): Slot for the ring widget update. Can be "on_scan_progress" or "on_device_readback".
+            endpoint(str | EndpointInfo): Endpoint for the ring widget update. Endpoint has to match the slot type.
+        """
         if self.config.connections.endpoint == endpoint and self.config.connections.slot == slot:
             return
         else:
@@ -179,12 +233,22 @@ class Ring(BECConnector):
             self.bec_dispatcher.connect_slot(getattr(self, slot), endpoint)
 
     def reset_connection(self):
+        """
+        Reset the connections for the ring widget. Disconnect the current slot and endpoint.
+        """
         self.bec_dispatcher.disconnect_slot(
             self.config.connections.slot, self.config.connections.endpoint
         )
         self.config.connections = RingConnections()
 
     def on_scan_progress(self, msg, meta):
+        """
+        Update the ring widget with the scan progress.
+
+        Args:
+            msg(dict): Message with the scan progress
+            meta(dict): Metadata for the message
+        """
         current_RID = meta.get("RID", None)
         if current_RID != self.RID:
             self.set_min_max_values(0, msg.get("max_value", 100))
@@ -192,6 +256,13 @@ class Ring(BECConnector):
         self.parent_progress_widget.update()
 
     def on_device_readback(self, msg, meta):
+        """
+        Update the ring widget with the device readback.
+
+        Args:
+            msg(dict): Message with the device readback
+            meta(dict): Metadata for the message
+        """
         if isinstance(self.config.connections.endpoint, EndpointInfo):
             endpoint = self.config.connections.endpoint.endpoint
         else:

bec_widgets/widgets/spiral_progress_bar/spiral_progress_bar.py

@@ -464,6 +464,13 @@ class SpiralProgressBar(BECConnector, QWidget):
 
     @Slot(dict, dict)
     def on_scan_queue_status(self, msg, meta):
+        """
+        Slot to handle scan queue status messages. Decides what update to perform based on the scan queue status.
+
+        Args:
+            msg(dict): Message from the BEC.
+            meta(dict): Metadata from the BEC.
+        """
         primary_queue = msg.get("queue").get("primary")
         info = primary_queue.get("info", None)
 
@@ -490,6 +497,12 @@ class SpiralProgressBar(BECConnector, QWidget):
                     #     print("hook device_progress")
 
     def _hook_scan_progress(self, ring_index: int = None):
+        """
+        Hook the scan progress to the progress bars.
+
+        Args:
+            ring_index(int): Index of the progress bar to hook the scan progress to.
+        """
         if ring_index is not None:
             ring = self._find_ring_by_index(ring_index)
         else:
@@ -501,6 +514,15 @@ class SpiralProgressBar(BECConnector, QWidget):
             ring.set_connections("on_scan_progress", MessageEndpoints.scan_progress())
 
     def _hook_readback(self, bar_index: int, device: str, min: float | int, max: float | int):
+        """
+        Hook the readback values to the progress bars.
+
+        Args:
+            bar_index(int): Index of the progress bar to hook the readback values to.
+            device(str): Device to readback values from.
+            min(float|int): Minimum value for the progress bar.
+            max(float|int): Maximum value for the progress bar.
+        """
         ring = self._find_ring_by_index(bar_index)
         ring.set_min_max_values(min, max)
         endpoint = MessageEndpoints.device_readback(device)

{bec_widgets-0.57.5.dist-info → bec_widgets-0.57.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.57.5
+Version: 0.57.6
 Summary: BEC Widgets
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec_widgets/issues
 Project-URL: Homepage, https://gitlab.psi.ch/bec/bec_widgets

{bec_widgets-0.57.5.dist-info → bec_widgets-0.57.6.dist-info}/RECORD

@@ -2,11 +2,11 @@
 .gitlab-ci.yml,sha256=RF2JeGh8tG09DyAOwEu991IZy3C8Vm6lI8O_4Dr9B9Q,12239
 .pylintrc,sha256=OstrgmEyP0smNFBKoIN5_26-UmNZgMHnbjvAWX0UrLs,18535
 .readthedocs.yaml,sha256=aSOc277LqXcsTI6lgvm_JY80lMlr69GbPKgivua2cS0,603
-CHANGELOG.md,sha256=7H2GTncFqnR-otViaWQZ6GjWQYaXBZaVSlZi7gg1r8A,7242
+CHANGELOG.md,sha256=PBUKv3Symz1kDLb8arybg5eBIhTCCqgW09Sh45Bo7rc,7209
 LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-PKG-INFO,sha256=FrFmymNmKhGgdnROQ1lQVuTNsR37w-FOZD83DW3gd-g,1178
+PKG-INFO,sha256=W1IkNBUfxaDv1yzQ94gfD1NSm1CF3FAmJwlMYzn7was,1178
 README.md,sha256=y4jB6wvArS7N8_iTbKWnSM_oRAqLA2GqgzUR-FMh5sU,2645
-pyproject.toml,sha256=pmkWfhl5AVkaAK06SsqJiwwOP4qIifYqbVh7CtIo0ac,1822
+pyproject.toml,sha256=tKe6Rt9bkUN4Pj1OuLyr5AuOLho0b0s0PaGU0xSOBg4,1822
 .git_hooks/pre-commit,sha256=n3RofIZHJl8zfJJIUomcMyYGFi_rwq4CC19z0snz3FI,286
 .gitlab/issue_templates/bug_report_template.md,sha256=gAuyEwl7XlnebBrkiJ9AqffSNOywmr8vygUFWKTuQeI,386
 .gitlab/issue_templates/documentation_update_template.md,sha256=FHLdb3TS_D9aL4CYZCjyXSulbaW5mrN2CmwTaeLPbNw,860
@@ -17,7 +17,7 @@ bec_widgets/assets/bec_widgets_icon.png,sha256=K8dgGwIjalDh9PRHUsSQBqgdX7a00nM3i
 bec_widgets/assets/terminal_icon.png,sha256=bJl7Tft4Fi2uxvuXI8o14uMHnI9eAWKSU2uftXCH9ws,3889
 bec_widgets/cli/__init__.py,sha256=tLD8HWgyURhMjYlKZ43pBu-qvGD1LI5o3n3rEieg-70,43
 bec_widgets/cli/auto_updates.py,sha256=8x4_SrD8Hh1RbrUWXLfisw6X5v8Mij2DiTfjvn9dkUw,4692
-bec_widgets/cli/client.py,sha256=RB11oNngqo3_mqWxQJRalsehh_fwwh34o7IN2HTNTyg,53804
+bec_widgets/cli/client.py,sha256=3GiSipBcjFvQunvevSgxGgriK1dslqpu-0A5WWFN_fA,55076
 bec_widgets/cli/client_utils.py,sha256=7u8P9EYgLPJuAcHxnFiZi-gCZohO3vAn0W7dqsSrs4M,10660
 bec_widgets/cli/generate_cli.py,sha256=tBt-F4Xccg9Pj2zuDEGHd0Ho1fKLfCf3PuSa8KmelQk,4431
 bec_widgets/cli/rpc_register.py,sha256=QxXUZu5XNg00Yf5O3UHWOXg3-f_pzKjjoZYMOa-MOJc,2216
@@ -82,8 +82,8 @@ bec_widgets/widgets/motor_control/selection/selection.ui,sha256=vXXpvNWuL6xyHhW7
 bec_widgets/widgets/scan_control/__init__.py,sha256=IOfHl15vxb_uC6KN62-PeUzbBha_vQyqkkXbJ2HU674,38
 bec_widgets/widgets/scan_control/scan_control.py,sha256=B5n2U2iVtTCY3Tx93JyBqzGCDCmWhWwAOhbPelLI-bs,17168
 bec_widgets/widgets/spiral_progress_bar/__init__.py,sha256=4efbtcqCToMIw5bkQrTzy2TzuBCXvlhuUPh1bYC_Yzg,51
-bec_widgets/widgets/spiral_progress_bar/ring.py,sha256=zYz_wq5f-mfI32_melkxyzMbx4RStUU1bpwMp0jm9d4,8057
-bec_widgets/widgets/spiral_progress_bar/spiral_progress_bar.py,sha256=BWhkuVrHUhLWDlpNNhhFfH2cU_tIhB-nhJMH-SLiPyE,23599
+bec_widgets/widgets/spiral_progress_bar/ring.py,sha256=JUx2TDH5eh1x9tWCkIkis9Tvo5P27gqFcszxVxSq7Ho,10469
+bec_widgets/widgets/spiral_progress_bar/spiral_progress_bar.py,sha256=OQzJiR0Fd4fWop4ojykEKtXVqeLL0WLNSBdhf7JvLsc,24386
 bec_widgets/widgets/toolbar/__init__.py,sha256=d-TP4_cr_VbpwreMM4ePnfZ5YXsEPQ45ibEf75nuGoE,36
 bec_widgets/widgets/toolbar/toolbar.py,sha256=e0zCD_0q7K4NVhrzD8001Qvfxt-VhqHTgofchS9NgCM,5125
 docs/Makefile,sha256=i2WHuFlgfyAPEW4ssEP8NY4cOibDJrVjvzSEU8_Ggwc,634
@@ -151,7 +151,7 @@ tests/unit_tests/test_configs/config_device_no_entry.yaml,sha256=hdvue9KLc_kfNzG
 tests/unit_tests/test_configs/config_scan.yaml,sha256=vo484BbWOjA_e-h6bTjSV9k7QaQHrlAvx-z8wtY-P4E,1915
 tests/unit_tests/test_msgs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/unit_tests/test_msgs/available_scans_message.py,sha256=m_z97hIrjHXXMa2Ex-UvsPmTxOYXfjxyJaGkIY6StTY,46532
-bec_widgets-0.57.5.dist-info/METADATA,sha256=FrFmymNmKhGgdnROQ1lQVuTNsR37w-FOZD83DW3gd-g,1178
-bec_widgets-0.57.5.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
-bec_widgets-0.57.5.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-bec_widgets-0.57.5.dist-info/RECORD,,
+bec_widgets-0.57.6.dist-info/METADATA,sha256=W1IkNBUfxaDv1yzQ94gfD1NSm1CF3FAmJwlMYzn7was,1178
+bec_widgets-0.57.6.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
+bec_widgets-0.57.6.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
+bec_widgets-0.57.6.dist-info/RECORD,,

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_widgets"
-version = "0.57.5"
+version = "0.57.6"
 description = "BEC Widgets"
 requires-python = ">=3.10"
 classifiers = [