bec-widgets 0.64.0__tar.gz → 0.64.2__tar.gz

{bec_widgets-0.64.0 → bec_widgets-0.64.2}/CHANGELOG.md

@@ -1,5 +1,25 @@
 # CHANGELOG
 
+## v0.64.2 (2024-06-19)
+
+### Fix
+
+* fix(client_utils): added close rpc command to shutdown of gui from bec_ipython_client ([`e5a7d47`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e5a7d47b21cbf066f740f1d11d7c9ea7c70f3080))
+
+## v0.64.1 (2024-06-19)
+
+### Fix
+
+* fix(widgets): removed widget module import of sub widgets ([`216511b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/216511b951ff0e15b6d7c70133095f3ac45c23f4))
+
+### Refactor
+
+* refactor(utils): moved get_rpc_widgets to plugin_utils ([`6dabbf8`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6dabbf874fbbdde89c34a7885bf95aa9c895a28b))
+
+### Test
+
+* test: moved rpc_classes test ([`b3575eb`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b3575eb06852b456cde915dfda281a3e778e3aeb))
+
 ## v0.64.0 (2024-06-19)
 
 ### Ci
@@ -141,28 +161,8 @@ This reverts commit abc6caa2d0b6141dfbe1f3d025f78ae14deddcb3 ([`fe04dd8`](https:
 
 ## v0.59.0 (2024-06-07)
 
-### Build
-
-* build: added webengine dependency ([`d56c549`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/d56c5493cd28f379d04a79d90b01c73b0760da1b))
-
 ### Ci
 
 * ci: merged additional tests to parallel matrix job ([`178fe4d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/178fe4d2da3a959f7cd90e7ea0f47314dc1ef4ed))
 
 * ci: added webengine dependencies ([`2d79ef8`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2d79ef8fe5e52c61f4a78782770377cd6b41958b))
-
-### Documentation
-
-* docs: added website docs ([`cf6e5a4`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/cf6e5a40fc8320e9898a446a5bf14b77e94ef013))
-
-### Feature
-
-* feat(widget): added simple website widget with rpc ([`64abd67`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/64abd67b9b416bff9c89880b248d6e8639aa1e70))
-
-## v0.58.1 (2024-06-07)
-
-### Fix
-
-* fix(dock): new dock can be detached upon creation ([`02a2608`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/02a26086c4540127a11c235cba30afc4fd712007))
-
-## v0.58.0 (2024-06-07)

{bec_widgets-0.64.0 → bec_widgets-0.64.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.64.0
+Version: 0.64.2
 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.64.0 → bec_widgets-0.64.2}/bec_widgets/cli/client_utils.py

@@ -173,8 +173,15 @@ class BECGuiClientMixin:
 
     def close(self) -> None:
         """
-        Close the figure.
+        Close the gui window.
         """
+        if self._process is None:
+            return
+
+        self._run_rpc("close", (), wait_for_rpc_response=False)
+        while self.gui_is_alive():
+            time.sleep(0.2)
+
         self._client.shutdown()
         if self._process:
             self._process.terminate()

{bec_widgets-0.64.0 → bec_widgets-0.64.2}/bec_widgets/cli/generate_cli.py

@@ -2,7 +2,6 @@
 from __future__ import annotations
 
 import argparse
-import importlib
 import inspect
 import os
 import sys
@@ -10,9 +9,8 @@ from typing import Literal
 
 import black
 import isort
-from qtpy.QtWidgets import QGraphicsWidget, QWidget
 
-from bec_widgets.utils import BECConnector
+from bec_widgets.utils.plugin_utils import get_rpc_classes
 
 if sys.version_info >= (3, 11):
     from typing import get_overloads
