bec-widgets 2.2.0__py3-none-any.whl → 2.4.3__py3-none-any.whl

bec_widgets/widgets/editors/web_console/web_console.py

@@ -0,0 +1,230 @@
+from __future__ import annotations
+
+import secrets
+import subprocess
+import time
+
+from bec_lib.logger import bec_logger
+from louie.saferef import safe_ref
+from qtpy.QtCore import QUrl, qInstallMessageHandler
+from qtpy.QtWebEngineWidgets import QWebEnginePage, QWebEngineView
+from qtpy.QtWidgets import QApplication, QVBoxLayout, QWidget
+
+from bec_widgets.utils.bec_widget import BECWidget
+
+logger = bec_logger.logger
+
+
+class WebConsoleRegistry:
+    """
+    A registry for the WebConsole class to manage its instances.
+    """
+
+    def __init__(self):
+        """
+        Initialize the registry.
+        """
+        self._instances = {}
+        self._server_process = None
+        self._server_port = None
+        self._token = secrets.token_hex(16)
+
+    def register(self, instance: WebConsole):
+        """
+        Register an instance of WebConsole.
+        """
+        self._instances[instance.gui_id] = safe_ref(instance)
+        self.cleanup()
+
+        if self._server_process is None:
+            # Start the ttyd server if not already running
+            self.start_ttyd()
+
+    def start_ttyd(self, use_zsh: bool | None = None):
+        """
+        Start the ttyd server
+        ttyd -q -W -t 'theme={"background": "black"}' zsh
+
+        Args:
+            use_zsh (bool): Whether to use zsh or bash. If None, it will try to detect if zsh is available.
+        """
+
+        # First, check if ttyd is installed
+        try:
+            subprocess.run(["ttyd", "--version"], check=True, stdout=subprocess.PIPE)
+        except FileNotFoundError:
+            # pylint: disable=raise-missing-from
+            raise RuntimeError("ttyd is not installed. Please install it first.")
+
+        if use_zsh is None:
+            # Check if we can use zsh
+            try:
+                subprocess.run(["zsh", "--version"], check=True, stdout=subprocess.PIPE)
+                use_zsh = True
+            except FileNotFoundError:
+                use_zsh = False
+
+        command = [
+            "ttyd",
+            "-p",
+            "0",
+            "-W",
+            "-t",
+            'theme={"background": "black"}',
+            "-c",
+            f"user:{self._token}",
+        ]
+        if use_zsh:
+            command.append("zsh")
+        else:
+            command.append("bash")
+
+        # Start the ttyd server
+        self._server_process = subprocess.Popen(
+            command, stdout=subprocess.PIPE, stderr=subprocess.PIPE
+        )
+
+        self._wait_for_server_port()
+
+        self._server_process.stdout.close()
+        self._server_process.stderr.close()
+
+    def _wait_for_server_port(self, timeout: float = 10):
+        """
+        Wait for the ttyd server to start and get the port number.
+
+        Args:
+            timeout (float): The timeout in seconds to wait for the server to start.
+        """
+        start_time = time.time()
+        while True:
+            output = self._server_process.stderr.readline()
+            if output == b"" and self._server_process.poll() is not None:
+                break
+            if not output:
+                continue
+
+            output = output.decode("utf-8").strip()
+            if "Listening on" in output:
+                # Extract the port number from the output
+                self._server_port = int(output.split(":")[-1])
+                logger.info(f"ttyd server started on port {self._server_port}")
+                break
+            if time.time() - start_time > timeout:
+                raise TimeoutError(
+                    "Timeout waiting for ttyd server to start. Please check if ttyd is installed and available in your PATH."
+                )
+
+    def cleanup(self):
+        """
+        Clean up the registry by removing any instances that are no longer valid.
+        """
+        for gui_id, weak_ref in list(self._instances.items()):
+            if weak_ref() is None:
+                del self._instances[gui_id]
+
+        if not self._instances and self._server_process:
+            # If no instances are left, terminate the server process
+            self._server_process.terminate()
+            self._server_process = None
+            self._server_port = None
+            logger.info("ttyd server terminated")
+
+    def unregister(self, instance: WebConsole):
+        """
+        Unregister an instance of WebConsole.
+
+        Args:
+            instance (WebConsole): The instance to unregister.
+        """
+        if instance.gui_id in self._instances:
+            del self._instances[instance.gui_id]
+
+        self.cleanup()
+
+
+_web_console_registry = WebConsoleRegistry()
+
+
+def suppress_qt_messages(type_, context, msg):
+    if context.category in ["js", "default"]:
+        return
+    print(msg)
+
+
+qInstallMessageHandler(suppress_qt_messages)
+
+
+class BECWebEnginePage(QWebEnginePage):
+    def javaScriptConsoleMessage(self, level, message, lineNumber, sourceID):
+        logger.info(f"[JS Console] {level.name} at line {lineNumber} in {sourceID}: {message}")
+
+
+class WebConsole(BECWidget, QWidget):
+    """
+    A simple widget to display a website
+    """
+
+    PLUGIN = True
+    ICON_NAME = "terminal"
+
+    def __init__(self, parent=None, config=None, client=None, gui_id=None, **kwargs):
+        super().__init__(parent=parent, client=client, gui_id=gui_id, config=config, **kwargs)
+        _web_console_registry.register(self)
+        self._token = _web_console_registry._token
+        layout = QVBoxLayout()
+        layout.setContentsMargins(0, 0, 0, 0)
+        self.browser = QWebEngineView(self)
+        self.page = BECWebEnginePage(self)
+        self.page.authenticationRequired.connect(self._authenticate)
+        self.browser.setPage(self.page)
+        layout.addWidget(self.browser)
+        self.setLayout(layout)
+        self.page.setUrl(QUrl(f"http://localhost:{_web_console_registry._server_port}"))
+
+    def write(self, data: str, send_return: bool = True):
+        """
+        Send data to the web page
+        """
+        self.page.runJavaScript(f"window.term.paste('{data}');")
+        if send_return:
+            self.send_return()
+
+    def _authenticate(self, _, auth):
+        """
+        Authenticate the request with the provided username and password.
+        """
+        auth.setUser("user")
+        auth.setPassword(self._token)
+
+    def send_return(self):
+        """
+        Send return to the web page
+        """
+        self.page.runJavaScript(
+            "document.querySelector('textarea.xterm-helper-textarea').dispatchEvent(new KeyboardEvent('keypress', {charCode: 13}))"
+        )
+
+    def send_ctrl_c(self):
+        """
+        Send Ctrl+C to the web page
+        """
+        self.page.runJavaScript(
+            "document.querySelector('textarea.xterm-helper-textarea').dispatchEvent(new KeyboardEvent('keypress', {charCode: 3}))"
+        )
+
+    def cleanup(self):
+        """
+        Clean up the registry by removing any instances that are no longer valid.
+        """
+        _web_console_registry.unregister(self)
+        super().cleanup()
+
+
+if __name__ == "__main__":  # pragma: no cover
+    import sys
+
+    app = QApplication(sys.argv)
+    widget = WebConsole()
+    widget.show()
+    sys.exit(app.exec_())

