bec-widgets 0.57.0__tar.gz → 0.57.2__tar.gz

{bec_widgets-0.57.0 → bec_widgets-0.57.2}/CHANGELOG.md

@@ -2,6 +2,38 @@
 
 
 
+## v0.57.2 (2024-06-06)
+
+### Fix
+
+* fix(test/e2e): autoupdate e2e rewritten ([`e1af5ca`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e1af5ca60f0616835f9f41d84412f29dc298c644))
+
+* fix(test/e2e): spiral_progress_bar e2e tests rewritten to use config_dict ([`7fb31fc`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7fb31fc4d762ff4ca839971b3092a084186f81b8))
+
+* fix(test/e2e): dockarea and dock e2e tests changed to check asserts against config_dict ([`5c6ba65`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5c6ba65469863ea1e6fc5abdc742650e20eba9b9))
+
+* fix: rpc_server_dock fixture now spawns the server process ([`cd9fc46`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/cd9fc46ff8a947242c8c28adcd73d7de60b11c44))
+
+* fix: accept scalars or numpy arrays of 1 element ([`2a88e17`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2a88e17b23436c55d25b7d3449e4af3a7689661c))
+
+### Refactor
+
+* refactor: move _get_output and _start_plot_process at the module level ([`69f4371`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/69f4371007c66aee6b7521a6803054025adf8c92))
+
+
+## v0.57.1 (2024-06-06)
+
+### Documentation
+
+* docs: docs refactored from add_widget_bec to add_widget ([`c3f4845`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c3f4845b4f95005ff737fed5542600b0b9a9cc2b))
+
+### Fix
+
+* fix: tests references to add_widget_bec refactored ([`f51b25f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f51b25f0af4ab8b0a75ee48a40bfbb079c16e9d1))
+
+* fix(dock): add_widget and add_widget_bec consolidated ([`8ae323f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/8ae323f5c3c0d9d0f202d31d5e8374a272a26be2))
+
+
 ## v0.57.0 (2024-06-05)
 
 ### Documentation
@@ -133,43 +165,3 @@
 
 
 ## v0.53.0 (2024-05-09)
