bec-widgets 1.21.0__tar.gz → 1.21.1__tar.gz

{bec_widgets-1.21.0 → bec_widgets-1.21.1}/CHANGELOG.md

@@ -1,6 +1,14 @@
 # CHANGELOG
 
 
+## v1.21.1 (2025-02-17)
+
+### Bug Fixes
+
+- **bec_connector**: Workers stored in reference to not be cleaned up with garbage collector
+  ([`383936f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/383936ffc2bd7d2e088d3367c76b14efa3d1732c))
+
+
 ## v1.21.0 (2025-02-17)
 
 ### Features

{bec_widgets-1.21.0 → bec_widgets-1.21.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bec_widgets
-Version: 1.21.0
+Version: 1.21.1
 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
@@ -16,7 +16,7 @@ Requires-Dist: black~=24.0
 Requires-Dist: isort>=5.13.2,~=5.13
 Requires-Dist: pydantic~=2.0
 Requires-Dist: pyqtgraph~=0.13
-Requires-Dist: pyside6==6.7.2
+Requires-Dist: pyside6>=6.8
 Requires-Dist: pyte
 Requires-Dist: qtconsole>=5.5.1,~=5.5
 Requires-Dist: qtpy~=2.4

{bec_widgets-1.21.0 → bec_widgets-1.21.1}/bec_widgets/utils/bec_connector.py

@@ -111,7 +111,7 @@ class BECConnector:
 
         # register widget to rpc register
         # be careful: when registering, and the object is not a BECWidget,
-        # cleanup has to called manually since there is no 'closeEvent'
+        # cleanup has to be called manually since there is no 'closeEvent'
         self.rpc_register = RPCRegister()
         self.rpc_register.add_rpc(self)
 
@@ -119,6 +119,8 @@ class BECConnector:
         self.error_utility = ErrorPopupUtility()
 
         self._thread_pool = QThreadPool.globalInstance()
+        # Store references to running workers so they're not garbage collected prematurely.
+        self._workers = []
 
     def submit_task(self, fn, *args, on_complete: pyqtSlot = None, **kwargs) -> Worker:
         """
@@ -147,11 +149,14 @@ class BECConnector:
             >>> def on_complete():
             >>>     print("Task complete")
             >>> self.submit_task(my_function, 1, 2, on_complete=on_complete)
-
         """
         worker = Worker(fn, *args, **kwargs)
         if on_complete:
             worker.signals.completed.connect(on_complete)
+        # Keep a reference to the worker so it is not garbage collected.
+        self._workers.append(worker)
+        # When the worker is done, remove it from our list.
+        worker.signals.completed.connect(lambda: self._workers.remove(worker))
         self._thread_pool.start(worker)
         return worker
 
@@ -183,10 +188,10 @@ class BECConnector:
     @_config_dict.setter
     def _config_dict(self, config: BaseModel) -> None:
         """
-        Get the configuration of the widget.
+        Set the configuration of the widget.
 
-        Returns:
-            dict: The configuration of the widget.
+        Args:
+            config (BaseModel): The new configuration model.
         """
         self.config = config
 
@@ -195,8 +200,8 @@ class BECConnector:
         Apply the configuration to the widget.
 
         Args:
-            config(dict): Configuration settings.
-            generate_new_id(bool): If True, generate a new GUI ID for the widget.
+            config (dict): Configuration settings.
+            generate_new_id (bool): If True, generate a new GUI ID for the widget.
         """
         self.config = ConnectionConfig(**config)
         if generate_new_id is True:
@@ -212,8 +217,8 @@ class BECConnector:
         Load the configuration of the widget from YAML.
 
         Args:
-            path(str): Path to the configuration file for non-GUI dialog mode.
-            gui(bool): If True, use the GUI dialog to load the configuration file.
+            path (str | None): Path to the configuration file for non-GUI dialog mode.
+            gui (bool): If True, use the GUI dialog to load the configuration file.
         """
         if gui is True:
             config = load_yaml_gui(self)
@@ -232,8 +237,8 @@ class BECConnector:
         Save the configuration of the widget to YAML.
 
         Args:
-            path(str): Path to save the configuration file for non-GUI dialog mode.
-            gui(bool): If True, use the GUI dialog to save the configuration file.
+            path (str | None): Path to save the configuration file for non-GUI dialog mode.
+            gui (bool): If True, use the GUI dialog to save the configuration file.
         """
         if gui is True:
             save_yaml_gui(self, self._config_dict)
@@ -241,7 +246,6 @@ class BECConnector:
             if path is None:
                 path = os.getcwd()
             file_path = os.path.join(path, f"{self.__class__.__name__}_config.yaml")
-
             save_yaml(file_path, self._config_dict)
 
     @pyqtSlot(str)
@@ -250,7 +254,7 @@ class BECConnector:
         Set the GUI ID for the widget.
 
         Args:
-            gui_id(str): GUI ID
+            gui_id (str): GUI ID.
         """
         self.config.gui_id = gui_id
         self.gui_id = gui_id
@@ -271,7 +275,7 @@ class BECConnector:
         """Update the client and device manager from BEC and create object for BEC shortcuts.
 
         Args:
-            client: BEC client
+            client: BEC client.
         """
         self.client = client
         self.get_bec_shortcuts()
@@ -282,12 +286,10 @@ class BECConnector:
         Update the configuration for the widget.
 
         Args:
-            config(ConnectionConfig): Configuration settings.
+            config (ConnectionConfig | dict): Configuration settings.
         """
         if isinstance(config, dict):
             config = ConnectionConfig(**config)
-            # TODO add error handler
-
         self.config = config
 
     def get_config(self, dict_output: bool = True) -> dict | BaseModel:
@@ -295,12 +297,45 @@ class BECConnector:
         Get the configuration of the widget.
 
         Args:
-            dict_output(bool): If True, return the configuration as a dictionary. If False, return the configuration as a pydantic model.
+            dict_output (bool): If True, return the configuration as a dictionary.
+                                If False, return the configuration as a pydantic model.
 
         Returns:
-            dict: The configuration of the plot widget.
+            dict | BaseModel: The configuration of the widget.
         """
         if dict_output:
             return self.config.model_dump()
         else:
             return self.config
+
+
+# --- Example usage of BECConnector: running a simple task ---
+if __name__ == "__main__":  # pragma: no cover
+    import sys
+
+    # Create a QApplication instance (required for QThreadPool)
+    app = QApplication(sys.argv)
+
+    connector = BECConnector()
+
+    def print_numbers():
+        """
+        Task function that prints numbers 1 to 10 with a 0.5 second delay between each.
+        """
+        for i in range(1, 11):
+            print(i)
+            time.sleep(0.5)
+
+    def task_complete():
+        """
+        Called when the task is complete.
+        """
+        print("Task complete")
+        # Exit the application after the task completes.
+        app.quit()
+
+    # Submit the task using the connector's submit_task method.
+    connector.submit_task(print_numbers, on_complete=task_complete)
+
+    # Start the Qt event loop.
+    sys.exit(app.exec_())

{bec_widgets-1.21.0 → bec_widgets-1.21.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_widgets"
-version = "1.21.0"
+version = "1.21.1"
 description = "BEC Widgets"
 requires-python = ">=3.10"
 classifiers = [
@@ -20,7 +20,7 @@ dependencies = [
     "isort~=5.13, >=5.13.2",             # needed for bw-generate-cli
     "pydantic~=2.0",
     "pyqtgraph~=0.13",
-    "PySide6==6.7.2",
+    "PySide6>=6.8",
     "pyte",                              # needed for vt100 console
     "qtconsole~=5.5, >=5.5.1",           # needed for jupyter console
     "qtpy~=2.4",