bec-widgets 0.65.2__tar.gz → 0.66.0__tar.gz

{bec_widgets-0.65.2 → bec_widgets-0.66.0}/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## v0.66.0 (2024-06-20)
+
+### Feature
+
+* feat(rpc): discover widgets automatically ([`ef25f56`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ef25f5638032f931ceb292540ada618508bb2aed))
+
 ## v0.65.2 (2024-06-20)
 
 ### Fix
@@ -151,10 +157,6 @@ This reverts commit abc6caa2d0b6141dfbe1f3d025f78ae14deddcb3 ([`fe04dd8`](https:
 
 * feat: added isort to bw-generate-cli ([`f0391f5`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f0391f59c9eb0a51b693fccfe2e399e869d35dda))
 
-* feat: added entry point for bw-generate-cli ([`1c7f491`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1c7f4912ce5998e666276969bf4af8656d619a91))
-
-* feat(cli): auto-discover rpc-enabled widgets ([`df1be10`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/df1be10057a5e85a3f35bef1c1b27366b6727276))
-
 ### Fix
 
 * fix: removed BECConnector from rpc client interface ([`6428e38`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6428e38ab94c15a2c904e75cc6404bb6d0394e04))

{bec_widgets-0.65.2 → bec_widgets-0.66.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.65.2
+Version: 0.66.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.66.0/bec_widgets/cli/rpc_wigdet_handler.py

@@ -0,0 +1,53 @@
+from bec_widgets.utils import BECConnector
+
+
+class RPCWidgetHandler:
+    """Handler class for creating widgets from RPC messages."""
+
+    def __init__(self):
+        self._widget_classes = None
+
+    @property
+    def widget_classes(self):
+        """
+        Get the available widget classes.
+
+        Returns:
+            dict: The available widget classes.
+        """
+        if self._widget_classes is None:
+            self.update_available_widgets()
+        return self._widget_classes
+
+    def update_available_widgets(self):
+        """
+        Update the available widgets.
+
+        Returns:
+            None
+        """
+        from bec_widgets.utils.plugin_utils import get_rpc_classes
+
+        clss = get_rpc_classes("bec_widgets")
+        self._widget_classes = {cls.__name__: cls for cls in clss["top_level_classes"]}
+
+    def create_widget(self, widget_type, **kwargs) -> BECConnector:
+        """
+        Create a widget from an RPC message.
+
+        Args:
+            widget_type(str): The type of the widget.
+            **kwargs: The keyword arguments for the widget.
+
+        Returns:
+            widget(BECConnector): The created widget.
+        """
+        if self._widget_classes is None:
+            self.update_available_widgets()
+        widget_class = self._widget_classes.get(widget_type)
+        if widget_class:
+            return widget_class(**kwargs)
+        raise ValueError(f"Unknown widget type: {widget_type}")
+
+
+widget_handler = RPCWidgetHandler()

{bec_widgets-0.65.2 → bec_widgets-0.66.0}/bec_widgets/widgets/dock/dock.py

@@ -5,7 +5,7 @@ from typing import TYPE_CHECKING, Any, Literal, Optional
 from pydantic import Field
 from pyqtgraph.dockarea import Dock
 
-from bec_widgets.cli.rpc_wigdet_handler import RPCWidgetHandler
+from bec_widgets.cli.rpc_wigdet_handler import widget_handler
 from bec_widgets.utils import BECConnector, ConnectionConfig, GridLayoutManager
 
 if TYPE_CHECKING:
@@ -149,7 +149,7 @@ class BECDock(BECConnector, Dock):
         Returns:
             list: The list of eligible widgets.
         """
-        return list(RPCWidgetHandler.widget_classes.keys())
+        return list(widget_handler.widget_classes.keys())
 
     def add_widget(
         self,
@@ -178,7 +178,7 @@ class BECDock(BECConnector, Dock):
             self.layout_manager.shift_widgets(shift, start_row=row)
 
         if isinstance(widget, str):
-            widget = RPCWidgetHandler.create_widget(widget)
+            widget = widget_handler.create_widget(widget)
         else:
             widget = widget
 

{bec_widgets-0.65.2 → bec_widgets-0.66.0}/pyproject.toml

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

bec_widgets-0.66.0/tests/unit_tests/test_rpc_widget_handler.py

@@ -0,0 +1,7 @@
+from bec_widgets.cli.rpc_wigdet_handler import RPCWidgetHandler
+
+
+def test_rpc_widget_handler():
+    handler = RPCWidgetHandler()
+    assert "BECFigure" in handler.widget_classes
+    assert "SpiralProgressBar" in handler.widget_classes

bec_widgets-0.65.2/bec_widgets/cli/rpc_wigdet_handler.py

@@ -1,33 +0,0 @@
-from bec_widgets.utils import BECConnector
-from bec_widgets.widgets.figure import BECFigure
-from bec_widgets.widgets.spiral_progress_bar.spiral_progress_bar import SpiralProgressBar
-from bec_widgets.widgets.text_box.text_box import TextBox
-from bec_widgets.widgets.website.website import WebsiteWidget
-
-
-class RPCWidgetHandler:
-    """Handler class for creating widgets from RPC messages."""
-
-    widget_classes = {
-        "BECFigure": BECFigure,
-        "SpiralProgressBar": SpiralProgressBar,
-        "Website": WebsiteWidget,
-        "TextBox": TextBox,
-    }
-
-    @staticmethod
-    def create_widget(widget_type, **kwargs) -> BECConnector:
-        """
-        Create a widget from an RPC message.
-
-        Args:
-            widget_type(str): The type of the widget.
-            **kwargs: The keyword arguments for the widget.
-
-        Returns:
-            widget(BECConnector): The created widget.
-        """
-        widget_class = RPCWidgetHandler.widget_classes.get(widget_type)
-        if widget_class:
-            return widget_class(**kwargs)
-        raise ValueError(f"Unknown widget type: {widget_type}")