bec-widgets 0.57.3__tar.gz → 0.57.5__tar.gz

{bec_widgets-0.57.3 → bec_widgets-0.57.5}/CHANGELOG.md

@@ -2,6 +2,32 @@
 
 
 
+## v0.57.5 (2024-06-06)
+
+### Documentation
+
+* docs(figure): docs adjusted to be compatible with new signature ([`c037b87`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c037b87675af91b26e8c7c60e76622d4ed4cf5d5))
+
+### Fix
+
+* fix(waveform): added .plot method with the same signature as BECFigure.plot ([`8479caf`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/8479caf53a7325788ca264e5bd9aee01f1d4c5a0))
+
+* fix(plot_base): .plot removed from plot_base.py, because there is no use case for it ([`82e2c89`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/82e2c898d2e26f786b2d481f85c647472675e75b))
+
+### Refactor
+
+* refactor(figure): logic for .add_image and .image consolidated; logic for .add_plot and .plot consolidated ([`52bc322`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/52bc322b2b8d3ef92ff3480e61bddaf32464f976))
+
+
+## v0.57.4 (2024-06-06)
+
+### Fix
+
+* fix(docks): set_title do update dock internal _name now ([`15cbc21`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/15cbc21e5bb3cf85f5822d44a2b3665b5aa2f346))
+
+* fix(docks): docks widget_list adn dockarea panels return values fixed ([`ffae5ee`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ffae5ee54e6b43da660131092452adff195ba4fb))
+
+
 ## v0.57.3 (2024-06-06)
 
 ### Documentation
@@ -131,31 +157,3 @@
 
 
 ## v0.55.0 (2024-05-24)
-
-### Feature
-
-* feat(widgets/progressbar): SpiralProgressBar added with rpc interface ([`76bd0d3`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/76bd0d339ac9ae9e8a3baa0d0d4e951ec1d09670))
-
-
-## v0.54.0 (2024-05-24)
-
-### Build
-
-* build: added pyqt6 as sphinx build dependency ([`a47a8ec`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a47a8ec413934cf7fce8d5b7a5913371d4b3b4a5))
-
-### Feature
-
-* feat(figure): changes to support direct plot functionality ([`fc4d0f3`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/fc4d0f3bb2a7c2fca9c326d86eb68b305bcd548b))
-
-### Refactor
-
-* refactor(reconstruction): repository structure is changed to separate assets needed for each widget ([`3455c60`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3455c602361d3b5cc3ff9190f9d2870474becf8a))
-
-* refactor(clean-up): 1st generation widgets are removed ([`edc25fb`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/edc25fbf9d5a0321e5f0a80b492b6337df807849))
-
-
-## v0.53.3 (2024-05-16)
-
-### Fix
-
-* fix: removed apparently unnecessary sleep while waiting for an rpc response ([`7d64cac`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7d64cac6610b39d3553ff650354f78ead8ee6b55))

{bec_widgets-0.57.3 → bec_widgets-0.57.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.57.3
+Version: 0.57.5
 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.3 → bec_widgets-0.57.5}/bec_widgets/cli/client.py

@@ -128,17 +128,6 @@ class BECPlotBase(RPCBase):
             lock(bool): True to lock, False to unlock.
         """
 
-    @rpc_call
-    def plot(self, data_x: "list | np.ndarray", data_y: "list | np.ndarray", **kwargs):
-        """
-        Plot custom data on the plot widget. These data are not saved in config.
-
-        Args:
-            data_x(list|np.ndarray): x-axis data
-            data_y(list|np.ndarray): y-axis data
-            **kwargs: Keyword arguments for the plot.
-        """
-
     @rpc_call
     def remove(self):
         """
@@ -165,57 +154,36 @@ class BECWaveform(RPCBase):
         """
 
     @rpc_call
-    def add_curve_scan(
+    def plot(
         self,
-        x_name: "str",
-        y_name: "str",
-        z_name: "Optional[str]" = None,
-        x_entry: "Optional[str]" = None,
-        y_entry: "Optional[str]" = None,
-        z_entry: "Optional[str]" = None,
-        color: "Optional[str]" = None,
-        color_map_z: "Optional[str]" = "plasma",
-        label: "Optional[str]" = None,
-        validate_bec: "bool" = True,
-        **kwargs,
+        x: "list | np.ndarray | None" = None,
+        y: "list | np.ndarray | None" = None,
+        x_name: "str | None" = None,
+        y_name: "str | None" = None,
+        z_name: "str | None" = None,
+        x_entry: "str | None" = None,
+        y_entry: "str | None" = None,
+        z_entry: "str | None" = None,
+        color: "str | None" = None,
+        color_map_z: "str | None" = "plasma",
+        label: "str | None" = None,
+        validate: "bool" = True,
     ) -> "BECCurve":
         """
