bec-widgets 1.5.2__tar.gz → 1.6.0__tar.gz

{bec_widgets-1.5.2 → bec_widgets-1.6.0}/.gitlab-ci.yml

@@ -12,6 +12,9 @@ variables:
     description: ophyd_devices branch
     value: main
   CHILD_PIPELINE_BRANCH: $CI_DEFAULT_BRANCH
+  CHECK_PKG_VERSIONS:
+    description: Whether to run additional tests against min/max/random selection of dependencies. Set to 1 for running. 
+    value: 0
 
 workflow:
   rules:
@@ -31,8 +34,9 @@ include:
     inputs:
       stage: test
       path: "."
-      pytest_args: "-v --random-order tests/"
-      exclude_packages: ""
+      pytest_args: "-v,--random-order,tests/unit_tests"
+      ignore_dep_group: "pyqt6"
+      pip_args: ".[dev,pyside6]"
 
 # different stages in the pipeline
 stages:

{bec_widgets-1.5.2 → bec_widgets-1.6.0}/CHANGELOG.md

@@ -1,6 +1,80 @@
 # CHANGELOG
 
 
+## v1.6.0 (2024-11-27)
+
+### Bug Fixes
+
+- **tests**: Make use of BECDockArea with client mixin to start server and use it in tests
+  ([`da18c2c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/da18c2ceecf9aeaf0e0ea9b78f4c867b27b9c314))
+
+Depending on the test, auto-updates are enabled or not.
+
+- Differentiate click and drag for DeviceItem, adapt tests accordingly
+  ([`cffcdf2`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/cffcdf292363249bcc7efa9d130431d0bc727fda))
+
+This fixes the blocking "QDrag.exec_()" on Linux, indeed before the drag'n'drop operation was
+  started with a simple click and it was waiting for drop forever. Now there are 2 different cases,
+  click or drag'n'drop - the drag'n'drop test actually moves the mouse and releases the button.
+
+- **server**: Use dock area by default
+  ([`2fe7f5e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2fe7f5e1510a5ea72676045e6ea3485e6b11c220))
+
+- **rpc**: Gui hide/show also hide/show all floating docks
+  ([`c27d058`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c27d058b01fe604eccec76454e39360122e48515))
+
+- Do not quit automatically when last window is "closed"
+  ([`96e255e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/96e255e4ef394eb79006a66d13e06775ae235667))
+
+Qt confuses closed and hidden
+
+- No need to call inspect.signature - it can fail on methods coming from C (like Qt methods)
+  ([`6029246`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/60292465e9e52d3248ae681c68c07298b9b3ce14))
+
+- Add back accidentally removed variables
+  ([`e998352`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e9983521ed2a1c04af048a55ece70a1943a84313))
+
+### Features
+
+- '._auto_updates_enabled' attribute can be used to activate auto updates installation in
+  BECDockArea
+  ([`31d8703`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/31d87036c9801e639a7ca6fc003c90e0c4edb19d))
+
+- Add rpc_id member to client objects
+  ([`3ba0b1d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3ba0b1daf5b83da840e90fbbc063ed7b86ebe99b))
+
+- **client**: Add show()/hide() methods to "gui" object
+  ([`e68e2b5`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e68e2b5978339475b97555c3e20795807932fbc9))
+
+- **server**: Add main window, with proper gui_id derived from given id
+  ([`daf6ea0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/daf6ea0159c9ffc7b53bb7ae6b9abc16a302972c))
+
+- Add main window container widget
+  ([`f80ec33`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f80ec33ae5a261dbcab901ae30f4cc802316e554))
+
+- Asynchronous .start() for GUI
+  ([`2047e48`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2047e484d5a4b2f5ea494a1e49035b35b1bbde35))
+
+- Do not take focus when GUI is loaded
+  ([`1f71d8e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1f71d8e5eded9952f9b34bfc427e2ff44cf5fc18))
+
+- Add '--hide' argument to BEC GUI server
+  ([`1f60fec`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1f60fec7201ed252d7e49bf16f2166ee7f6bed6a))
+
+
+## v1.5.3 (2024-11-21)
+
+### Bug Fixes
+
+- **alignment_1d**: Fix imports after widget module refactor
+  ([`e71e3b2`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e71e3b2956feb3f3051e538432133f6e85bbd5a8))
+
+### Continuous Integration
+
+- Fix ci syntax for package-dep-job
+  ([`6e39bdb`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6e39bdbf53b147c8ff163527b45691835ce9a2eb))
+
+
 ## v1.5.2 (2024-11-18)
 
 ### Bug Fixes