bec_widgets/widgets/editors/web_console/web_console.pyproject

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

bec_widgets/widgets/editors/web_console/web_console_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 bec_widgets.utils.bec_designer import designer_material_icon
+from bec_widgets.widgets.editors.web_console.web_console import WebConsole
+
+DOM_XML = """
+<ui language='c++'>
+    <widget class='WebConsole' name='web_console'>
+    </widget>
+</ui>
+"""
+
+
+class WebConsolePlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self._form_editor = None
+
+    def createWidget(self, parent):
+        t = WebConsole(parent)
+        return t
+
+    def domXml(self):
+        return DOM_XML
+
+    def group(self):
+        return "BEC Console"
+
+    def icon(self):
+        return designer_material_icon(WebConsole.ICON_NAME)
+
+    def includeFile(self):
+        return "web_console"
+
+    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 "WebConsole"
+
+    def toolTip(self):
+        return ""
+
+    def whatsThis(self):
+        return self.toolTip()

bec_widgets/widgets/plots/waveform/settings/curve_settings/curve_tree.py

@@ -31,6 +31,9 @@ from bec_widgets.widgets.control.device_input.device_line_edit.device_line_edit
 )
 from bec_widgets.widgets.dap.dap_combo_box.dap_combo_box import DapComboBox
 from bec_widgets.widgets.plots.waveform.curve import CurveConfig, DeviceSignal
