bec-widgets 0.94.7__tar.gz → 0.95.0__tar.gz

{bec_widgets-0.94.7 → bec_widgets-0.95.0}/CHANGELOG.md

@@ -1,5 +1,35 @@
 # CHANGELOG
 
+## v0.95.0 (2024-08-21)
+
+### Documentation
+
+* docs(device_browser): added user docs ([`2c31cc9`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2c31cc90ae751f14a653cbbdd6c353d6359aaafe))
+
+* docs(user): widget gallery with documentation added ([`7357f3d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7357f3d2a189f9f04954a027f39ce07c394d57ec))
+
+* docs: added sphinx-inline-tabs as sphinx dependency ([`e9ecd26`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e9ecd268c602ea9572df0e8d508e49ee62d0c170))
+
+* docs(cards): changed index cards to custom css class instead of overwriting the default sd-card theme ([`91ba30e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/91ba30e8d054a9c7f6c6d98b21113a5d0b1bbbbb))
+
+### Feature
+
+* feat(cli): added device_browser to cli ([`196504b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/196504b533367a899c19b88af4ccd5b39dc46aac))
+
+* feat(widgets): added device_browser widget ([`73f5a2f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/73f5a2f085b289ac18fa8a918b6ad7cfed595fb4))
+
+### Fix
+
+* fix(device_browser): fixed plugin assignment for designer ([`6500393`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/650039303aae9bbec62c676285938416fff146ce))
+
+### Refactor
+
+* refactor(docs): review response ([`4790afd`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4790afde3d61fc9beb073c2775c339d4f80779e3))
+
+### Test
+
+* test: added test for device browser ([`e870e5b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e870e5ba083c61df581c9c0305adabe72967f997))
+
 ## v0.94.7 (2024-08-20)
 
 ### Fix
@@ -121,37 +151,3 @@ Terminating client connections has to be done at the application level ([`198c1d
 * test: ensure all toplevelwidgets are closed ([`f9e5897`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f9e58979009cf632feea529700ad191401dd7eb8))
 
 ## v0.93.2 (2024-08-07)
-
-### Fix
-
-* fix(scan_group_box): Scan Spinboxes limits increased to max allowed values; setting dialog for step size and decimal precision for ScanDoubleSpinBox on right click ([`a372925`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a372925fffa787c686198ae7cb3f9c15b459c109))
-
-## v0.93.1 (2024-08-06)
-
-### Documentation
-
-* docs: added video tutorial section with BSEG YT video ([`302ae90`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/302ae90139f6a88e2401fe29fe312387486e27a9))
-
-### Fix
-
-* fix(dock): docks have more recognizable red icon for closing docks ([`af86860`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/af86860bf35474805fb1a7bc3725cf8835ed4cc7))
-
-## v0.93.0 (2024-08-05)
-
-### Feature
-
-* feat(themes): moved themes to bec_qthemes
-
-This reverts commit fd6ae91993a23a7b8dbb2cf3c4b7c3eda6d2b0f6 ([`5aad401`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5aad401ef8774c7330784f72cd3b9d8c253e2b6a))
-
-## v0.92.5 (2024-08-05)
-
-### Fix
-
-* fix(spinner): stop timer on close event ([`30fef92`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/30fef929cf6fb4b73f48151c92a0ee54c734031d))
-
-* fix(status_box): fix cleanup of status box ([`1f30dd7`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1f30dd73a9c1e3135087a5eef92c7329f54a604e))
-
-### Test
-
-* test: register all widgets with qtbot and close them ([`73cd11e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/73cd11e47277e4437554b785a9551b28a572094f))

{bec_widgets-0.94.7 → bec_widgets-0.95.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.94.7
+Version: 0.95.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-0.94.7 → bec_widgets-0.95.0}/bec_widgets/cli/client.py

@@ -21,6 +21,7 @@ class Widgets(str, enum.Enum):
     BECQueue = "BECQueue"
     BECStatusBox = "BECStatusBox"
     BECWaveformWidget = "BECWaveformWidget"
+    DeviceBrowser = "DeviceBrowser"
     DeviceComboBox = "DeviceComboBox"
     DeviceLineEdit = "DeviceLineEdit"
     PositionerBox = "PositionerBox"
@@ -2288,6 +2289,24 @@ class BECWaveformWidget(RPCBase):
         """
 
 
+class DeviceBrowser(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.
+        """
+
+
 class DeviceComboBox(RPCBase):
     @property
     @rpc_call

bec_widgets-0.95.0/bec_widgets/widgets/device_browser/device_browser.py

@@ -0,0 +1,107 @@
+import os
+import re
+from typing import Optional
+
+from bec_lib.callback_handler import EventType
+from pyqtgraph import SignalProxy
+from qtpy.QtCore import Signal, Slot
+from qtpy.QtWidgets import QLineEdit, QListWidgetItem, QVBoxLayout, QWidget
+
+from bec_widgets.utils.bec_widget import BECWidget
+from bec_widgets.utils.ui_loader import UILoader
+from bec_widgets.widgets.device_browser.device_item import DeviceItem
+
+
+class DeviceBrowser(BECWidget, QWidget):
+    device_update: Signal = Signal()
+
+    def __init__(
+        self,
+        parent: Optional[QWidget] = None,
+        config=None,
+        client=None,
+        gui_id: Optional[str] = None,
+    ) -> None:
+        super().__init__(client=client, config=config, gui_id=gui_id)
+        QWidget.__init__(self, parent)
+
+        self.get_bec_shortcuts()
+        self.ui = None
+        self.ini_ui()
+
+        self.proxy_device_update = SignalProxy(
+            self.ui.filter_input.textChanged, rateLimit=500, slot=self.update_device_list
+        )
+        self.bec_dispatcher.client.callbacks.register(
+            EventType.DEVICE_UPDATE, self.on_device_update
+        )
+        self.device_update.connect(self.update_device_list)
+
+        self.update_device_list()
+
+    def ini_ui(self) -> None:
+        """
+        Initialize the UI by loading the UI file and setting the layout.
+        """
+        layout = QVBoxLayout()
+        layout.setContentsMargins(0, 0, 0, 0)
+
+        ui_file_path = os.path.join(os.path.dirname(__file__), "device_browser.ui")
+        self.ui = UILoader(self).loader(ui_file_path)
+        layout.addWidget(self.ui)
+        self.setLayout(layout)
+
+    def on_device_update(self, action: str, content: dict) -> None:
+        """
+        Callback for device update events. Triggers the device_update signal.
+
+        Args:
+            action (str): The action that triggered the event.
+            content (dict): The content of the config update.
+        """
+        if action in ["add", "remove", "reload"]:
+            self.device_update.emit()
+
+    @Slot()
+    def update_device_list(self) -> None:
+        """
+        Update the device list based on the filter input.
+        There are two ways to trigger this function:
+        1. By changing the text in the filter input.
+        2. By emitting the device_update signal.
+
+        Either way, the function will filter the devices based on the filter input text and update the device list.
+        """
+        filter_text = self.ui.filter_input.text()
+        try:
+            regex = re.compile(filter_text, re.IGNORECASE)
+        except re.error:
+            regex = None  # Invalid regex, disable filtering
+
+        dev_list = self.ui.device_list
+        dev_list.clear()
+        for device in self.dev:
+            if regex is None or regex.search(device):
+                item = QListWidgetItem(dev_list)
+                device_item = DeviceItem(device)
+
+                # pylint: disable=protected-access
+                tooltip = self.dev[device]._config.get("description", "")
+                device_item.setToolTip(tooltip)
+                item.setSizeHint(device_item.sizeHint())
+                dev_list.setItemWidget(item, device_item)
+                dev_list.addItem(item)
+
+
+if __name__ == "__main__":  # pragma: no cover
+    import sys
+
+    from qtpy.QtWidgets import QApplication
+
+    from bec_widgets.utils.colors import apply_theme
+
+    app = QApplication(sys.argv)
+    apply_theme("light")
+    widget = DeviceBrowser()
+    widget.show()
+    sys.exit(app.exec_())

bec_widgets-0.95.0/bec_widgets/widgets/device_browser/device_browser.pyproject

@@ -0,0 +1 @@
+{'files': ['device_browser.py']}

bec_widgets-0.95.0/bec_widgets/widgets/device_browser/device_browser.ui

@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>Form</class>
+ <widget class="QWidget" name="Form">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>406</width>
+    <height>500</height>
+   </rect>
+  </property>
+  <property name="windowTitle">
+   <string>Form</string>
+  </property>
+  <layout class="QVBoxLayout" name="verticalLayout">
+   <item>
+    <widget class="QGroupBox" name="browser_group_box">
+     <property name="title">
+      <string>Device Browser</string>
+     </property>
+     <layout class="QVBoxLayout" name="verticalLayout_2">
+      <item>
+       <layout class="QHBoxLayout" name="filter_layout">
+        <item>
+         <widget class="QLineEdit" name="filter_input">
+          <property name="placeholderText">
+           <string>Filter</string>
+          </property>
+         </widget>
+        </item>
+       </layout>
+      </item>
+      <item>
+       <widget class="QListWidget" name="device_list"/>
+      </item>
+     </layout>
+    </widget>
+   </item>
+  </layout>
+ </widget>
+ <resources/>
+ <connections/>
+</ui>

bec_widgets-0.95.0/bec_widgets/widgets/device_browser/device_browser_plugin.py

@@ -0,0 +1,54 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+
+from qtpy.QtDesigner import QDesignerCustomWidgetInterface
+from qtpy.QtGui import QIcon
+
+from bec_widgets.widgets.device_browser.device_browser import DeviceBrowser
+
+DOM_XML = """
+<ui language='c++'>
+    <widget class='DeviceBrowser' name='device_browser'>
+    </widget>
+</ui>
+"""
+
+
+class DeviceBrowserPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self._form_editor = None
+
+    def createWidget(self, parent):
+        t = DeviceBrowser(parent)
+        return t
+
+    def domXml(self):
+        return DOM_XML
+
+    def group(self):
+        return "BEC Services"
+
+    def icon(self):
+        return QIcon()
+
+    def includeFile(self):
+        return "device_browser"
+
+    def initialize(self, form_editor):
+        self._form_editor = form_editor
+
+    def isContainer(self):
+        return False
+
+    def isInitialized(self):
+        return self._form_editor is not None
+
+    def name(self):
+        return "DeviceBrowser"
+
+    def toolTip(self):
+        return "DeviceBrowser"
+
+    def whatsThis(self):
+        return self.toolTip()

bec_widgets-0.95.0/bec_widgets/widgets/device_browser/device_item/__init__.py

@@ -0,0 +1 @@
+from .device_item import DeviceItem

bec_widgets-0.95.0/bec_widgets/widgets/device_browser/device_item/device_item.py

@@ -0,0 +1,53 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from qtpy.QtCore import QMimeData, Qt
+from qtpy.QtGui import QDrag
+from qtpy.QtWidgets import QHBoxLayout, QLabel, QWidget
+
+if TYPE_CHECKING:
+    from qtpy.QtGui import QMouseEvent
+
+
+class DeviceItem(QWidget):
+    def __init__(self, device: str) -> None:
+        super().__init__()
+        self.device = device
+        layout = QHBoxLayout()
+        layout.setContentsMargins(10, 2, 10, 2)
+        self.label = QLabel(device)
+        layout.addWidget(self.label)
+        self.setLayout(layout)
+
+        self.setStyleSheet(
+            """
+            border: 1px solid #ddd;
+            border-radius: 5px;
+            padding: 10px;
+        """
+        )
+
+    def mousePressEvent(self, event: QMouseEvent) -> None:
+        if event.button() == Qt.LeftButton:
+            drag = QDrag(self)
+            mime_data = QMimeData()
+            mime_data.setText(self.device)
+            drag.setMimeData(mime_data)
+            drag.exec_(Qt.MoveAction)
+
+    def mouseDoubleClickEvent(self, event: QMouseEvent) -> None:
+        print("Double Clicked")
+        # TODO: Implement double click action for opening the device properties dialog
+        return super().mouseDoubleClickEvent(event)
+
+
+if __name__ == "__main__":  # pragma: no cover
+    import sys
+
+    from qtpy.QtWidgets import QApplication
+
+    app = QApplication(sys.argv)
+    widget = DeviceItem("Device")
+    widget.show()
+    sys.exit(app.exec_())

bec_widgets-0.95.0/bec_widgets/widgets/device_browser/register_device_browser.py

@@ -0,0 +1,15 @@
+def main():  # pragma: no cover
+    from qtpy import PYSIDE6
+
+    if not PYSIDE6:
+        print("PYSIDE6 is not available in the environment. Cannot patch designer.")
+        return
+    from PySide6.QtDesigner import QPyDesignerCustomWidgetCollection
+
+    from bec_widgets.widgets.device_browser.device_browser_plugin import DeviceBrowserPlugin
+
+    QPyDesignerCustomWidgetCollection.addCustomWidget(DeviceBrowserPlugin())
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

{bec_widgets-0.94.7 → bec_widgets-0.95.0}/docs/_static/custom.css

@@ -59,29 +59,29 @@
   
   /* Main index page overview cards */
   
-  .sd-card {
+  .index-card .sd-card {
     background: #fff;
     border-radius: 0;
     padding: 30px 10px 20px 10px;
     margin: 10px 0px;
   }
   
-  .sd-card .sd-card-header {
+  .index-card .sd-card-header {
     text-align: center;
   }
   
-  .sd-card .sd-card-header .sd-card-text {
+  .index-card .sd-card-header .sd-card-text {
     margin: 0px;
   }
   
-  .sd-card .sd-card-img-top {
+  .index-card .sd-card-img-top {
     height: 52px;
     width: 52px;
     margin-left: auto;
     margin-right: auto;
   }
   
-  .sd-card .sd-card-header {
+  .index-card .sd-card-header {
     border: none;
     background-color:white;
     color: #150458 !important;
@@ -91,13 +91,13 @@
     border-bottom:  none !important;
   }
   
-  .sd-card .sd-card-footer {
+  .index-card .sd-card-footer {
     border: none;
     background-color:white;
     border-top:  none !important;
   }
   
-  .sd-card .sd-card-footer .sd-card-text{
+  .index-card .sd-card-footer .sd-card-text{
     max-width: 220px;
     margin-left: auto;
     margin-right: auto;
@@ -143,7 +143,7 @@
   
   /* Main index page overview cards */
   
-  html[data-theme=dark] .sd-card {
+  html[data-theme=dark] .index-card .sd-card {
       background-color:var(--pst-color-background);
       border:  none
   }
@@ -152,12 +152,12 @@
       box-shadow: 0 .1rem 0.5rem rgba(250, 250, 250, .2) !important
   }
   
-  html[data-theme=dark] .sd-card .sd-card-header {
+  html[data-theme=dark] .index-card .sd-card-header {
       background-color:var(--pst-color-background);
       color: #150458 !important;
   }
   
-  html[data-theme=dark] .sd-card .sd-card-footer {
+  html[data-theme=dark] .index-card .sd-card-footer {
       background-color:var(--pst-color-background);
   }
   

{bec_widgets-0.94.7 → bec_widgets-0.95.0}/docs/conf.py

@@ -41,6 +41,7 @@ extensions = [
     "sphinx_copybutton",
     "myst_parser",
     "sphinx_design",
+    "sphinx_inline_tabs",
 ]
 
 myst_enable_extensions = [

{bec_widgets-0.94.7 → bec_widgets-0.95.0}/docs/developer/developer.md

@@ -27,6 +27,7 @@ api_reference/api_reference.md
 :link-type: ref
 :img-top: /assets/rocket_launch_48dp.svg
 :text-align: center
+:class-item: index-card
 
 ## Introduction
 
@@ -38,6 +39,7 @@ An introduction into the single-resposibility principle and the modular design o
 :link-type: ref
 :img-top: /assets/apps_48dp.svg
 :text-align: center
+:class-item: index-card
 
 ## Widget Development
 

{bec_widgets-0.94.7 → bec_widgets-0.95.0}/docs/index.md

@@ -14,6 +14,7 @@ A flexible and extensible framework for building graphical user interfaces in Py
 :link-type: ref
 :img-top: /assets/index_getting_started.svg
 :text-align: center
+:class-item: index-card
 
 ## Introduction
 
@@ -25,6 +26,7 @@ General information about BEC Widgets.
 :link-type: ref
 :img-top:  /assets/index_user_guide.svg
 :text-align: center
+:class-item: index-card
 
 ## User guide
 
@@ -36,6 +38,7 @@ Information for users of BEC Widgets.
 :link-type: ref
 :img-top: /assets/index_contribute.svg
 :text-align: center
+:class-item: index-card
 
 ## Developer guide
 
@@ -47,6 +50,7 @@ Information for developers of BEC Widgets.
 :link-type: ref
 :img-top: /assets/index_api.svg
 :text-align: center
+:class-item: index-card
 
 ## API reference
 

{bec_widgets-0.94.7 → bec_widgets-0.95.0}/docs/requirements.txt

@@ -4,6 +4,7 @@ recommonmark
 sphinx-toolbox
 pydata-sphinx-theme
 sphinx-copybutton
+sphinx-inline-tabs
 myst-parser
 sphinx-design
 PySide6

{bec_widgets-0.94.7 → bec_widgets-0.95.0}/docs/user/user.md

@@ -25,6 +25,7 @@ api_reference/api_reference.md
 :link-type: ref
 :img-top: /assets/rocket_launch_48dp.svg
 :text-align: center
+:class-item: index-card
 
 ## Getting Started
 
@@ -36,6 +37,7 @@ Learn how to install BEC Widgets and get started with the framework.
 :link-type: ref
 :img-top: /assets/display_settings_48dp.svg
 :text-align: center
+:class-item: index-card
 
 ## Applications
 
@@ -48,6 +50,7 @@ Learn how to use BEC Widgets Applications, to modify and create new applications
 :link-type: ref
 :img-top: /assets/apps_48dp.svg
 :text-align: center
+:class-item: index-card
 
 ## Widgets
 
@@ -59,6 +62,7 @@ Learn about the building blocks of larger applications: widgets.
 :link-type: ref
 :img-top: /assets/index_api.svg
 :text-align: center
+:class-item: index-card
 
 ## API reference