-
-### Ci
-
-* ci: use formatter config of toml file ([`5cc816d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5cc816d0af73e20c648e044a027c589704ab1625))
-
-### Documentation
-
-* docs: update install instructions ([`57ee735`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/57ee735e5c2436d45a285507cdc939daa20e8e8f))
-
-### Feature
-
-* feat: moved to pyproject.toml; closes #162 ([`c86ce30`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c86ce302a964d71ee631f0817609ab5aa0e3ab0f))
-
-### Fix
-
-* fix: fixed semver job and upgraded to v9 ([`32e1a9d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/32e1a9d8472eb1c25d30697d407a8ffecd04e75d))
-
-### Refactor
-
-* refactor: applied formatter ([`4117fd7`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4117fd7b5b2090ff4fb7ad9e0d92cc87cd13ed5f))
-
-
-## v0.52.1 (2024-05-08)
-
-### Fix
-
-* fix(docstrings): docstrings formating fixed for sphinx to properly format readdocs ([`7f2f7cd`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7f2f7cd07a14876617cd83cedde8c281fdc52c3a))
-
-
-## v0.52.0 (2024-05-07)
-
-### Feature
-
-* feat(utils/layout_manager): added GridLayoutManager to extend functionalities of native QGridLayout ([`fcd6ef0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/fcd6ef0975dc872f69c9d6fb2b8a1ad04a423aae))
-
-* feat(widget/dock): BECDock and BECDock area for dockable windows ([`d8ff8af`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/d8ff8afcd474660a6069bbdab05f10a65f221727))
-
-### Fix
-
-* fix(widgets/dock): BECDockArea close overwrites the default pyqtgraph Container close + minor improvements ([`ceae979`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ceae979f375ecc33c5c97148f197655c1ca57b6c))

{bec_widgets-0.57.0 → bec_widgets-0.57.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.57.0
+Version: 0.57.2
 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
@@ -27,6 +27,7 @@ Requires-Dist: pytest; extra == 'dev'
 Requires-Dist: pytest-qt; extra == 'dev'
 Requires-Dist: pytest-random-order; extra == 'dev'
 Requires-Dist: pytest-timeout; extra == 'dev'
+Requires-Dist: pytest-xvfb; extra == 'dev'
 Provides-Extra: pyqt5
 Requires-Dist: pyqt5>=5.9; extra == 'pyqt5'
 Provides-Extra: pyqt6

{bec_widgets-0.57.0 → bec_widgets-0.57.2}/bec_widgets/cli/auto_updates.py

@@ -30,7 +30,7 @@ class AutoUpdates:
         Create a default dock for the auto updates.
         """
         dock = self.gui.add_dock("default_figure")
-        dock.add_widget_bec("BECFigure")
+        dock.add_widget("BECFigure")
         self.dock_name = "default_figure"
 
     @staticmethod

{bec_widgets-0.57.0 → bec_widgets-0.57.2}/bec_widgets/cli/client.py

@@ -1468,20 +1468,20 @@ class BECDock(RPCBase):
         """
 
     @rpc_call
-    def add_widget_bec(
+    def add_widget(
         self,
-        widget_type: "str",
+        widget: "BECConnector | str",
         row=None,
         col=0,
         rowspan=1,
         colspan=1,
         shift: "Literal['down', 'up', 'left', 'right']" = "down",
-    ):
+    ) -> "BECConnector":
         """
         Add a widget to the dock.
 
         Args:
-            widget_type(str): The widget to add. Only BEC RPC widgets from RPCWidgetHandler are allowed.
+            widget(QWidget): The widget to add.
             row(int): The row to add the widget to. If None, the widget will be added to the next available row.
             col(int): The column to add the widget to.
             rowspan(int): The number of rows the widget should span.
@@ -1651,6 +1651,16 @@ class BECDockArea(RPCBase, BECGuiClientMixin):
         Get all registered RPC objects.
         """
 
+    @property
+    @rpc_call
+    def temp_areas(self) -> "list":
+        """
+        Get the temporary areas in the dock area.
+
+        Returns:
+            list: The temporary areas in the dock area.
+        """
+
 
 class SpiralProgressBar(RPCBase):
     @rpc_call

{bec_widgets-0.57.0 → bec_widgets-0.57.2}/bec_widgets/cli/client_utils.py

@@ -61,10 +61,54 @@ def rpc_call(func):
     return wrapper
 
 
+def _get_output(process) -> None:
+    try:
+        os.set_blocking(process.stdout.fileno(), False)
+        os.set_blocking(process.stderr.fileno(), False)
+        while process.poll() is None:
+            readylist, _, _ = select.select([process.stdout, process.stderr], [], [], 1)
+            if process.stdout in readylist:
+                output = process.stdout.read(1024)
+                if output:
+                    print(output, end="")
+            if process.stderr in readylist:
+                error_output = process.stderr.read(1024)
+                if error_output:
+                    print(error_output, end="", file=sys.stderr)
+    except Exception as e:
+        print(f"Error reading process output: {str(e)}")
+
+
+def _start_plot_process(gui_id, gui_class, config) -> None:
+    """
+    Start the plot in a new process.
+    """
+    # pylint: disable=subprocess-run-check
+    monitor_module = importlib.import_module("bec_widgets.cli.server")
+    monitor_path = monitor_module.__file__
+
+    command = [
+        sys.executable,
+        "-u",
+        monitor_path,
+        "--id",
+        gui_id,
+        "--config",
+        config,
+        "--gui_class",
+        gui_class.__name__,
+    ]
+    process = subprocess.Popen(command, text=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+    process_output_processing_thread = threading.Thread(target=_get_output, args=(process,))
+    process_output_processing_thread.start()
+    return process, process_output_processing_thread
+
+
 class BECGuiClientMixin:
     def __init__(self, **kwargs) -> None:
         super().__init__(**kwargs)
         self._process = None
+        self._process_output_processing_thread = None
         self.auto_updates = self._get_update_script()
         self._target_endpoint = MessageEndpoints.scan_status()
         self._selected_device = None
@@ -118,7 +162,10 @@ class BECGuiClientMixin:
         Show the figure.
         """
         if self._process is None or self._process.poll() is not None:
-            self._start_plot_process()
+            self._start_update_script()
+            self._process, self._process_output_processing_thread = _start_plot_process(
+                self._gui_id, self.__class__, self._client._service_config.redis
+            )
         while not self.gui_is_alive():
             print("Waiting for GUI to start...")
             time.sleep(1)
@@ -138,34 +185,6 @@ class BECGuiClientMixin:
         self._process = None
         self._client.shutdown()
 
-    def _start_plot_process(self) -> None:
-        """
-        Start the plot in a new process.
-        """
-        self._start_update_script()
-        # pylint: disable=subprocess-run-check
-        config = self._client._service_config.redis
-        monitor_module = importlib.import_module("bec_widgets.cli.server")
-        monitor_path = monitor_module.__file__
-        gui_class = self.__class__.__name__
-
-        command = [
-            sys.executable,
-            "-u",
-            monitor_path,
-            "--id",
-            self._gui_id,
-            "--config",
-            config,
-            "--gui_class",
-            gui_class,
-        ]
-        self._process = subprocess.Popen(
-            command, text=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE
-        )
-        self._process_output_processing_thread = threading.Thread(target=self._get_output)
-        self._process_output_processing_thread.start()
-
     def print_log(self) -> None:
         """
         Print the log of the plot process.
@@ -176,26 +195,6 @@ class BECGuiClientMixin:
         # Flush list
         self.stderr_output.clear()
 
-    def _get_output(self) -> str:
-        try:
-            os.set_blocking(self._process.stdout.fileno(), False)
-            os.set_blocking(self._process.stderr.fileno(), False)
-            while self._process.poll() is None:
-                readylist, _, _ = select.select(
-                    [self._process.stdout, self._process.stderr], [], [], 1
-                )
-                if self._process.stdout in readylist:
-                    output = self._process.stdout.read(1024)
-                    if output:
-                        print(output, end="")
-                if self._process.stderr in readylist:
-                    error_output = self._process.stderr.read(1024)
-                    if error_output:
-                        print(error_output, end="", file=sys.stderr)
-                        self.stderr_output.append(error_output)
-        except Exception as e:
-            print(f"Error reading process output: {str(e)}")
-
 
 class RPCResponseTimeoutError(Exception):
     """Exception raised when an RPC response is not received within the expected time."""

{bec_widgets-0.57.0 → bec_widgets-0.57.2}/bec_widgets/examples/jupyter_console/jupyter_console_window.py

@@ -104,19 +104,19 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
     def _init_dock(self):
 
         self.d0 = self.dock.add_dock(name="dock_0")
-        self.fig0 = self.d0.add_widget_bec("BECFigure")
+        self.fig0 = self.d0.add_widget("BECFigure")
         self.fig0.image("eiger", vrange=(0, 100))
 
         self.d1 = self.dock.add_dock(name="dock_1", position="right")
-        self.fig1 = self.d1.add_widget_bec("BECFigure")
+        self.fig1 = self.d1.add_widget("BECFigure")
         self.fig1.plot(x_name="samx", y_name="bpm4i")
         self.fig1.plot(x_name="samx", y_name="bpm3a")
 
         self.d2 = self.dock.add_dock(name="dock_2", position="bottom")
-        self.fig2 = self.d2.add_widget_bec("BECFigure", row=0, col=0)
+        self.fig2 = self.d2.add_widget("BECFigure", row=0, col=0)
         self.fig2.motor_map(x_name="samx", y_name="samy")
         self.fig2.plot(x_name="samx", y_name="bpm4i")
-        self.bar = self.d2.add_widget_bec("SpiralProgressBar", row=0, col=1)
+        self.bar = self.d2.add_widget("SpiralProgressBar", row=0, col=1)
         self.bar.set_diameter(200)
 
         self.dock.save_state()

{bec_widgets-0.57.0 → bec_widgets-0.57.2}/bec_widgets/widgets/dock/dock.py

@@ -33,7 +33,7 @@ class BECDock(BECConnector, Dock):
         "hide_title_bar",
         "get_widgets_positions",
         "set_title",
-        "add_widget_bec",
+        "add_widget",
         "list_eligible_widgets",
         "move_widget",
         "remove_widget",
@@ -152,47 +152,47 @@ class BECDock(BECConnector, Dock):
         """
         return list(RPCWidgetHandler.widget_classes.keys())
 
-    def add_widget_bec(
-        self,
-        widget_type: str,
-        row=None,
-        col=0,
-        rowspan=1,
-        colspan=1,
-        shift: Literal["down", "up", "left", "right"] = "down",
-    ):
-        """
-        Add a widget to the dock.
-
-        Args:
-            widget_type(str): The widget to add. Only BEC RPC widgets from RPCWidgetHandler are allowed.
-            row(int): The row to add the widget to. If None, the widget will be added to the next available row.
-            col(int): The column to add the widget to.
-            rowspan(int): The number of rows the widget should span.
-            colspan(int): The number of columns the widget should span.
-            shift(Literal["down", "up", "left", "right"]): The direction to shift the widgets if the position is occupied.
-        """
-        if row is None:
-            row = self.layout.rowCount()
-
-        if self.layout_manager.is_position_occupied(row, col):
-            self.layout_manager.shift_widgets(shift, start_row=row)
-
-        widget = RPCWidgetHandler.create_widget(widget_type)
-        self.addWidget(widget, row=row, col=col, rowspan=rowspan, colspan=colspan)
-        self.config.widgets[widget.gui_id] = widget.config
-
-        return widget
+    # def add_widget_bec(
+    #     self,
+    #     widget_type: str,
+    #     row=None,
+    #     col=0,
+    #     rowspan=1,
+    #     colspan=1,
+    #     shift: Literal["down", "up", "left", "right"] = "down",
+    # ):
+    #     """
+    #     Add a widget to the dock.
+    #
+    #     Args:
+    #         widget_type(str): The widget to add. Only BEC RPC widgets from RPCWidgetHandler are allowed.
+    #         row(int): The row to add the widget to. If None, the widget will be added to the next available row.
+    #         col(int): The column to add the widget to.
+    #         rowspan(int): The number of rows the widget should span.
+    #         colspan(int): The number of columns the widget should span.
+    #         shift(Literal["down", "up", "left", "right"]): The direction to shift the widgets if the position is occupied.
+    #     """
+    #     if row is None:
+    #         row = self.layout.rowCount()
+    #
+    #     if self.layout_manager.is_position_occupied(row, col):
+    #         self.layout_manager.shift_widgets(shift, start_row=row)
+    #
+    #     widget = RPCWidgetHandler.create_widget(widget_type)
+    #     self.addWidget(widget, row=row, col=col, rowspan=rowspan, colspan=colspan)
+    #     self.config.widgets[widget.gui_id] = widget.config
+    #
+    #     return widget
 
     def add_widget(
         self,
-        widget: QWidget,
+        widget: BECConnector | str,
         row=None,
         col=0,
         rowspan=1,
         colspan=1,
         shift: Literal["down", "up", "left", "right"] = "down",
-    ):
+    ) -> BECConnector:
         """
         Add a widget to the dock.
 
@@ -210,8 +210,17 @@ class BECDock(BECConnector, Dock):
         if self.layout_manager.is_position_occupied(row, col):
             self.layout_manager.shift_widgets(shift, start_row=row)
 
+        if isinstance(widget, str):
+            widget = RPCWidgetHandler.create_widget(widget)
+        else:
+            widget = widget
+
         self.addWidget(widget, row=row, col=col, rowspan=rowspan, colspan=colspan)
-        self.config.widgets[widget.gui_id] = widget.config
+
+        if hasattr(widget, "config"):
+            self.config.widgets[widget.gui_id] = widget.config
+
+        return widget
 
     def move_widget(self, widget: QWidget, new_row: int, new_col: int):
         """

{bec_widgets-0.57.0 → bec_widgets-0.57.2}/bec_widgets/widgets/dock/dock_area.py

@@ -33,6 +33,7 @@ class BECDockArea(BECConnector, DockArea):
         "detach_dock",
         "attach_all",
         "get_all_rpc",
+        "temp_areas",
     ]
 
     def __init__(
@@ -70,9 +71,22 @@ class BECDockArea(BECConnector, DockArea):
 
     @panels.setter
     def panels(self, value: dict):
-
         self.docks = WeakValueDictionary(value)
 
+    @property
+    def temp_areas(self) -> list:
+        """
+        Get the temporary areas in the dock area.
+
+        Returns:
+            list: The temporary areas in the dock area.
+        """
+        return list(map(str, self.tempAreas))
+
+    @temp_areas.setter
+    def temp_areas(self, value: list):
+        self.tempAreas = list(map(str, value))
+
     def restore_state(
         self, state: dict = None, missing: Literal["ignore", "error"] = "ignore", extra="bottom"
     ):
@@ -107,6 +121,7 @@ class BECDockArea(BECConnector, DockArea):
             name(str): The name of the dock to remove.
         """
         dock = self.docks.pop(name, None)
+        self.config.docks.pop(name, None)
         if dock:
             dock.close()
             if len(self.docks) <= 1:
@@ -171,9 +186,7 @@ class BECDockArea(BECConnector, DockArea):
                 dock.show_title_bar()
 
         if widget is not None and isinstance(widget, str):
-            dock.add_widget_bec(
-                widget_type=widget, row=row, col=col, rowspan=rowspan, colspan=colspan
-            )
+            dock.add_widget(widget=widget, row=row, col=col, rowspan=rowspan, colspan=colspan)
         elif widget is not None and isinstance(widget, QWidget):
             dock.addWidget(widget, row=row, col=col, rowspan=rowspan, colspan=colspan)
         if self._instructions_visible:
@@ -192,7 +205,7 @@ class BECDockArea(BECConnector, DockArea):
             BECDock: The undocked dock.
         """
         dock = self.docks[dock_name]
-        self.floatDock(dock)
+        dock.detach()
         return dock
 
     def attach_all(self):

{bec_widgets-0.57.0 → bec_widgets-0.57.2}/bec_widgets/widgets/figure/plots/motor_map/motor_map.py

@@ -317,7 +317,7 @@ class BECMotorMap(BECPlotBase):
         Returns:
             float: Motor initial position.
         """
-        init_position = round(self.dev[name].read()[entry]["value"], precision)
+        init_position = round(float(self.dev[name].read()[entry]["value"]), precision)
         return init_position
 
     def _validate_signal_entries(
@@ -403,7 +403,7 @@ class BECMotorMap(BECPlotBase):
         # Update plot title
         precision = self.config.precision
         self.set_title(
-            f"Motor position: ({round(current_x,precision)}, {round(current_y,precision)})"
+            f"Motor position: ({round(float(current_x),precision)}, {round(float(current_y),precision)})"
         )
 
     @pyqtSlot(dict)

{bec_widgets-0.57.0 → bec_widgets-0.57.2}/bec_widgets/widgets/figure/plots/waveform/waveform.py

@@ -577,7 +577,6 @@ class BECWaveform(BECPlotBase):
         Returns:
             dict | pd.DataFrame: Data of all curves in the specified format.
         """
-
         data = {}
         try:
             import pandas as pd

{bec_widgets-0.57.0 → bec_widgets-0.57.2}/bec_widgets/widgets/spiral_progress_bar/ring.py

@@ -115,7 +115,8 @@ class Ring(BECConnector):
 
     def set_value(self, value: int | float):
         self.config.value = round(
-            max(self.config.min_value, min(self.config.max_value, value)), self.config.precision
+            float(max(self.config.min_value, min(self.config.max_value, value))),
+            self.config.precision,
         )
 
     def set_color(self, color: str | tuple):

{bec_widgets-0.57.0 → bec_widgets-0.57.2}/docs/user/widgets/bec_figure.md

@@ -20,7 +20,7 @@ In the following, we describe 4 different type of widgets thaat are available in
 The following code snipped demonstrates how to create a 1D waveform plot using BEC Widgets within BEC. More details about BEC Widgets in BEC can be found in the getting started section within the [introduction to the command line.](user.command_line_introduction)
 ```python
 # adds a new dock, a new BECFigure and a BECWaveForm to the dock
-plt = gui.add_dock().add_widget_bec('BECFigure').plot('samx', 'bpm4i')
+plt = gui.add_dock().add_widget('BECFigure').plot('samx', 'bpm4i')
 # add a second curve to the same plot 
 plt.add_curve_scan('samx', 'bpm3i')
 plt.set_title("Gauss plots vs. samx")
@@ -53,7 +53,7 @@ dev.bpm3i.sim.select_sim_model("StepModel")
 The following code snipped demonstrates how to create a 2D scatter plot using BEC Widgets within BEC.
 ```python
 # adds a new dock, a new BECFigure and a BECWaveForm to the dock
-plt = gui.add_dock().add_widget_bec('BECFigure').add_plot('samx', 'samy', 'bpm4i')
+plt = gui.add_dock().add_widget('BECFigure').add_plot('samx', 'samy', 'bpm4i')
 ```
 
 (user.widgets.motor_map)=
@@ -72,7 +72,7 @@ plt = gui.add_dock().add_widget_bec('BECFigure').add_plot('samx', 'samy', 'bpm4i
 The following code snipped demonstrates how to create a motor map using BEC Widgets within BEC.
 ```python
 # add a motor map to the gui
-mot_map = gui.add_dock().add_widget_bec('BECFigure').motor_map('samx', 'samy')
+mot_map = gui.add_dock().add_widget('BECFigure').motor_map('samx', 'samy')
 # change the number of points displayed
 ```
 
@@ -91,7 +91,7 @@ mot_map = gui.add_dock().add_widget_bec('BECFigure').motor_map('samx', 'samy')
 The following code snipped demonstrates how to create a motor map using BEC Widgets within BEC.
 ```python
 # add a camera view for the eiger camera to the gui
-cam_widget = gui.add_dock().add_widget_bec('BECFigure').image('eiger')
+cam_widget = gui.add_dock().add_widget('BECFigure').image('eiger')
 # set the title of the camera view
 cam_widget.set_title("Camera Image Eiger")
 # change the color map range, e.g. from 0 to 100, per default it is autoscaling

{bec_widgets-0.57.0 → bec_widgets-0.57.2}/docs/user/widgets/spiral_progress_bar.md

@@ -15,7 +15,7 @@
 The following code snipped demonstrates how to create a 2D scatter plot using BEC Widgets within BEC.
 ```python
 # adds a new dock with a spiral progress bar
-progress = gui.add_dock().add_widget_bec("SpiralProgressBar")
+progress = gui.add_dock().add_widget("SpiralProgressBar")
 # customize the size of the ring
-progress.set_line_widfth(20)
+progress.set_line_width(20)
 ```

{bec_widgets-0.57.0 → bec_widgets-0.57.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_widgets"
-version = "0.57.0"
+version = "0.57.2"
 description = "BEC Widgets"
 requires-python = ">=3.10"
 classifiers = [
@@ -31,6 +31,7 @@ dev = [
     "pytest",
     "pytest-random-order",
     "pytest-timeout",
+    "pytest-xvfb",
     "coverage",
     "pytest-qt",
     "isort",

bec_widgets-0.57.2/tests/end-2-end/conftest.py

@@ -0,0 +1,55 @@
+import random
+import time
+from contextlib import contextmanager
+
+import pytest
+from bec_lib.endpoints import MessageEndpoints
+
+from bec_widgets.cli.client_utils import _start_plot_process
+from bec_widgets.cli.rpc_register import RPCRegister
+from bec_widgets.utils import BECDispatcher
+from bec_widgets.widgets import BECDockArea, BECFigure
+
+
+# make threads check in autouse, **will be executed at the end**; better than
+# having it in fixtures for each test, since it prevents from needing to
+# 'manually' shutdown bec_client_lib (for example) to make it happy, whereas
+# whereas in fact bec_client_lib makes its on cleanup
+@pytest.fixture(autouse=True)
+def threads_check_fixture(threads_check):
+    return
+
+
+@pytest.fixture
+def gui_id():
+    return f"figure_{random.randint(0,100)}"  # make a new gui id each time, to ensure no 'gui is alive' zombie key can perturbate
+
+
+@contextmanager
+def plot_server(gui_id, klass, client_lib):
+    dispatcher = BECDispatcher(client=client_lib)  # Has to init singleton with fixture client
+    process, output_thread = _start_plot_process(
+        gui_id, klass, client_lib._client._service_config.redis
+    )
+    try:
+        while client_lib._client.connector.get(MessageEndpoints.gui_heartbeat(gui_id)) is None:
+            time.sleep(0.3)
+        yield gui_id
+    finally:
+        process.terminate()
+        process.wait()
+        output_thread.join()
+        dispatcher.disconnect_all()
+        dispatcher.reset_singleton()
+
+
+@pytest.fixture
+def rpc_server_figure(gui_id, bec_client_lib):
+    with plot_server(gui_id, BECFigure, bec_client_lib) as server:
+        yield server
+
+
+@pytest.fixture
+def rpc_server_dock(gui_id, bec_client_lib):
+    with plot_server(gui_id, BECDockArea, bec_client_lib) as server:
+        yield server