+from bec_widgets.widgets.utility.visual.color_button_native.color_button_native import (
+    ColorButtonNative,
+)
 from bec_widgets.widgets.utility.visual.colormap_widget.colormap_widget import BECColorMapWidget
 
 if TYPE_CHECKING:  # pragma: no cover
@@ -40,49 +43,6 @@ if TYPE_CHECKING:  # pragma: no cover
 logger = bec_logger.logger
 
 
-class ColorButton(QPushButton):
-    """A QPushButton subclass that displays a color.
-
-    The background is set to the given color and the button text is the hex code.
-    The text color is chosen automatically (black if the background is light, white if dark)
-    to guarantee good readability.
-    """
-
-    def __init__(self, color="#000000", parent=None):
-        """Initialize the color button.
-
-        Args:
-            color (str): The initial color in hex format (e.g., '#000000').
-            parent: Optional QWidget parent.
-        """
-        super().__init__(parent)
-        self.set_color(color)
-
-    def set_color(self, color):
-        """Set the button's color and update its appearance.
-
-        Args:
-            color (str or QColor): The new color to assign.
-        """
-        if isinstance(color, QColor):
-            self._color = color.name()
-        else:
-            self._color = color
-        self._update_appearance()
-
-    def color(self):
-        """Return the current color in hex."""
-        return self._color
-
-    def _update_appearance(self):
-        """Update the button style based on the background color's brightness."""
-        c = QColor(self._color)
-        brightness = c.lightnessF()
-        text_color = "#000000" if brightness > 0.5 else "#FFFFFF"
-        self.setStyleSheet(f"background-color: {self._color}; color: {text_color};")
-        self.setText(self._color)
-
-
 class CurveRow(QTreeWidgetItem):
     DELETE_BUTTON_COLOR = "#CC181E"
     """A unified row that can represent either a device or a DAP curve.
@@ -193,7 +153,7 @@ class CurveRow(QTreeWidgetItem):
     def _init_style_controls(self):
         """Create columns 3..6: color button, style combo, width spin, symbol spin."""
         # Color in col 3
-        self.color_button = ColorButton(self.config.color)
+        self.color_button = ColorButtonNative(color=self.config.color)
         self.color_button.clicked.connect(lambda: self._select_color(self.color_button))
         self.tree.setItemWidget(self, 3, self.color_button)
 
@@ -284,6 +244,11 @@ class CurveRow(QTreeWidgetItem):
             self.dap_combo.deleteLater()
             self.dap_combo = None
 
+        if getattr(self, "color_button", None) is not None:
+            self.color_button.close()
+            self.color_button.deleteLater()
+            self.color_button = None
+
         # Remove the item from the tree widget
         index = self.tree.indexOfTopLevelItem(self)
         if index != -1:
@@ -337,8 +302,8 @@ class CurveRow(QTreeWidgetItem):
             self.config.label = f"{parent_conf.label}-{new_dap}"
 
         # Common style fields
-        self.config.color = self.color_button.color()
-        self.config.symbol_color = self.color_button.color()
+        self.config.color = self.color_button.color
+        self.config.symbol_color = self.color_button.color
         self.config.pen_style = self.style_combo.currentText()
         self.config.pen_width = self.width_spin.value()
         self.config.symbol_size = self.symbol_spin.value()

bec_widgets/widgets/utility/visual/color_button_native/color_button_native.py

@@ -0,0 +1,58 @@
+from qtpy.QtGui import QColor
+from qtpy.QtWidgets import QPushButton
+
+from bec_widgets import BECWidget, SafeProperty, SafeSlot
+
+
+class ColorButtonNative(BECWidget, QPushButton):
+    """A QPushButton subclass that displays a color.
+
+    The background is set to the given color and the button text is the hex code.
+    The text color is chosen automatically (black if the background is light, white if dark)
+    to guarantee good readability.
+    """
+
+    RPC = False
+    PLUGIN = True
+    ICON_NAME = "colors"
+
+    def __init__(self, parent=None, color="#000000", **kwargs):
+        """Initialize the color button.
+
+        Args:
+            parent: Optional QWidget parent.
+            color (str): The initial color in hex format (e.g., '#000000').
+        """
+        super().__init__(parent=parent, **kwargs)
+        self.set_color(color)
+
+    @SafeSlot()
+    def set_color(self, color):
+        """Set the button's color and update its appearance.
+
+        Args:
+            color (str or QColor): The new color to assign.
+        """
+        if isinstance(color, QColor):
+            self._color = color.name()
+        else:
+            self._color = color
+        self._update_appearance()
+
+    @SafeProperty("QColor")
+    def color(self):
+        """Return the current color in hex."""
+        return self._color
+
+    @color.setter
+    def color(self, value):
+        """Set the button's color and update its appearance."""
+        self.set_color(value)
+
+    def _update_appearance(self):
+        """Update the button style based on the background color's brightness."""
+        c = QColor(self._color)
+        brightness = c.lightnessF()
+        text_color = "#000000" if brightness > 0.5 else "#FFFFFF"
+        self.setStyleSheet(f"background-color: {self._color}; color: {text_color};")
+        self.setText(self._color)