@@ -138,50 +136,6 @@ class {class_name}(RPCBase):"""
         with open(file_name, "w", encoding="utf-8") as file:
             file.write(formatted_content)
 
-    @staticmethod
-    def get_rpc_classes(
-        repo_name: str,
-    ) -> dict[Literal["connector_classes", "top_level_classes"], list[type]]:
-        """
-        Get all RPC-enabled classes in the specified repository.
-
-        Args:
-            repo_name(str): The name of the repository.
-
-        Returns:
-            dict: A dictionary with keys "connector_classes" and "top_level_classes" and values as lists of classes.
-        """
-        connector_classes = []
-        top_level_classes = []
-        anchor_module = importlib.import_module(f"{repo_name}.widgets")
-        directory = os.path.dirname(anchor_module.__file__)
-        for root, _, files in sorted(os.walk(directory)):
-            for file in files:
-                if not file.endswith(".py") or file.startswith("__"):
-                    continue
-
-                path = os.path.join(root, file)
-                subs = os.path.dirname(os.path.relpath(path, directory)).split("/")
-                if len(subs) == 1 and not subs[0]:
-                    module_name = file.split(".")[0]
-                else:
-                    module_name = ".".join(subs + [file.split(".")[0]])
-
-                module = importlib.import_module(f"{repo_name}.widgets.{module_name}")
-
-                for name in dir(module):
-                    obj = getattr(module, name)
-                    if not hasattr(obj, "__module__") or obj.__module__ != module.__name__:
-                        continue
-                    if isinstance(obj, type) and issubclass(obj, BECConnector):
-                        connector_classes.append(obj)
-                        if len(subs) == 1 and (
-                            issubclass(obj, QWidget) or issubclass(obj, QGraphicsWidget)
-                        ):
-                            top_level_classes.append(obj)
-
-        return {"connector_classes": connector_classes, "top_level_classes": top_level_classes}
-
 
 def main():
     """
@@ -197,7 +151,7 @@ def main():
         current_path = os.path.dirname(__file__)
         client_path = os.path.join(current_path, "client.py")
 
-        rpc_classes = ClientGenerator.get_rpc_classes("bec_widgets")
+        rpc_classes = get_rpc_classes("bec_widgets")
         rpc_classes["connector_classes"].sort(key=lambda x: x.__name__)
 
         generator = ClientGenerator()

{bec_widgets-0.64.0 → bec_widgets-0.64.2}/bec_widgets/cli/server.py

@@ -40,7 +40,7 @@ class BECWidgetsCLIServer:
         self._shutdown_event = False
         self._heartbeat_timer = QTimer()
         self._heartbeat_timer.timeout.connect(self.emit_heartbeat)
-        self._heartbeat_timer.start(200)  # Emit heartbeat every 1 seconds
+        self._heartbeat_timer.start(200)
 
     def on_rpc_update(self, msg: dict, metadata: dict):
         request_id = metadata.get("request_id")
@@ -105,7 +105,7 @@ class BECWidgetsCLIServer:
             self.client.connector.set(
                 MessageEndpoints.gui_heartbeat(self.gui_id),
                 messages.StatusMessage(name=self.gui_id, status=1, info={}),
-                expire=10,
+                expire=1,
             )
 
     def shutdown(self):  # TODO not sure if needed when cleanup is done at level of BECConnector

{bec_widgets-0.64.0 → bec_widgets-0.64.2}/bec_widgets/examples/jupyter_console/jupyter_console_window.py

@@ -10,8 +10,8 @@ from qtpy.QtGui import QIcon
 from qtpy.QtWidgets import QApplication, QVBoxLayout, QWidget
 
 from bec_widgets.utils import BECDispatcher, UILoader
-from bec_widgets.widgets import BECFigure
 from bec_widgets.widgets.dock.dock_area import BECDockArea
+from bec_widgets.widgets.figure import BECFigure
 from bec_widgets.widgets.jupyter_console.jupyter_console import BECJupyterConsole
 
 # class JupyterConsoleWidget(RichJupyterWidget):  # pragma: no cover:

bec_widgets-0.64.2/bec_widgets/utils/plugin_utils.py