-        Add a curve to the plot widget from the scan segment.
-
+        Plot a curve to the plot widget.
         Args:
-            x_name(str): Name of the x signal.
-            x_entry(str): Entry of the x signal.
-            y_name(str): Name of the y signal.
-            y_entry(str): Entry of the y signal.
-            z_name(str): Name of the z signal.
-            z_entry(str): Entry of the z signal.
-            color(str, optional): Color of the curve. Defaults to None.
+            x(list | np.ndarray): Custom x data to plot.
+            y(list | np.ndarray): Custom y data to plot.
+            x_name(str): The name of the device for the x-axis.
+            y_name(str): The name of the device for the y-axis.
+            z_name(str): The name of the device for the z-axis.
+            x_entry(str): The name of the entry for the x-axis.
+            y_entry(str): The name of the entry for the y-axis.
+            z_entry(str): The name of the entry for the z-axis.
+            color(str): The color of the curve.
             color_map_z(str): The color map to use for the z-axis.
-            label(str, optional): Label of the curve. Defaults to None.
-            **kwargs: Additional keyword arguments for the curve configuration.
-
-        Returns:
-            BECCurve: The curve object.
-        """
-
-    @rpc_call
-    def add_curve_custom(
-        self,
-        x: "list | np.ndarray",
-        y: "list | np.ndarray",
-        label: "str" = None,
-        color: "str" = None,
-        **kwargs,
-    ) -> "BECCurve":
-        """
-        Add a custom data curve to the plot widget.
-
-        Args:
-            x(list|np.ndarray): X data of the curve.
-            y(list|np.ndarray): Y data of the curve.
-            label(str, optional): Label of the curve. Defaults to None.
-            color(str, optional): Color of the curve. Defaults to None.
-            **kwargs: Additional keyword arguments for the curve configuration.
+            label(str): The label of the curve.
+            validate(bool): If True, validate the device names and entries.
 
         Returns:
             BECCurve: The curve object.
@@ -409,14 +377,39 @@ class BECWaveform(RPCBase):
         """
 
     @rpc_call
-    def plot(self, data_x: "list | np.ndarray", data_y: "list | np.ndarray", **kwargs):
+    def plot(
+        self,
+        x: "list | np.ndarray | None" = None,
+        y: "list | np.ndarray | None" = None,
+        x_name: "str | None" = None,
+        y_name: "str | None" = None,
+        z_name: "str | None" = None,
+        x_entry: "str | None" = None,
+        y_entry: "str | None" = None,
+        z_entry: "str | None" = None,
+        color: "str | None" = None,
+        color_map_z: "str | None" = "plasma",
+        label: "str | None" = None,
+        validate: "bool" = True,
+    ) -> "BECCurve":
         """
-        Plot custom data on the plot widget. These data are not saved in config.
-
+        Plot a curve to the plot widget.
         Args:
-            data_x(list|np.ndarray): x-axis data
-            data_y(list|np.ndarray): y-axis data
-            **kwargs: Keyword arguments for the plot.
+            x(list | np.ndarray): Custom x data to plot.
+            y(list | np.ndarray): Custom y data to plot.
+            x_name(str): The name of the device for the x-axis.
+            y_name(str): The name of the device for the y-axis.
+            z_name(str): The name of the device for the z-axis.
+            x_entry(str): The name of the entry for the x-axis.
+            y_entry(str): The name of the entry for the y-axis.
+            z_entry(str): The name of the entry for the z-axis.
+            color(str): The color of the curve.
+            color_map_z(str): The color map to use for the z-axis.
+            label(str): The label of the curve.
+            validate(bool): If True, validate the device names and entries.
+
+        Returns:
+            BECCurve: The curve object.
         """
 
     @rpc_call
@@ -469,14 +462,14 @@ class BECFigure(RPCBase):
     @rpc_call
     def add_plot(
         self,
+        x: "list | np.ndarray" = None,
+        y: "list | np.ndarray" = None,
         x_name: "str" = None,
         y_name: "str" = None,
         z_name: "str" = None,
         x_entry: "str" = None,
         y_entry: "str" = None,
         z_entry: "str" = None,
-        x: "list | np.ndarray" = None,
-        y: "list | np.ndarray" = None,
         color: "Optional[str]" = None,
         color_map_z: "Optional[str]" = "plasma",
         label: "Optional[str]" = None,
@@ -490,7 +483,18 @@ class BECFigure(RPCBase):
         Add a Waveform1D plot to the figure at the specified position.
 
         Args:
-            widget_id(str): The unique identifier of the widget. If not provided, a unique ID will be generated.
+            x(list | np.ndarray): Custom x data to plot.
+            y(list | np.ndarray): Custom y data to plot.
+            x_name(str): The name of the device for the x-axis.
+            y_name(str): The name of the device for the y-axis.
+            z_name(str): The name of the device for the z-axis.
+            x_entry(str): The name of the entry for the x-axis.
+            y_entry(str): The name of the entry for the y-axis.
+            z_entry(str): The name of the entry for the z-axis.
+            color(str): The color of the curve.
+            color_map_z(str): The color map to use for the z-axis.
+            label(str): The label of the curve.
+            validate(bool): If True, validate the device names and entries.
             row(int): The row coordinate of the widget in the figure. If not provided, the next empty row will be used.
             col(int): The column coordinate of the widget in the figure. If not provided, the next empty column will be used.
             config(dict): Additional configuration for the widget.
@@ -1139,17 +1143,6 @@ class BECImageShow(RPCBase):
             lock(bool): True to lock, False to unlock.
         """
 
