bec-widgets 0.57.0__tar.gz → 0.57.1__tar.gz

{bec_widgets-0.57.0 → bec_widgets-0.57.1}/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 
 
+## v0.57.1 (2024-06-06)
+
+### Documentation
+
+* docs: docs refactored from add_widget_bec to add_widget ([`c3f4845`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c3f4845b4f95005ff737fed5542600b0b9a9cc2b))
+
+### Fix
+
+* fix: tests references to add_widget_bec refactored ([`f51b25f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f51b25f0af4ab8b0a75ee48a40bfbb079c16e9d1))
+
+* fix(dock): add_widget and add_widget_bec consolidated ([`8ae323f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/8ae323f5c3c0d9d0f202d31d5e8374a272a26be2))
+
+
 ## v0.57.0 (2024-06-05)
 
 ### Documentation
@@ -160,16 +173,3 @@
 ### Fix
 
 * fix(docstrings): docstrings formating fixed for sphinx to properly format readdocs ([`7f2f7cd`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7f2f7cd07a14876617cd83cedde8c281fdc52c3a))
-
-
-## v0.52.0 (2024-05-07)
-
-### Feature
-
-* feat(utils/layout_manager): added GridLayoutManager to extend functionalities of native QGridLayout ([`fcd6ef0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/fcd6ef0975dc872f69c9d6fb2b8a1ad04a423aae))
-
-* feat(widget/dock): BECDock and BECDock area for dockable windows ([`d8ff8af`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/d8ff8afcd474660a6069bbdab05f10a65f221727))
-
-### Fix
-
-* fix(widgets/dock): BECDockArea close overwrites the default pyqtgraph Container close + minor improvements ([`ceae979`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ceae979f375ecc33c5c97148f197655c1ca57b6c))

{bec_widgets-0.57.0 → bec_widgets-0.57.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.57.0
+Version: 0.57.1
 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.57.0 → bec_widgets-0.57.1}/bec_widgets/cli/auto_updates.py

@@ -30,7 +30,7 @@ class AutoUpdates:
         Create a default dock for the auto updates.
         """
         dock = self.gui.add_dock("default_figure")
-        dock.add_widget_bec("BECFigure")
+        dock.add_widget("BECFigure")
         self.dock_name = "default_figure"
 
     @staticmethod

{bec_widgets-0.57.0 → bec_widgets-0.57.1}/bec_widgets/cli/client.py

@@ -1468,20 +1468,20 @@ class BECDock(RPCBase):
         """
 
     @rpc_call
-    def add_widget_bec(
+    def add_widget(
         self,
-        widget_type: "str",
+        widget: "BECConnector | str",
         row=None,
         col=0,
         rowspan=1,
         colspan=1,
         shift: "Literal['down', 'up', 'left', 'right']" = "down",
-    ):
+    ) -> "BECConnector":
         """
         Add a widget to the dock.
 
         Args:
-            widget_type(str): The widget to add. Only BEC RPC widgets from RPCWidgetHandler are allowed.
+            widget(QWidget): The widget to add.
             row(int): The row to add the widget to. If None, the widget will be added to the next available row.
             col(int): The column to add the widget to.
             rowspan(int): The number of rows the widget should span.

{bec_widgets-0.57.0 → bec_widgets-0.57.1}/bec_widgets/examples/jupyter_console/jupyter_console_window.py

@@ -104,19 +104,19 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
     def _init_dock(self):
 
         self.d0 = self.dock.add_dock(name="dock_0")
-        self.fig0 = self.d0.add_widget_bec("BECFigure")
+        self.fig0 = self.d0.add_widget("BECFigure")
         self.fig0.image("eiger", vrange=(0, 100))
 
         self.d1 = self.dock.add_dock(name="dock_1", position="right")
-        self.fig1 = self.d1.add_widget_bec("BECFigure")
+        self.fig1 = self.d1.add_widget("BECFigure")
         self.fig1.plot(x_name="samx", y_name="bpm4i")
         self.fig1.plot(x_name="samx", y_name="bpm3a")
 
         self.d2 = self.dock.add_dock(name="dock_2", position="bottom")
-        self.fig2 = self.d2.add_widget_bec("BECFigure", row=0, col=0)
+        self.fig2 = self.d2.add_widget("BECFigure", row=0, col=0)
         self.fig2.motor_map(x_name="samx", y_name="samy")
         self.fig2.plot(x_name="samx", y_name="bpm4i")
-        self.bar = self.d2.add_widget_bec("SpiralProgressBar", row=0, col=1)
+        self.bar = self.d2.add_widget("SpiralProgressBar", row=0, col=1)
         self.bar.set_diameter(200)
 
         self.dock.save_state()

{bec_widgets-0.57.0 → bec_widgets-0.57.1}/bec_widgets/widgets/dock/dock.py

@@ -33,7 +33,7 @@ class BECDock(BECConnector, Dock):
         "hide_title_bar",
         "get_widgets_positions",
         "set_title",
-        "add_widget_bec",
+        "add_widget",
         "list_eligible_widgets",
         "move_widget",
         "remove_widget",
@@ -152,47 +152,47 @@ class BECDock(BECConnector, Dock):
         """
         return list(RPCWidgetHandler.widget_classes.keys())
 
-    def add_widget_bec(
-        self,
-        widget_type: str,
-        row=None,
-        col=0,
-        rowspan=1,
-        colspan=1,
-        shift: Literal["down", "up", "left", "right"] = "down",
-    ):
-        """
-        Add a widget to the dock.
-
-        Args:
-            widget_type(str): The widget to add. Only BEC RPC widgets from RPCWidgetHandler are allowed.
-            row(int): The row to add the widget to. If None, the widget will be added to the next available row.
-            col(int): The column to add the widget to.
-            rowspan(int): The number of rows the widget should span.
-            colspan(int): The number of columns the widget should span.
-            shift(Literal["down", "up", "left", "right"]): The direction to shift the widgets if the position is occupied.
-        """
-        if row is None:
-            row = self.layout.rowCount()
-
-        if self.layout_manager.is_position_occupied(row, col):
-            self.layout_manager.shift_widgets(shift, start_row=row)
-
-        widget = RPCWidgetHandler.create_widget(widget_type)
-        self.addWidget(widget, row=row, col=col, rowspan=rowspan, colspan=colspan)
-        self.config.widgets[widget.gui_id] = widget.config
-
-        return widget
+    # def add_widget_bec(
+    #     self,
+    #     widget_type: str,
+    #     row=None,
+    #     col=0,
+    #     rowspan=1,
+    #     colspan=1,
+    #     shift: Literal["down", "up", "left", "right"] = "down",
+    # ):
+    #     """
+    #     Add a widget to the dock.
+    #
+    #     Args:
+    #         widget_type(str): The widget to add. Only BEC RPC widgets from RPCWidgetHandler are allowed.
+    #         row(int): The row to add the widget to. If None, the widget will be added to the next available row.
+    #         col(int): The column to add the widget to.
+    #         rowspan(int): The number of rows the widget should span.
+    #         colspan(int): The number of columns the widget should span.
+    #         shift(Literal["down", "up", "left", "right"]): The direction to shift the widgets if the position is occupied.
+    #     """
+    #     if row is None:
+    #         row = self.layout.rowCount()
+    #
+    #     if self.layout_manager.is_position_occupied(row, col):
+    #         self.layout_manager.shift_widgets(shift, start_row=row)
+    #
+    #     widget = RPCWidgetHandler.create_widget(widget_type)
+    #     self.addWidget(widget, row=row, col=col, rowspan=rowspan, colspan=colspan)
+    #     self.config.widgets[widget.gui_id] = widget.config
+    #
+    #     return widget
 
     def add_widget(
         self,
-        widget: QWidget,
+        widget: BECConnector | str,
         row=None,
         col=0,
         rowspan=1,
         colspan=1,
         shift: Literal["down", "up", "left", "right"] = "down",
-    ):
+    ) -> BECConnector:
         """
         Add a widget to the dock.
 
@@ -210,8 +210,17 @@ class BECDock(BECConnector, Dock):
         if self.layout_manager.is_position_occupied(row, col):
             self.layout_manager.shift_widgets(shift, start_row=row)
 
+        if isinstance(widget, str):
+            widget = RPCWidgetHandler.create_widget(widget)
+        else:
+            widget = widget
+
         self.addWidget(widget, row=row, col=col, rowspan=rowspan, colspan=colspan)
-        self.config.widgets[widget.gui_id] = widget.config
+
+        if hasattr(widget, "config"):
+            self.config.widgets[widget.gui_id] = widget.config
+
+        return widget
 
     def move_widget(self, widget: QWidget, new_row: int, new_col: int):
         """

{bec_widgets-0.57.0 → bec_widgets-0.57.1}/bec_widgets/widgets/dock/dock_area.py

@@ -171,9 +171,7 @@ class BECDockArea(BECConnector, DockArea):
                 dock.show_title_bar()
 
         if widget is not None and isinstance(widget, str):
-            dock.add_widget_bec(
-                widget_type=widget, row=row, col=col, rowspan=rowspan, colspan=colspan
-            )
+            dock.add_widget(widget=widget, row=row, col=col, rowspan=rowspan, colspan=colspan)
         elif widget is not None and isinstance(widget, QWidget):
             dock.addWidget(widget, row=row, col=col, rowspan=rowspan, colspan=colspan)
         if self._instructions_visible:

{bec_widgets-0.57.0 → bec_widgets-0.57.1}/docs/user/widgets/bec_figure.md

@@ -20,7 +20,7 @@ In the following, we describe 4 different type of widgets thaat are available in
 The following code snipped demonstrates how to create a 1D waveform plot using BEC Widgets within BEC. More details about BEC Widgets in BEC can be found in the getting started section within the [introduction to the command line.](user.command_line_introduction)
 ```python
 # adds a new dock, a new BECFigure and a BECWaveForm to the dock
-plt = gui.add_dock().add_widget_bec('BECFigure').plot('samx', 'bpm4i')
+plt = gui.add_dock().add_widget('BECFigure').plot('samx', 'bpm4i')
 # add a second curve to the same plot 
 plt.add_curve_scan('samx', 'bpm3i')
 plt.set_title("Gauss plots vs. samx")
@@ -53,7 +53,7 @@ dev.bpm3i.sim.select_sim_model("StepModel")
 The following code snipped demonstrates how to create a 2D scatter plot using BEC Widgets within BEC.
 ```python
 # adds a new dock, a new BECFigure and a BECWaveForm to the dock
-plt = gui.add_dock().add_widget_bec('BECFigure').add_plot('samx', 'samy', 'bpm4i')
+plt = gui.add_dock().add_widget('BECFigure').add_plot('samx', 'samy', 'bpm4i')
 ```
 
 (user.widgets.motor_map)=
@@ -72,7 +72,7 @@ plt = gui.add_dock().add_widget_bec('BECFigure').add_plot('samx', 'samy', 'bpm4i
 The following code snipped demonstrates how to create a motor map using BEC Widgets within BEC.
 ```python
 # add a motor map to the gui
-mot_map = gui.add_dock().add_widget_bec('BECFigure').motor_map('samx', 'samy')
+mot_map = gui.add_dock().add_widget('BECFigure').motor_map('samx', 'samy')
 # change the number of points displayed
 ```
 
@@ -91,7 +91,7 @@ mot_map = gui.add_dock().add_widget_bec('BECFigure').motor_map('samx', 'samy')
 The following code snipped demonstrates how to create a motor map using BEC Widgets within BEC.
 ```python
 # add a camera view for the eiger camera to the gui
-cam_widget = gui.add_dock().add_widget_bec('BECFigure').image('eiger')
+cam_widget = gui.add_dock().add_widget('BECFigure').image('eiger')
 # set the title of the camera view
 cam_widget.set_title("Camera Image Eiger")
 # change the color map range, e.g. from 0 to 100, per default it is autoscaling

{bec_widgets-0.57.0 → bec_widgets-0.57.1}/docs/user/widgets/spiral_progress_bar.md

@@ -15,7 +15,7 @@
 The following code snipped demonstrates how to create a 2D scatter plot using BEC Widgets within BEC.
 ```python
 # adds a new dock with a spiral progress bar
-progress = gui.add_dock().add_widget_bec("SpiralProgressBar")
+progress = gui.add_dock().add_widget("SpiralProgressBar")
 # customize the size of the ring
-progress.set_line_widfth(20)
+progress.set_line_width(20)
 ```

{bec_widgets-0.57.0 → bec_widgets-0.57.1}/pyproject.toml

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

{bec_widgets-0.57.0 → bec_widgets-0.57.1}/tests/end-2-end/test_bec_dock_rpc_e2e.py

@@ -38,9 +38,9 @@ def test_rpc_add_dock_with_figure_e2e(rpc_server_dock, qtbot):
     assert len(dock_server.docks) == 3
 
     # Add 3 figures with some widgets
-    fig0 = d0.add_widget_bec("BECFigure")
-    fig1 = d1.add_widget_bec("BECFigure")
-    fig2 = d2.add_widget_bec("BECFigure")
+    fig0 = d0.add_widget("BECFigure")
+    fig1 = d1.add_widget("BECFigure")
+    fig2 = d2.add_widget("BECFigure")
 
     assert len(dock_server.docks) == 3
     assert len(dock_server.docks["dock_0"].widgets) == 1
@@ -166,7 +166,7 @@ def test_spiral_bar(rpc_server_dock):
 
     d0 = dock.add_dock(name="dock_0")
 
-    bar = d0.add_widget_bec("SpiralProgressBar")
+    bar = d0.add_widget("SpiralProgressBar")
     assert bar.__class__.__name__ == "SpiralProgressBar"
 
     bar.set_number_of_bars(5)
@@ -188,7 +188,7 @@ def test_spiral_bar_scan_update(rpc_server_dock, qtbot):
 
     d0 = dock.add_dock("dock_0")
 
-    d0.add_widget_bec("SpiralProgressBar")
+    d0.add_widget("SpiralProgressBar")
 
     client = rpc_server_dock.client
     dev = client.device_manager.devices

{bec_widgets-0.57.0 → bec_widgets-0.57.1}/tests/unit_tests/test_bec_dock.py

@@ -58,7 +58,7 @@ def test_bec_dock_area_add_remove_dock(bec_dock_area, qtbot):
 
 def test_add_remove_bec_figure_to_dock(bec_dock_area):
     d0 = bec_dock_area.add_dock()
-    fig = d0.add_widget_bec("BECFigure")
+    fig = d0.add_widget("BECFigure")
     plt = fig.plot(x_name="samx", y_name="bpm4i")
     im = fig.image("eiger")
     mm = fig.motor_map("samx", "samy")