@@ -134,83 +208,3 @@
 
 
 ## v1.1.0 (2024-10-25)
-
-### Features
-
-- Add filter i/o utility class
-  ([`0350833`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/0350833f36e0a7cadce4173f9b1d1fbfdf985375))
-
-### Refactoring
-
-- Do not flush selection upon receiving config update; allow widgetIO to receive kwargs to be able
-  to use get_value to receive string instead of int for QComboBox
-  ([`91959e8`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/91959e82de8586934af3ebb5aaa0923930effc51))
-
-- Allow to set selection in DeviceInput; automatic update of selection on device config update;
-  cleanup
-  ([`5eb15b7`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5eb15b785f12e30eb8ccbc56d4ad9e759a4cf5eb))
-
-- Cleanup, added device_signal for signal inputs
-  ([`6fb2055`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6fb20552ff57978f4aeb79fd7f062f8d6b5581e7))
-
-### Testing
-
-- **scan_control**: Tests added for grid_scan to ensure scan_args signal validity
-  ([`acb7902`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/acb79020d4be546efc001ff47b6f5cdba2ee9375))
-
-
-## v1.0.2 (2024-10-22)
-
-### Bug Fixes
-
-- **scan_control**: Scan args signal fixed to emit list instead of hardcoded structure
-  ([`4f5448c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4f5448cf51a204e077af162c7f0aed1f1a60e57a))
-
-
-## v1.0.1 (2024-10-22)
-
-### Bug Fixes
-
-- **waveform**: Added support for live_data and data access
-  ([`7469c89`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7469c892c8076fc09e61f173df6920c551241cec))
-
-
-## v1.0.0 (2024-10-18)
-
-### Bug Fixes
-
-- **crosshair**: Downsample clear markers
-  ([`f9a889f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f9a889fc6d380b9e587edcb465203122ea0bffc1))
-
-### Features
-
-- Ability to disable scatter from waveform & compatible crosshair with down sampling
-  ([`2ab12ed`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2ab12ed60abb995abc381d9330fdcf399796d9e5))
-
-
-## v0.119.0 (2024-10-17)
-
-### Bug Fixes
-
-- Fix syntax due to change of api for simulated devices
-  ([`19f4e40`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/19f4e407e00ee242973ca4c3f90e4e41a4d3e315))
-
-- Remove wrongly scoped test
-  ([`a23841b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a23841b2553dc7162da943715d58275c7dc39ed9))
-
-- Rename 'compact' property -> 'compact_view'
-  ([`6982711`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6982711fea5fb8a73845ed7c0692e3ec53ef7871))
-
-- Alignment 1D update, make app window a main window (in .ui file)
-  ([`0015f0e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/0015f0e2d62adc02d3ef334e1f6dbb2d0288fec6))
-
-### Features
-
-- New PositionerGroup widget
-  ([`af9655d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/af9655de0c541092437accfbaa779628a2f48ccb))
-
-- Add 'expand_popup' property to CompactPopupWidget
-  ([`e4121a0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e4121a01cb6b8d496e630cd43bc642b994b8f310))
-
-This property tells if expand should show a popup (by default), or if the widget should expand
-  in-place

{bec_widgets-1.5.2 → bec_widgets-1.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 1.5.2
+Version: 1.6.0
 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-1.5.2 → bec_widgets-1.6.0}/bec_widgets/applications/alignment/alignment_1d/alignment_1d.py

@@ -18,9 +18,11 @@ from bec_widgets.utils import UILoader
 from bec_widgets.utils.bec_dispatcher import BECDispatcher
 from bec_widgets.utils.colors import get_accent_colors
 from bec_widgets.widgets.control.buttons.stop_button.stop_button import StopButton
-from bec_widgets.widgets.control.device_control.positioner_group import PositionerGroup
-from bec_widgets.widgets.dap.lmfit_dialog import LMFitDialog
-from bec_widgets.widgets.plots.waveform import BECWaveformWidget
+from bec_widgets.widgets.control.device_control.positioner_group.positioner_group import (
+    PositionerGroup,
+)
+from bec_widgets.widgets.dap.lmfit_dialog.lmfit_dialog import LMFitDialog
+from bec_widgets.widgets.plots.waveform.waveform_widget import BECWaveformWidget
 from bec_widgets.widgets.progress.bec_progressbar.bec_progressbar import BECProgressBar
 
 MODULE_PATH = os.path.dirname(bec_widgets.__file__)