@@ -0,0 +1,88 @@
+import importlib
+import inspect
+import os
+from typing import Literal
+
+from bec_lib.plugin_helper import _get_available_plugins
+from qtpy.QtWidgets import QGraphicsWidget, QWidget
+
+from bec_widgets.utils import BECConnector
+
+
+def get_plugin_widgets() -> dict[str, BECConnector]:
+    """
+    Get all available widgets from the plugin directory. Widgets are classes that inherit from BECConnector.
+    The plugins are provided through python plugins and specified in the respective pyproject.toml file using
+    the following key:
+
+        [project.entry-points."bec.widgets.user_widgets"]
+        plugin_widgets = "path.to.plugin.module"
+
+    e.g.
+        [project.entry-points."bec.widgets.user_widgets"]
+        plugin_widgets = "pxiii_bec.bec_widgets.widgets"
+
+        assuming that the widgets module for the package pxiii_bec is located at pxiii_bec/bec_widgets/widgets and
+        contains the widgets to be loaded within the pxiii_bec/bec_widgets/widgets/__init__.py file.
+
+    Returns:
+        dict[str, BECConnector]: A dictionary of widget names and their respective classes.
+    """
+    modules = _get_available_plugins("bec.widgets.user_widgets")
+    loaded_plugins = {}
+    print(modules)
+    for module in modules:
+        mods = inspect.getmembers(module, predicate=_filter_plugins)
+        for name, mod_cls in mods:
+            if name in loaded_plugins:
+                print(f"Duplicated widgets plugin {name}.")
+            loaded_plugins[name] = mod_cls
+    return loaded_plugins
+
+
+def _filter_plugins(obj):
+    return inspect.isclass(obj) and issubclass(obj, BECConnector)
+
+
+def get_rpc_classes(
+    repo_name: str,
+) -> dict[Literal["connector_classes", "top_level_classes"], list[type]]:
+    """
+    Get all RPC-enabled classes in the specified repository.
+
+    Args:
+        repo_name(str): The name of the repository.
+
+    Returns:
+        dict: A dictionary with keys "connector_classes" and "top_level_classes" and values as lists of classes.
+    """
+    connector_classes = []
+    top_level_classes = []
+    anchor_module = importlib.import_module(f"{repo_name}.widgets")
+    directory = os.path.dirname(anchor_module.__file__)
+    for root, _, files in sorted(os.walk(directory)):
+        for file in files:
+            if not file.endswith(".py") or file.startswith("__"):
+                continue
+
+            path = os.path.join(root, file)
+            subs = os.path.dirname(os.path.relpath(path, directory)).split("/")
+            if len(subs) == 1 and not subs[0]:
+                module_name = file.split(".")[0]
+            else:
+                module_name = ".".join(subs + [file.split(".")[0]])
+
+            module = importlib.import_module(f"{repo_name}.widgets.{module_name}")
+
+            for name in dir(module):
+                obj = getattr(module, name)
+                if not hasattr(obj, "__module__") or obj.__module__ != module.__name__:
+                    continue
+                if isinstance(obj, type) and issubclass(obj, BECConnector):
+                    connector_classes.append(obj)
+                    if len(subs) == 1 and (
+                        issubclass(obj, QWidget) or issubclass(obj, QGraphicsWidget)
+                    ):
+                        top_level_classes.append(obj)
+
+    return {"connector_classes": connector_classes, "top_level_classes": top_level_classes}

bec_widgets-0.64.2/bec_widgets/widgets/__init__.py

@@ -0,0 +1,5 @@
+# from .buttons import StopButton
+# from .dock import BECDock, BECDockArea
+# from .figure import BECFigure, FigureConfig
+# from .scan_control import ScanControl
+# from .spiral_progress_bar import SpiralProgressBar

{bec_widgets-0.64.0 → bec_widgets-0.64.2}/bec_widgets/widgets/dock/dock.py

@@ -11,7 +11,7 @@ from bec_widgets.utils import BECConnector, ConnectionConfig, GridLayoutManager
 if TYPE_CHECKING:
     from qtpy.QtWidgets import QWidget
 
-    from bec_widgets.widgets import BECDockArea
+    from bec_widgets.widgets.dock import BECDockArea
 
 
 class DockConfig(ConnectionConfig):

{bec_widgets-0.64.0 → bec_widgets-0.64.2}/docs/user/customisation.md