-    @rpc_call
-    def plot(self, data_x: "list | np.ndarray", data_y: "list | np.ndarray", **kwargs):
-        """
-        Plot custom data on the plot widget. These data are not saved in config.
-
-        Args:
-            data_x(list|np.ndarray): x-axis data
-            data_y(list|np.ndarray): y-axis data
-            **kwargs: Keyword arguments for the plot.
-        """
-
     @rpc_call
     def remove(self):
         """
@@ -1429,7 +1422,7 @@ class BECDock(RPCBase):
 
     @property
     @rpc_call
-    def widget_list(self) -> "list":
+    def widget_list(self) -> "list[BECConnector]":
         """
         Get the widgets in the dock.
 
@@ -1550,7 +1543,7 @@ class BECDockArea(RPCBase, BECGuiClientMixin):
 
     @property
     @rpc_call
-    def panels(self) -> "dict":
+    def panels(self) -> "dict[str, BECDock]":
         """
         Get the docks in the dock area.
         Returns:

{bec_widgets-0.57.3 → bec_widgets-0.57.5}/bec_widgets/examples/jupyter_console/jupyter_console_window.py

@@ -97,14 +97,16 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
         self.w3 = self.figure[1, 0]
 
         # curves for w1
-        self.w1.add_curve_scan("samx", "samy", "bpm4i", pen_style="dash")
-        self.w1.add_curve_scan("samx", "samy", "bpm3a", pen_style="dash")
+        self.w1.plot(x_name="samx", y_name="samy", z_name="bpm4i")
+        self.w1.plot(x_name="samx", y_name="samy", z_name="bpm3a")
         self.c1 = self.w1.get_config()
 
     def _init_dock(self):
 
         self.d0 = self.dock.add_dock(name="dock_0")
         self.fig0 = self.d0.add_widget("BECFigure")
+        data = np.random.rand(10, 2)
+        self.fig0.plot(data, label="2d Data")
         self.fig0.image("eiger", vrange=(0, 100))
 
         self.d1 = self.dock.add_dock(name="dock_1", position="right")
@@ -114,7 +116,6 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
 
         self.d2 = self.dock.add_dock(name="dock_2", position="bottom")
         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("SpiralProgressBar", row=0, col=1)
         self.bar.set_diameter(200)

{bec_widgets-0.57.3 → bec_widgets-0.57.5}/bec_widgets/widgets/dock/dock.py

@@ -93,7 +93,7 @@ class BECDock(BECConnector, Dock):
             super().float()
 
     @property
-    def widget_list(self) -> list:
+    def widget_list(self) -> list[BECConnector]:
         """
         Get the widgets in the dock.
 
@@ -103,7 +103,7 @@ class BECDock(BECConnector, Dock):
         return self.widgets
 
     @widget_list.setter
-    def widget_list(self, value: list):
+    def widget_list(self, value: list[BECConnector]):
         self.widgets = value
 
     def hide_title_bar(self):
@@ -131,6 +131,7 @@ class BECDock(BECConnector, Dock):
         """
         self.parent_dock_area.docks[title] = self.parent_dock_area.docks.pop(self.name())
         self.setTitle(title)
+        self._name = title
 
     def get_widgets_positions(self) -> dict:
         """

{bec_widgets-0.57.3 → bec_widgets-0.57.5}/bec_widgets/widgets/dock/dock_area.py

@@ -61,7 +61,7 @@ class BECDockArea(BECConnector, DockArea):
             painter.drawText(self.rect(), Qt.AlignCenter, "Add docks using 'add_dock' method")
 
     @property
-    def panels(self) -> dict:
+    def panels(self) -> dict[str, BECDock]:
         """
         Get the docks in the dock area.
         Returns:
@@ -70,7 +70,7 @@ class BECDockArea(BECConnector, DockArea):
         return dict(self.docks)
 
     @panels.setter
-    def panels(self, value: dict):
+    def panels(self, value: dict[str, BECDock]):
         self.docks = WeakValueDictionary(value)
 
     @property