{bec_widgets-1.5.2 → bec_widgets-1.6.0}/bec_widgets/cli/client.py

@@ -15,6 +15,37 @@ class Widgets(str, enum.Enum):
     Enum for the available widgets.
     """
 
+    AbortButton = "AbortButton"
+    BECColorMapWidget = "BECColorMapWidget"
+    BECDockArea = "BECDockArea"
+    BECImageWidget = "BECImageWidget"
+    BECMainWindow = "BECMainWindow"
+    BECMotorMapWidget = "BECMotorMapWidget"
+    BECMultiWaveformWidget = "BECMultiWaveformWidget"
+    BECProgressBar = "BECProgressBar"
+    BECQueue = "BECQueue"
+    BECStatusBox = "BECStatusBox"
+    BECWaveformWidget = "BECWaveformWidget"
+    DapComboBox = "DapComboBox"
+    DarkModeButton = "DarkModeButton"
+    DeviceBrowser = "DeviceBrowser"
+    DeviceComboBox = "DeviceComboBox"
+    DeviceLineEdit = "DeviceLineEdit"
+    LMFitDialog = "LMFitDialog"
+    PositionIndicator = "PositionIndicator"
+    PositionerBox = "PositionerBox"
+    PositionerControlLine = "PositionerControlLine"
+    ResetButton = "ResetButton"
+    ResumeButton = "ResumeButton"
+    RingProgressBar = "RingProgressBar"
+    ScanControl = "ScanControl"
+    SignalComboBox = "SignalComboBox"
+    SignalLineEdit = "SignalLineEdit"
+    StopButton = "StopButton"
+    TextBox = "TextBox"
+    VSCodeEditor = "VSCodeEditor"
+    WebsiteWidget = "WebsiteWidget"
+
 
 class AbortButton(RPCBase):
     @property
@@ -431,6 +462,18 @@ class BECDockArea(RPCBase, BECGuiClientMixin):
             list: The temporary areas in the dock area.
         """
 
+    @rpc_call
+    def show(self):
+        """
+        Show all windows including floating docks.
+        """
+
+    @rpc_call
+    def hide(self):
+        """
+        Hide all windows including floating docks.
+        """
+
 
 class BECFigure(RPCBase):
     @property
@@ -1343,6 +1386,31 @@ class BECImageWidget(RPCBase):
         """
 
 
+class BECMainWindow(RPCBase):
+    @property
+    @rpc_call
+    def _config_dict(self) -> "dict":
+        """
+        Get the configuration of the widget.
+
+        Returns:
+            dict: The configuration of the widget.
+        """
+
+    @rpc_call
+    def _get_all_rpc(self) -> "dict":
+        """
+        Get all registered RPC objects.
+        """
+
+    @property
+    @rpc_call
+    def _rpc_id(self) -> "str":
+        """
+        Get the RPC ID of the widget.
+        """
+
+
 class BECMotorMap(RPCBase):
     @property
     @rpc_call
@@ -2207,6 +2275,13 @@ class BECQueue(RPCBase):
         Get all registered RPC objects.
         """
 
+    @property
+    @rpc_call
+    def _rpc_id(self) -> "str":
+        """
+        Get the RPC ID of the widget.
+        """
+
 
 class BECStatusBox(RPCBase):
     @property
@@ -2225,6 +2300,13 @@ class BECStatusBox(RPCBase):
         Get all registered RPC objects.
         """
 
+    @property
+    @rpc_call
+    def _rpc_id(self) -> "str":
+        """
+        Get the RPC ID of the widget.
+        """
+
 
 class BECWaveform(RPCBase):
     @property
@@ -2947,6 +3029,13 @@ class DeviceBrowser(RPCBase):
         Get all registered RPC objects.
         """
 
+    @property
+    @rpc_call
+    def _rpc_id(self) -> "str":
+        """
+        Get the RPC ID of the widget.
+        """
+
 
 class DeviceComboBox(RPCBase):
     @property