bec_widgets/widgets/utility/visual/color_button_native/color_button_native.pyproject

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

bec_widgets/widgets/utility/visual/color_button_native/color_button_native_plugin.py

@@ -0,0 +1,56 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+
+from qtpy.QtDesigner import QDesignerCustomWidgetInterface
+
+from bec_widgets.utils.bec_designer import designer_material_icon
+from bec_widgets.widgets.utility.visual.color_button_native.color_button_native import (
+    ColorButtonNative,
+)
+
+DOM_XML = """
+<ui language='c++'>
+    <widget class='ColorButtonNative' name='color_button_native'>
+    </widget>
+</ui>
+"""
+
+
+class ColorButtonNativePlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self._form_editor = None
+
+    def createWidget(self, parent):
+        t = ColorButtonNative(parent)
+        return t
+
+    def domXml(self):
+        return DOM_XML
+
+    def group(self):
+        return "BEC Buttons"
+
+    def icon(self):
+        return designer_material_icon(ColorButtonNative.ICON_NAME)
+
+    def includeFile(self):
+        return "color_button_native"
+
+    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 "ColorButtonNative"
+
+    def toolTip(self):
+        return "A QPushButton subclass that displays a color."
+
+    def whatsThis(self):
+        return self.toolTip()

bec_widgets/widgets/utility/visual/color_button_native/register_color_button_native.py

@@ -0,0 +1,17 @@
+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.utility.visual.color_button_native.color_button_native_plugin import (
+        ColorButtonNativePlugin,
+    )
+
+    QPyDesignerCustomWidgetCollection.addCustomWidget(ColorButtonNativePlugin())
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

{bec_widgets-2.2.0.dist-info → bec_widgets-2.4.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bec_widgets
-Version: 2.2.0
+Version: 2.4.3
 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
@@ -25,6 +25,7 @@ Requires-Dist: coverage~=7.0; extra == 'dev'
 Requires-Dist: fakeredis>=2.23.2,~=2.23; extra == 'dev'
 Requires-Dist: isort>=5.13.2,~=5.13; extra == 'dev'
 Requires-Dist: pytest-bec-e2e<=4.0,>=2.21.4; extra == 'dev'
+Requires-Dist: pytest-cov~=6.1.1; extra == 'dev'
 Requires-Dist: pytest-qt~=4.4; extra == 'dev'
 Requires-Dist: pytest-random-order~=1.1; extra == 'dev'
 Requires-Dist: pytest-timeout~=2.2; extra == 'dev'