bec-widgets 1.18.1__tar.gz → 1.19.0__tar.gz

{bec_widgets-1.18.1 → bec_widgets-1.19.0}/CHANGELOG.md

@@ -1,6 +1,24 @@
 # CHANGELOG
 
 
+## v1.19.0 (2025-01-31)
+
+### Bug Fixes
+
+- Enable type checking for BECDispatcher in BECConnector
+  ([`50a572d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/50a572dacd5dfc29a9ecf1b567aac6822b632f60))
+
+### Documentation
+
+- Add docs for LogPanel
+  ([`f219c6f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f219c6fb573cf42964f6a7c6f4a0b0b9946fb98d))
+
+### Features
+
+- **widget**: Add LogPanel widget
+  ([`f048880`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f0488802775401319a54a51d05a0ad534292af09))
+
+
 ## v1.18.1 (2025-01-30)
 
 ### Bug Fixes

{bec_widgets-1.18.1 → bec_widgets-1.19.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bec_widgets
-Version: 1.18.1
+Version: 1.19.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.18.1 → bec_widgets-1.19.0}/bec_widgets/cli/client.py

@@ -31,6 +31,7 @@ class Widgets(str, enum.Enum):
     DeviceComboBox = "DeviceComboBox"
     DeviceLineEdit = "DeviceLineEdit"
     LMFitDialog = "LMFitDialog"
+    LogPanel = "LogPanel"
     Minesweeper = "Minesweeper"
     PositionIndicator = "PositionIndicator"
     PositionerBox = "PositionerBox"
@@ -3183,6 +3184,26 @@ class LMFitDialog(RPCBase):
         """
 
 
+class LogPanel(RPCBase):
+    @rpc_call
+    def set_plain_text(self, text: str) -> None:
+        """
+        Set the plain text of the widget.
+
+        Args:
+            text (str): The text to set.
+        """
+
+    @rpc_call
+    def set_html_text(self, text: str) -> None:
+        """
+        Set the HTML text of the widget.
+
+        Args:
+            text (str): The text to set.
+        """
+
+
 class Minesweeper(RPCBase): ...
 
 

{bec_widgets-1.18.1 → bec_widgets-1.19.0}/bec_widgets/utils/bec_connector.py

@@ -4,7 +4,7 @@ from __future__ import annotations
 import os
 import time
 import uuid
-from typing import Optional
+from typing import TYPE_CHECKING, Optional
 
 from bec_lib.logger import bec_logger
 from bec_lib.utils.import_utils import lazy_import_from
@@ -17,6 +17,9 @@ from bec_widgets.qt_utils.error_popups import ErrorPopupUtility
 from bec_widgets.qt_utils.error_popups import SafeSlot as pyqtSlot
 from bec_widgets.utils.yaml_dialog import load_yaml, load_yaml_gui, save_yaml, save_yaml_gui
 
+if TYPE_CHECKING:
+    from bec_widgets.utils.bec_dispatcher import BECDispatcher
+
 logger = bec_logger.logger
 BECDispatcher = lazy_import_from("bec_widgets.utils.bec_dispatcher", ("BECDispatcher",))
 

{bec_widgets-1.18.1 → bec_widgets-1.19.0}/bec_widgets/widgets/containers/dock/dock_area.py

@@ -30,6 +30,7 @@ from bec_widgets.widgets.plots.waveform.waveform_widget import BECWaveformWidget
 from bec_widgets.widgets.progress.ring_progress_bar.ring_progress_bar import RingProgressBar
 from bec_widgets.widgets.services.bec_queue.bec_queue import BECQueue
 from bec_widgets.widgets.services.bec_status_box.bec_status_box import BECStatusBox
+from bec_widgets.widgets.utility.logpanel.logpanel import LogPanel
 from bec_widgets.widgets.utility.visual.dark_mode_button.dark_mode_button import DarkModeButton
 
 
@@ -139,6 +140,9 @@ class BECDockArea(BECWidget, QWidget):
                             tooltip="Add Circular ProgressBar",
                             filled=True,
                         ),
+                        "log_panel": MaterialIconAction(
+                            icon_name=LogPanel.ICON_NAME, tooltip="Add LogPanel", filled=True
+                        ),
                     },
                 ),
                 "separator_2": SeparatorAction(),
@@ -200,6 +204,9 @@ class BECDockArea(BECWidget, QWidget):
         self.toolbar.widgets["menu_utils"].widgets["progress_bar"].triggered.connect(
             lambda: self.add_dock(widget="RingProgressBar", prefix="progress_bar")
         )
+        self.toolbar.widgets["menu_utils"].widgets["log_panel"].triggered.connect(
+            lambda: self.add_dock(widget="LogPanel", prefix="log_panel")
+        )
 
         # Icons
         self.toolbar.widgets["attach_all"].action.triggered.connect(self.attach_all)

{bec_widgets-1.18.1 → bec_widgets-1.19.0}/bec_widgets/widgets/editors/text_box/text_box.py

@@ -5,9 +5,9 @@ from html.parser import HTMLParser
 
 from bec_lib.logger import bec_logger
 from pydantic import Field
-from qtpy.QtCore import Property, Slot
 from qtpy.QtWidgets import QTextEdit, QVBoxLayout, QWidget
 
+from bec_widgets.qt_utils.error_popups import SafeProperty, SafeSlot
 from bec_widgets.utils.bec_connector import ConnectionConfig
 from bec_widgets.utils.bec_widget import BECWidget
 
@@ -66,7 +66,7 @@ class TextBox(BECWidget, QWidget):
         else:
             self.set_html_text(DEFAULT_TEXT)
 
-    @Slot(str)
+    @SafeSlot(str)
     def set_plain_text(self, text: str) -> None:
         """Set the plain text of the widget.
 
