bec-widgets 0.66.1__py3-none-any.whl → 0.68.0__py3-none-any.whl

CHANGELOG.md

@@ -1,5 +1,47 @@
 # CHANGELOG
 
+## v0.68.0 (2024-06-21)
+
+### Feature
+
+* feat: properly handle SIGINT (ctrl-c) in BEC GUI server -> calls qapplication.quit() ([`3644f34`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3644f344da2df674bc0d5740c376a86b9d0dfe95))
+
+* feat: bec-gui-server: redirect stdout and stderr (if any) as proper debug and error log entries ([`d1266a1`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/d1266a1ce148ff89557a039e3a182a87a3948f49))
+
+* feat: add logger for BEC GUI server ([`630616e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/630616ec729f60aa0b4d17a9e0379f9c6198eb96))
+
+### Fix
+
+* fix: ignore GUI server output (any output will go to log file)
+
+If a logger is given to log `_start_log_process`, the server stdout and
+stderr streams will be redirected as log entries with levels DEBUG or ERROR
+in their parent process ([`ce37416`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ce374163cab87a92847409051739777bc505a77b))
+
+* fix: do not create 'BECClient' logger when instantiating BECDispatcher ([`f7d0b07`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f7d0b0768ace42a33e2556bb33611d4f02e5a6d9))
+
+## v0.67.0 (2024-06-21)
+
+### Documentation
+
+* docs: add widget to documentation ([`6fa1c06`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6fa1c06053131dabd084bb3cf13c853b5d3ce833))
+
+### Feature
+
+* feat: introduce BECStatusBox Widget ([`443b6c1`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/443b6c1d7b02c772fda02e2d1eefd5bd40249e0c))
+
+### Refactor
+
+* refactor: Change inheritance to QTreeWidget from QWidget ([`d2f2b20`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/d2f2b206bb0eab60b8a9b0d0ac60a6b7887fa6fb))
+
+### Test
+
+* test: add test suite for bec_status_box and status_item ([`5d4ca81`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5d4ca816cdedec4c88aba9eb326f85392504ea1c))
+
+### Unknown
+
+* Update file requirements.txt ([`505a5ec`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/505a5ec8334ff4422913b3a7b79d39bcb42ad535))
+
 ## v0.66.1 (2024-06-20)
 
 ### Fix
@@ -133,46 +175,6 @@ This reverts commit abc6caa2d0b6141dfbe1f3d025f78ae14deddcb3 ([`fe04dd8`](https:
 
 ## v0.62.0 (2024-06-12)
 
-### Feature
-
-* feat: implement non-polling, interruptible waiting of gui instruction response with timeout ([`abc6caa`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/abc6caa2d0b6141dfbe1f3d025f78ae14deddcb3))
-
 ### Unknown
 
 * doc: add documentation about creating custom GUI applications embedding BEC Widgets ([`17a0068`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/17a00687579f5efab1990cd83862ec0e78198633))
-
-## v0.61.0 (2024-06-12)
-
-### Feature
-
-* feat(widgets/stop_button): General stop button added ([`61ba08d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/61ba08d0b8df9f48f5c54c7c2b4e6d395206e7e6))
-
-### Refactor
-
-* refactor: improve labe of auto_update script ([`40b5688`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/40b568815893cd41af3531bb2e647ca1e2e315f4))
-
-## v0.60.0 (2024-06-08)
-
-### Ci
-
-* ci: added git fetch for target branch ([`fc4f4f8`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/fc4f4f81ad1be99cf5112f2188a46c5bed2679ee))
-
-* ci: fixed pylint-check ([`6b1d582`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6b1d5827d6599f06a3acd316060a8d25f0686d54))
-
-### Feature
-
-* feat: added isort to bw-generate-cli ([`f0391f5`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f0391f59c9eb0a51b693fccfe2e399e869d35dda))
-
-### Fix
-
-* fix: removed BECConnector from rpc client interface ([`6428e38`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6428e38ab94c15a2c904e75cc6404bb6d0394e04))
-
-### Refactor
-
-* refactor: minor cleanup ([`3adf6cf`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3adf6cfd586355c8b8ce7fdc9722f868e22287c5))
-
-* refactor: disabled pylint for auto-gen client ([`b15816c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b15816ca9fd3e4ae87cca5fcfe029b4dfca570ca))
-
-### Test
-
-* test: added missing pylint statement to header ([`f662985`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f6629852ebc2b4ee239fa560cc310a5ae2627cf7))

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.66.1
+Version: 0.68.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/cli/client.py

@@ -13,6 +13,7 @@ class Widgets(str, enum.Enum):
     Enum for the available widgets.
     """
 
+    BECStatusBox = "BECStatusBox"
     BECDock = "BECDock"
     BECDockArea = "BECDockArea"
     BECFigure = "BECFigure"
@@ -1388,6 +1389,24 @@ class BECPlotBase(RPCBase):
         """
 
 
+class BECStatusBox(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 BECWaveform(RPCBase):
     @property
     @rpc_call
@@ -1649,6 +1668,60 @@ class BECWaveform(RPCBase):
         """
 
 
+class DeviceComboBox(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 DeviceInputBase(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 DeviceLineEdit(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 Ring(RPCBase):
     @rpc_call
     def get_all_rpc(self) -> "dict":
@@ -1950,7 +2023,7 @@ class TextBox(RPCBase):
     @rpc_call
     def set_color(self, background_color: str, font_color: str) -> None:
         """
-        Set the background color of the Widget.
+        Set the background color of the widget.
 
         Args:
             background_color (str): The color to set the background in HEX.
@@ -1960,13 +2033,19 @@ class TextBox(RPCBase):
     @rpc_call
     def set_text(self, text: str) -> None:
         """
-        Set the text of the Widget
+        Set the text of the widget.
+
+        Args:
+            text (str): The text to set.
         """
 
     @rpc_call
     def set_font_size(self, size: int) -> None:
         """
-        Set the font size of the text in the Widget.
+        Set the font size of the text in the widget.
+
+        Args:
+            size (int): The font size to set.
         """
 
 

bec_widgets/cli/client_utils.py

@@ -13,6 +13,7 @@ from functools import wraps
 from typing import TYPE_CHECKING
 
 from bec_lib.endpoints import MessageEndpoints
+from bec_lib.logger import bec_logger
 from bec_lib.utils.import_utils import isinstance_based_on_class_name, lazy_import, lazy_import_from
 from qtpy.QtCore import QEventLoop, QSocketNotifier, QTimer
 
@@ -31,6 +32,8 @@ messages = lazy_import("bec_lib.messages")
 MessageObject = lazy_import_from("bec_lib.connector", ("MessageObject",))
 BECDispatcher = lazy_import_from("bec_widgets.utils.bec_dispatcher", ("BECDispatcher",))
 
+logger = bec_logger.logger
+
 
 def rpc_call(func):
     """
@@ -63,45 +66,64 @@ def rpc_call(func):
     return wrapper
 
 
-def _get_output(process) -> None:
+def _get_output(process, logger) -> None:
+    log_func = {process.stdout: logger.debug, process.stderr: logger.error}
+    stream_buffer = {process.stdout: [], process.stderr: []}
     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)
+            for stream in (process.stdout, process.stderr):
+                buf = stream_buffer[stream]
+                if stream in readylist:
+                    buf.append(stream.read(4096))
+                output, _, remaining = "".join(buf).rpartition("\n")
                 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)
+                    log_func[stream](output)
+                    buf.clear()
+                    buf.append(remaining)
     except Exception as e:
         print(f"Error reading process output: {str(e)}")
 
 
-def _start_plot_process(gui_id, gui_class, config) -> None:
+def _start_plot_process(gui_id, gui_class, config, logger=None) -> None:
     """
     Start the plot in a new process.
+
+    Logger must be a logger object with "debug" and "error" functions,
+    or it can be left to "None" as default. None means output from the
+    process will not be captured.
     """
     # pylint: disable=subprocess-run-check
-    command = [
-        "bec-gui-server",
-        "--id",
-        gui_id,
-        "--config",
-        config,
-        "--gui_class",
-        gui_class.__name__,
-    ]
+    command = ["bec-gui-server", "--id", gui_id, "--gui_class", gui_class.__name__]
+    if config:
+        command.extend(["--config", config])
+
     env_dict = os.environ.copy()
     env_dict["PYTHONUNBUFFERED"] = "1"
+    if logger is None:
+        stdout_redirect = subprocess.DEVNULL
+        stderr_redirect = subprocess.DEVNULL
+    else:
+        stdout_redirect = subprocess.PIPE
+        stderr_redirect = subprocess.PIPE
+
     process = subprocess.Popen(
-        command, text=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=env_dict
+        command,
+        text=True,
+        start_new_session=True,
+        stdout=stdout_redirect,
+        stderr=stderr_redirect,
+        env=env_dict,
     )
-    process_output_processing_thread = threading.Thread(target=_get_output, args=(process,))
-    process_output_processing_thread.start()
+    if logger is None:
+        process_output_processing_thread = None
+    else:
+        process_output_processing_thread = threading.Thread(
+            target=_get_output, args=(process, logger)
+        )
+        process_output_processing_thread.start()
     return process, process_output_processing_thread
 
 
@@ -113,7 +135,6 @@ class BECGuiClientMixin:
         self.auto_updates = self._get_update_script()
         self._target_endpoint = MessageEndpoints.scan_status()
         self._selected_device = None
-        self.stderr_output = []
 
     def _get_update_script(self) -> AutoUpdates | None:
         eps = imd.entry_points(group="bec.widgets.auto_updates")
@@ -165,7 +186,7 @@ class BECGuiClientMixin:
         if self._process is None or self._process.poll() is not None:
             self._start_update_script()
             self._process, self._process_output_processing_thread = _start_plot_process(
-                self._gui_id, self.__class__, self._client._service_config.redis
+                self._gui_id, self.__class__, self._client._service_config.config_path
             )
         while not self.gui_is_alive():
             print("Waiting for GUI to start...")
@@ -185,19 +206,10 @@ class BECGuiClientMixin:
         self._client.shutdown()
         if self._process:
             self._process.terminate()
-            self._process_output_processing_thread.join()
+            if self._process_output_processing_thread:
+                self._process_output_processing_thread.join()
             self._process = None
 
-    def print_log(self) -> None:
-        """
-        Print the log of the plot process.
-        """
-        if self._process is None:
-            return
-        print("".join(self.stderr_output))
-        # Flush list
-        self.stderr_output.clear()
-
 
 class RPCResponseTimeoutError(Exception):
     """Exception raised when an RPC response is not received within the expected time."""

bec_widgets/cli/server.py

@@ -1,17 +1,24 @@
 import inspect
+import signal
+import sys
+from contextlib import redirect_stderr, redirect_stdout
 from typing import Union
 
 from bec_lib.endpoints import MessageEndpoints
+from bec_lib.logger import bec_logger
+from bec_lib.service_config import ServiceConfig
 from bec_lib.utils.import_utils import lazy_import
 from qtpy.QtCore import QTimer
 
 from bec_widgets.cli.rpc_register import RPCRegister
 from bec_widgets.utils import BECDispatcher
 from bec_widgets.utils.bec_connector import BECConnector
+from bec_widgets.utils.bec_dispatcher import QtRedisConnector
 from bec_widgets.widgets.dock.dock_area import BECDockArea
 from bec_widgets.widgets.figure import BECFigure
 
 messages = lazy_import("bec_lib.messages")
+logger = bec_logger.logger
 
 
 class BECWidgetsCLIServer:
@@ -114,6 +121,23 @@ class BECWidgetsCLIServer:
         self.client.shutdown()
 
 
+class SimpleFileLikeFromLogOutputFunc:
+    def __init__(self, log_func):
+        self._log_func = log_func
+
+    def write(self, buffer):
+        for line in buffer.rstrip().splitlines():
+            line = line.rstrip()
+            if line:
+                self._log_func(line)
+
+    def flush(self):
+        return
+
+    def close(self):
+        return
+
+
 def main():
     import argparse
     import os
@@ -125,16 +149,6 @@ def main():
 
     import bec_widgets
 
-    app = QApplication(sys.argv)
-    app.setApplicationName("BEC Figure")
-    module_path = os.path.dirname(bec_widgets.__file__)
-    icon = QIcon()
-    icon.addFile(os.path.join(module_path, "assets", "bec_widgets_icon.png"), size=QSize(48, 48))
-    app.setWindowIcon(icon)
-
-    win = QMainWindow()
-    win.setWindowTitle("BEC Widgets")
-
     parser = argparse.ArgumentParser(description="BEC Widgets CLI Server")
     parser.add_argument("--id", type=str, help="The id of the server")
     parser.add_argument(
@@ -142,7 +156,7 @@ def main():
         type=str,
         help="Name of the gui class to be rendered. Possible values: \n- BECFigure\n- BECDockArea",
     )
-    parser.add_argument("--config", type=str, help="Config to connect to redis.")
+    parser.add_argument("--config", type=str, help="Config file")
 
     args = parser.parse_args()
 
@@ -157,15 +171,44 @@ def main():
         )
         gui_class = BECFigure
 
-    server = BECWidgetsCLIServer(gui_id=args.id, config=args.config, gui_class=gui_class)
+    with redirect_stdout(SimpleFileLikeFromLogOutputFunc(logger.debug)):
+        with redirect_stderr(SimpleFileLikeFromLogOutputFunc(logger.error)):
+            app = QApplication(sys.argv)
+            app.setApplicationName("BEC Figure")
+            module_path = os.path.dirname(bec_widgets.__file__)
+            icon = QIcon()
+            icon.addFile(
+                os.path.join(module_path, "assets", "bec_widgets_icon.png"), size=QSize(48, 48)
+            )
+            app.setWindowIcon(icon)
+
+            win = QMainWindow()
+            win.setWindowTitle("BEC Widgets")
+
+            service_config = ServiceConfig(args.config)
+            bec_logger.configure(
+                service_config.redis,
+                QtRedisConnector,
+                service_name="BECWidgetsCLIServer",
+                service_config=service_config.service_config,
+            )
+            server = BECWidgetsCLIServer(gui_id=args.id, config=service_config, gui_class=gui_class)
+
+            gui = server.gui
+            win.setCentralWidget(gui)
+            win.resize(800, 600)
+            win.show()
+
+            app.aboutToQuit.connect(server.shutdown)
+
+            def sigint_handler(*args):
+                # display message, for people to let it terminate gracefully
+                print("Caught SIGINT, exiting")
+                app.quit()
 
-    gui = server.gui
-    win.setCentralWidget(gui)
-    win.resize(800, 600)
-    win.show()
+            signal.signal(signal.SIGINT, sigint_handler)
 
-    app.aboutToQuit.connect(server.shutdown)
-    sys.exit(app.exec())
+            sys.exit(app.exec())
 
 
 if __name__ == "__main__":  # pragma: no cover

bec_widgets/utils/bec_dispatcher.py

@@ -66,6 +66,11 @@ class QtRedisConnector(RedisConnector):
             cb(msg.content, msg.metadata)
 
 
+class BECClientWithoutLoggerInit(BECClient):
+    def _initialize_logger(self):
+        return
+
+
 class BECDispatcher:
     """Utility class to keep track of slots connected to a particular redis connector"""
 
@@ -79,7 +84,7 @@ class BECDispatcher:
             cls._initialized = False
         return cls._instance
 
-    def __init__(self, client=None, config: str = None):
+    def __init__(self, client=None, config: str | ServiceConfig = None):
         if self._initialized:
             return
 
@@ -91,13 +96,16 @@ class BECDispatcher:
 
         if self.client is None:
             if config is not None:
-                host, port = config.split(":")
-                redis_config = {"host": host, "port": port}
-                self.client = BECClient(
-                    config=ServiceConfig(redis=redis_config), connector_cls=QtRedisConnector
+                if not isinstance(config, ServiceConfig):
+                    # config is supposed to be a path
+                    config = ServiceConfig(config)
+                self.client = BECClientWithoutLoggerInit(
+                    config=config, connector_cls=QtRedisConnector
                 )  # , forced=True)
             else:
-                self.client = BECClient(connector_cls=QtRedisConnector)  # , forced=True)
+                self.client = BECClientWithoutLoggerInit(
+                    connector_cls=QtRedisConnector
+                )  # , forced=True)
         else:
             if self.client.started:
                 # have to reinitialize client to use proper connector