@@ -2965,6 +3054,13 @@ class DeviceComboBox(RPCBase):
         Get all registered RPC objects.
         """
 
+    @property
+    @rpc_call
+    def _rpc_id(self) -> "str":
+        """
+        Get the RPC ID of the widget.
+        """
+
 
 class DeviceInputBase(RPCBase):
     @property
@@ -2983,6 +3079,13 @@ class DeviceInputBase(RPCBase):
         Get all registered RPC objects.
         """
 
+    @property
+    @rpc_call
+    def _rpc_id(self) -> "str":
+        """
+        Get the RPC ID of the widget.
+        """
+
 
 class DeviceLineEdit(RPCBase):
     @property
@@ -3001,6 +3104,13 @@ class DeviceLineEdit(RPCBase):
         Get all registered RPC objects.
         """
 
+    @property
+    @rpc_call
+    def _rpc_id(self) -> "str":
+        """
+        Get the RPC ID of the widget.
+        """
+
 
 class DeviceSignalInputBase(RPCBase):
     @property
@@ -3019,6 +3129,13 @@ class DeviceSignalInputBase(RPCBase):
         Get all registered RPC objects.
         """
 
+    @property
+    @rpc_call
+    def _rpc_id(self) -> "str":
+        """
+        Get the RPC ID of the widget.
+        """
+
 
 class LMFitDialog(RPCBase):
     @property
@@ -3037,6 +3154,13 @@ class LMFitDialog(RPCBase):
         Get all registered RPC objects.
         """
 
+    @property
+    @rpc_call
+    def _rpc_id(self) -> "str":
+        """
+        Get the RPC ID of the widget.
+        """
+
 
 class PositionIndicator(RPCBase):
     @rpc_call
@@ -3126,6 +3250,13 @@ class ResetButton(RPCBase):
         Get all registered RPC objects.
         """
 
+    @property
+    @rpc_call
+    def _rpc_id(self) -> "str":
+        """
+        Get the RPC ID of the widget.
+        """
+
 
 class ResumeButton(RPCBase):
     @property
@@ -3144,6 +3275,13 @@ class ResumeButton(RPCBase):
         Get all registered RPC objects.
         """
 
+    @property
+    @rpc_call
+    def _rpc_id(self) -> "str":
+        """
+        Get the RPC ID of the widget.
+        """
+
 
 class Ring(RPCBase):
     @rpc_call
@@ -3441,6 +3579,13 @@ class ScanControl(RPCBase):
         Get all registered RPC objects.
         """
 
+    @property
+    @rpc_call
+    def _rpc_id(self) -> "str":
+        """
+        Get the RPC ID of the widget.
+        """
+
 
 class SignalComboBox(RPCBase):
     @property
@@ -3459,6 +3604,13 @@ class SignalComboBox(RPCBase):
         Get all registered RPC objects.
         """
 
+    @property
+    @rpc_call
+    def _rpc_id(self) -> "str":
+        """
+        Get the RPC ID of the widget.
+        """
+
 
 class SignalLineEdit(RPCBase):
     @property
@@ -3477,6 +3629,13 @@ class SignalLineEdit(RPCBase):
         Get all registered RPC objects.
         """
 
+    @property
+    @rpc_call
+    def _rpc_id(self) -> "str":
+        """
+        Get the RPC ID of the widget.
+        """
+
 
 class StopButton(RPCBase):
     @property
@@ -3495,6 +3654,13 @@ class StopButton(RPCBase):
         Get all registered RPC objects.
         """
 
+    @property
+    @rpc_call
+    def _rpc_id(self) -> "str":
+        """
+        Get the RPC ID of the widget.
+        """
+
 
 class TextBox(RPCBase):
     @rpc_call

{bec_widgets-1.5.2 → bec_widgets-1.6.0}/bec_widgets/cli/client_utils.py

@@ -92,11 +92,11 @@ def _start_plot_process(gui_id: str, gui_class: type, config: dict | str, logger
     process will not be captured.
     """
     # pylint: disable=subprocess-run-check
-    command = ["bec-gui-server", "--id", gui_id, "--gui_class", gui_class.__name__]
+    command = ["bec-gui-server", "--id", gui_id, "--gui_class", gui_class.__name__, "--hide"]
     if config:
         if isinstance(config, dict):
             config = json.dumps(config)