@@ -77,7 +77,7 @@ class TextBox(BECWidget, QWidget):
         self.config.text = text
         self.config.is_html = False
 
-    @Slot(str)
+    @SafeSlot(str)
     def set_html_text(self, text: str) -> None:
         """Set the HTML text of the widget.
 
@@ -88,7 +88,7 @@ class TextBox(BECWidget, QWidget):
         self.config.text = text
         self.config.is_html = True
 
-    @Property(str)
+    @SafeProperty(str)
     def plain_text(self) -> str:
         """Get the text of the widget.
 
@@ -106,7 +106,7 @@ class TextBox(BECWidget, QWidget):
         """
         self.set_plain_text(text)
 
-    @Property(str)
+    @SafeProperty(str)
     def html_text(self) -> str:
         """Get the HTML text of the widget.
 

bec_widgets-1.19.0/bec_widgets/widgets/utility/logpanel/__init__.py

@@ -0,0 +1,3 @@
+from bec_widgets.widgets.utility.logpanel.logpanel import LogPanel
+
+__ALL__ = ["LogPanel"]

bec_widgets-1.19.0/bec_widgets/widgets/utility/logpanel/_util.py

@@ -0,0 +1,58 @@
+""" Utilities for filtering and formatting in the LogPanel"""
+
+from __future__ import annotations
+
+import re
+from collections import deque
+from typing import Callable, Iterator
+
+from bec_lib.logger import LogLevel
+from bec_lib.messages import LogMessage
+from qtpy.QtCore import QDateTime
+
+LinesHtmlFormatter = Callable[[deque[LogMessage]], Iterator[str]]
+LineFormatter = Callable[[LogMessage], str]
+LineFilter = Callable[[LogMessage], bool] | None
+
+ANSI_ESCAPE_REGEX = re.compile(r"\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])")
+
+
+def replace_escapes(s: str):
+    s = ANSI_ESCAPE_REGEX.sub("", s)
+    return s.replace(" ", "&nbsp;").replace("\n", "<br />").replace("\t", "    ")
+
+
+def level_filter(msg: LogMessage, thresh: int):
+    return LogLevel[msg.content["log_type"].upper()].value >= thresh
+
+
+def noop_format(line: LogMessage):
+    _textline = line.log_msg if isinstance(line.log_msg, str) else line.log_msg["text"]
+    return replace_escapes(_textline.strip()) + "<br />"
+
+
+def simple_color_format(line: LogMessage, colors: dict[LogLevel, str]):
+    color = colors.get(LogLevel[line.content["log_type"].upper()]) or colors[LogLevel.INFO]
+    return f'<font color="{color}">{noop_format(line)}</font>'
+
+
+def create_formatter(line_format: LineFormatter, line_filter: LineFilter) -> LinesHtmlFormatter:
+    def _formatter(data: deque[LogMessage]):
+        if line_filter is not None:
+            return (line_format(line) for line in data if line_filter(line))
+        else:
+            return (line_format(line) for line in data)
+
+    return _formatter
+
+
+def log_txt(line):
+    return line.log_msg if isinstance(line.log_msg, str) else line.log_msg["text"]
+
+
+def log_time(line):
+    return QDateTime.fromMSecsSinceEpoch(int(line.log_msg["record"]["time"]["timestamp"] * 1000))
+
+
+def log_svc(line):
+    return line.log_msg["service_name"]

bec_widgets-1.19.0/bec_widgets/widgets/utility/logpanel/log_panel.pyproject

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

bec_widgets-1.19.0/bec_widgets/widgets/utility/logpanel/log_panel_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.utility.logpanel.logpanel import LogPanel
+
+DOM_XML = """
+<ui language='c++'>
+    <widget class='LogPanel' name='log_panel'>
+    </widget>
+</ui>
+"""
+
+
+class LogPanelPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self._form_editor = None
+
+    def createWidget(self, parent):
+        t = LogPanel(parent)
+        return t
+
+    def domXml(self):
+        return DOM_XML
+
+    def group(self):
+        return "BEC Utils"
+
+    def icon(self):
+        return designer_material_icon(LogPanel.ICON_NAME)
+
+    def includeFile(self):
+        return "log_panel"
+
+    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 "LogPanel"
+
+    def toolTip(self):
+        return "Displays a log panel"
+
+    def whatsThis(self):
+        return self.toolTip()