@@ -48,7 +48,7 @@ users to interact. BEC Widgets must be placed in the window:
 
 ```
 from qtpy.QWidgets import QMainWindow
-from bec_widgets.widgets import BECFigure
+from bec_widgets.widgets.figure import BECFigure
 
 window = QMainWindow()
 bec_figure = BECFigure(gui_id="my_gui_app_id")
@@ -78,7 +78,7 @@ Final example:
 ```
 import sys
 from qtpy.QtWidgets import QMainWindow, QApplication
-from bec_widgets.widgets import BECFigure
+from bec_widgets.widgets.figure import BECFigure
 from bec_widgets.utils.bec_dispatcher import BECDispatcher
 
 # creation of the Qt application

{bec_widgets-0.64.0 → bec_widgets-0.64.2}/docs/user/widgets/buttons.md

@@ -24,7 +24,7 @@ a `StopButton` within a GUI layout:
 
 ```python
 from qtpy.QtWidgets import QWidget, QVBoxLayout
-from bec_widgets.widgets import StopButton
+from bec_widgets.widgets.buttons import StopButton
 
 
 class MyGui(QWidget):

{bec_widgets-0.64.0 → bec_widgets-0.64.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_widgets"
-version = "0.64.0"
+version = "0.64.2"
 description = "BEC Widgets"
 requires-python = ">=3.10"
 classifiers = [

{bec_widgets-0.64.0 → bec_widgets-0.64.2}/tests/end-2-end/conftest.py

@@ -8,7 +8,8 @@ from bec_lib.endpoints import MessageEndpoints
 from bec_widgets.cli.client_utils import _start_plot_process
 from bec_widgets.cli.rpc_register import RPCRegister
 from bec_widgets.utils import BECDispatcher
-from bec_widgets.widgets import BECDockArea, BECFigure
+from bec_widgets.widgets.dock import BECDockArea
+from bec_widgets.widgets.figure import BECFigure
 
 
 # make threads check in autouse, **will be executed at the end**; better than

{bec_widgets-0.64.0 → bec_widgets-0.64.2}/tests/unit_tests/test_bec_dock.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from bec_widgets.widgets import BECDock, BECDockArea
+from bec_widgets.widgets.dock import BECDock, BECDockArea
 
 from .client_mocks import mocked_client
 

{bec_widgets-0.64.0 → bec_widgets-0.64.2}/tests/unit_tests/test_bec_figure.py

@@ -3,7 +3,7 @@
 import numpy as np
 import pytest
 
-from bec_widgets.widgets import BECFigure
+from bec_widgets.widgets.figure import BECFigure
 from bec_widgets.widgets.figure.plots.image.image import BECImageShow
 from bec_widgets.widgets.figure.plots.motor_map.motor_map import BECMotorMap
 from bec_widgets.widgets.figure.plots.waveform.waveform import BECWaveform

{bec_widgets-0.64.0 → bec_widgets-0.64.2}/tests/unit_tests/test_generate_cli_client.py

@@ -97,17 +97,3 @@ def test_client_generator_with_black_formatting():
     generated_output_formatted = isort.code(generated_output_formatted)
 
     assert expected_output_formatted == generated_output_formatted
-
-
-def test_client_generator_classes():
-    generator = ClientGenerator()
-    out = generator.get_rpc_classes("bec_widgets")
-    assert list(out.keys()) == ["connector_classes", "top_level_classes"]
-    connector_cls_names = [cls.__name__ for cls in out["connector_classes"]]
-    top_level_cls_names = [cls.__name__ for cls in out["top_level_classes"]]
-
-    assert "BECFigure" in connector_cls_names
-    assert "BECWaveform" in connector_cls_names
-    assert "BECDockArea" in top_level_cls_names
-    assert "BECFigure" in top_level_cls_names
-    assert "BECWaveform" not in top_level_cls_names

bec_widgets-0.64.2/tests/unit_tests/test_plugin_utils.py

@@ -0,0 +1,14 @@
+from bec_widgets.utils.plugin_utils import get_rpc_classes
+
+
+def test_client_generator_classes():
+    out = get_rpc_classes("bec_widgets")
+    assert list(out.keys()) == ["connector_classes", "top_level_classes"]
+    connector_cls_names = [cls.__name__ for cls in out["connector_classes"]]
+    top_level_cls_names = [cls.__name__ for cls in out["top_level_classes"]]
+
+    assert "BECFigure" in connector_cls_names
+    assert "BECWaveform" in connector_cls_names
+    assert "BECDockArea" in top_level_cls_names
+    assert "BECFigure" in top_level_cls_names
+    assert "BECWaveform" not in top_level_cls_names

{bec_widgets-0.64.0 → bec_widgets-0.64.2}/tests/unit_tests/test_scan_control.py

@@ -5,7 +5,7 @@ import pytest
 from qtpy.QtWidgets import QLineEdit
 
 from bec_widgets.utils.widget_io import WidgetIO
-from bec_widgets.widgets import ScanControl
+from bec_widgets.widgets.scan_control import ScanControl
 from tests.unit_tests.test_msgs.available_scans_message import available_scans_message
 
 

{bec_widgets-0.64.0 → bec_widgets-0.64.2}/tests/unit_tests/test_spiral_progress_bar.py

@@ -5,7 +5,7 @@ from bec_lib.endpoints import MessageEndpoints
 from pydantic import ValidationError
 
 from bec_widgets.utils import Colors
-from bec_widgets.widgets import SpiralProgressBar
+from bec_widgets.widgets.spiral_progress_bar import SpiralProgressBar
 from bec_widgets.widgets.spiral_progress_bar.ring import RingConfig, RingConnections
 from bec_widgets.widgets.spiral_progress_bar.spiral_progress_bar import SpiralProgressBarConfig
 

{bec_widgets-0.64.0 → bec_widgets-0.64.2}/tests/unit_tests/test_stop_button.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from bec_widgets.widgets import StopButton
+from bec_widgets.widgets.buttons import StopButton
 
 from .client_mocks import mocked_client
 

bec_widgets-0.64.0/bec_widgets/utils/plugin_utils.py

@@ -1,40 +0,0 @@
-import inspect
-
-from bec_lib.plugin_helper import _get_available_plugins
-
-from bec_widgets.utils import BECConnector
-
-
-def get_plugin_widgets() -> dict[str, BECConnector]:
-    """
-    Get all available widgets from the plugin directory. Widgets are classes that inherit from BECConnector.
-    The plugins are provided through python plugins and specified in the respective pyproject.toml file using
-    the following key:
-
-        [project.entry-points."bec.widgets.user_widgets"]
-        plugin_widgets = "path.to.plugin.module"
-
-    e.g.
-        [project.entry-points."bec.widgets.user_widgets"]
-        plugin_widgets = "pxiii_bec.bec_widgets.widgets"
-
-        assuming that the widgets module for the package pxiii_bec is located at pxiii_bec/bec_widgets/widgets and
-        contains the widgets to be loaded within the pxiii_bec/bec_widgets/widgets/__init__.py file.
-
-    Returns:
-        dict[str, BECConnector]: A dictionary of widget names and their respective classes.
-    """
-    modules = _get_available_plugins("bec.widgets.user_widgets")
-    loaded_plugins = {}
-    print(modules)
-    for module in modules:
-        mods = inspect.getmembers(module, predicate=_filter_plugins)
-        for name, mod_cls in mods:
-            if name in loaded_plugins:
-                print(f"Duplicated widgets plugin {name}.")
-            loaded_plugins[name] = mod_cls
-    return loaded_plugins
-
-
-def _filter_plugins(obj):
-    return inspect.isclass(obj) and issubclass(obj, BECConnector)

bec_widgets-0.64.0/bec_widgets/widgets/__init__.py

@@ -1,5 +0,0 @@
-from .buttons import StopButton
-from .dock import BECDock, BECDockArea
-from .figure import BECFigure, FigureConfig
-from .scan_control import ScanControl
-from .spiral_progress_bar import SpiralProgressBar