-        command.extend(["--config", config])
+        command.extend(["--config", str(config)])
 
     env_dict = os.environ.copy()
     env_dict["PYTHONUNBUFFERED"] = "1"
@@ -126,15 +126,36 @@ def _start_plot_process(gui_id: str, gui_class: type, config: dict | str, logger
     return process, process_output_processing_thread
 
 
+class RepeatTimer(threading.Timer):
+    def run(self):
+        while not self.finished.wait(self.interval):
+            self.function(*self.args, **self.kwargs)
+
+
 class BECGuiClientMixin:
     def __init__(self, **kwargs) -> None:
         super().__init__(**kwargs)
+        self._auto_updates_enabled = True
+        self._auto_updates = None
+        self._gui_started_timer = None
+        self._gui_started_event = threading.Event()
         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
 
+    @property
+    def auto_updates(self):
+        if self._auto_updates_enabled:
+            self._gui_started_event.wait()
+        return self._auto_updates
+
+    def shutdown_auto_updates(self):
+        if self._auto_updates_enabled:
+            if self._auto_updates is not None:
+                self._auto_updates.shutdown()
+                self._auto_updates = None
+
     def _get_update_script(self) -> AutoUpdates | None:
         eps = imd.entry_points(group="bec.widgets.auto_updates")
         for ep in eps:
@@ -180,38 +201,80 @@ class BECGuiClientMixin:
         if isinstance(msg, messages.ScanStatusMessage):
             if not self.gui_is_alive():
                 return
-            self.auto_updates.msg_queue.put(msg)
-
-    def show(self) -> None:
+            if self._auto_updates_enabled:
+                self.auto_updates.msg_queue.put(msg)
+
+    def _gui_post_startup(self):
+        if self._auto_updates_enabled:
+            if self._auto_updates is None:
+                auto_updates = self._get_update_script()
+                if auto_updates is None:
+                    AutoUpdates.create_default_dock = True
+                    AutoUpdates.enabled = True
+                    auto_updates = AutoUpdates(gui=self)
+                if auto_updates.create_default_dock:
+                    auto_updates.start_default_dock()
+                    # fig = auto_updates.get_default_figure()
+                self._auto_updates = auto_updates
+        self._gui_started_event.set()
+        self.show_all()
+
+    def start_server(self, wait=False) -> None:
         """
-        Show the figure.
+        Start the GUI server, and execute callback when it is launched
         """
         if self._process is None or self._process.poll() is not None:
+            logger.success("GUI starting...")
+            self._gui_started_event.clear()
             self._start_update_script()
             self._process, self._process_output_processing_thread = _start_plot_process(
                 self._gui_id, self.__class__, self._client._service_config.config, logger=logger
             )
-        while not self.gui_is_alive():
-            print("Waiting for GUI to start...")
-            time.sleep(1)
-        logger.success(f"GUI started with id: {self._gui_id}")
+
+            def gui_started_callback(callback):
+                try:
+                    if callable(callback):
+                        callback()
+                finally:
+                    threading.current_thread().cancel()
+
+            self._gui_started_timer = RepeatTimer(
+                1, lambda: self.gui_is_alive() and gui_started_callback(self._gui_post_startup)
+            )
+            self._gui_started_timer.start()
+
+        if wait:
+            self._gui_started_event.wait()
+
+    def show_all(self):
+        self._gui_started_event.wait()
+        rpc_client = RPCBase(gui_id=f"{self._gui_id}:window", parent=self)
+        rpc_client._run_rpc("show")
+
+    def hide_all(self):
+        self._gui_started_event.wait()
+        rpc_client = RPCBase(gui_id=f"{self._gui_id}:window", parent=self)
+        rpc_client._run_rpc("hide")
 
     def close(self) -> None:
         """
         Close the gui window.
         """
+        if self._gui_started_timer is not None:
+            self._gui_started_timer.cancel()
+            self._gui_started_timer.join()
+
         if self._process is None:
             return
 
-        self._client.shutdown()
         if self._process:
+            logger.success("Stopping GUI...")
             self._process.terminate()
             if self._process_output_processing_thread:
                 self._process_output_processing_thread.join()
             self._process.wait()
             self._process = None
-        if self.auto_updates is not None:
-            self.auto_updates.shutdown()
+        self.shutdown_auto_updates()
 
 
 class RPCResponseTimeoutError(Exception):