bec-widgets 1.25.1__py3-none-any.whl → 2.0.1__py3-none-any.whl

bec_widgets/widgets/containers/dock/dock.py

@@ -1,25 +1,33 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any, Literal, Optional
+from typing import TYPE_CHECKING, Any, Literal, Optional, cast
 
+from bec_lib.logger import bec_logger
 from pydantic import Field
 from pyqtgraph.dockarea import Dock, DockLabel
 from qtpy import QtCore, QtGui
 
+from bec_widgets.cli.client_utils import IGNORE_WIDGETS
 from bec_widgets.cli.rpc.rpc_widget_handler import widget_handler
 from bec_widgets.utils import ConnectionConfig, GridLayoutManager
 from bec_widgets.utils.bec_widget import BECWidget
+from bec_widgets.utils.container_utils import WidgetContainerUtils
+from bec_widgets.utils.error_popups import SafeSlot
 
-if TYPE_CHECKING:
+logger = bec_logger.logger
+
+if TYPE_CHECKING:  # pragma: no cover
     from qtpy.QtWidgets import QWidget
 
+    from bec_widgets.widgets.containers.dock.dock_area import BECDockArea
+
 
 class DockConfig(ConnectionConfig):
     widgets: dict[str, Any] = Field({}, description="The widgets in the dock.")
     position: Literal["bottom", "top", "left", "right", "above", "below"] = Field(
         "bottom", description="The position of the dock."
     )
-    parent_dock_area: Optional[str] = Field(
+    parent_dock_area: Optional[str] | None = Field(
         None, description="The GUI ID of parent dock area of the dock."
     )
 
@@ -103,16 +111,17 @@ class BECDock(BECWidget, Dock):
     ICON_NAME = "widgets"
     USER_ACCESS = [
         "_config_dict",
-        "_rpc_id",
-        "widget_list",
+        "element_list",
+        "elements",
+        "new",
+        "show",
+        "hide",
         "show_title_bar",
-        "hide_title_bar",
-        "get_widgets_positions",
         "set_title",
-        "add_widget",
-        "list_eligible_widgets",
-        "move_widget",
-        "remove_widget",
+        "hide_title_bar",
+        "available_widgets",
+        "delete",
+        "delete_all",
         "remove",
         "attach",
         "detach",
@@ -121,29 +130,38 @@ class BECDock(BECWidget, Dock):
     def __init__(
         self,
         parent: QWidget | None = None,
-        parent_dock_area: QWidget | None = None,
+        parent_dock_area: BECDockArea | None = None,
         config: DockConfig | None = None,
         name: str | None = None,
+        object_name: str | None = None,
         client=None,
         gui_id: str | None = None,
         closable: bool = True,
         **kwargs,
     ) -> None:
+
         if config is None:
             config = DockConfig(
-                widget_class=self.__class__.__name__, parent_dock_area=parent_dock_area.gui_id
+                widget_class=self.__class__.__name__,
+                parent_dock_area=parent_dock_area.gui_id if parent_dock_area else None,
             )
         else:
             if isinstance(config, dict):
                 config = DockConfig(**config)
             self.config = config
-        super().__init__(client=client, config=config, gui_id=gui_id)
         label = CustomDockLabel(text=name, closable=closable)
-        Dock.__init__(self, name=name, label=label, **kwargs)
-        # Dock.__init__(self, name=name, **kwargs)
+        super().__init__(
+            parent=parent_dock_area,
+            name=name,
+            object_name=object_name,
+            client=client,
+            gui_id=gui_id,
+            config=config,
+            label=label,
+            **kwargs,
+        )
 
         self.parent_dock_area = parent_dock_area
-
         # Layout Manager
         self.layout_manager = GridLayoutManager(self.layout)
 
@@ -173,7 +191,18 @@ class BECDock(BECWidget, Dock):
             super().float()
 
     @property
-    def widget_list(self) -> list[BECWidget]:
+    def elements(self) -> dict[str, BECWidget]:
+        """
+        Get the widgets in the dock.
+
+        Returns:
+            widgets(dict): The widgets in the dock.
+        """
+        # pylint: disable=protected-access
+        return dict((widget.object_name, widget) for widget in self.element_list)
+
+    @property
+    def element_list(self) -> list[BECWidget]:
         """
         Get the widgets in the dock.
 
@@ -182,10 +211,6 @@ class BECDock(BECWidget, Dock):
         """
         return self.widgets
 
-    @widget_list.setter
-    def widget_list(self, value: list[BECWidget]):
-        self.widgets = value
-
     def hide_title_bar(self):
         """
         Hide the title bar of the dock.
@@ -194,6 +219,20 @@ class BECDock(BECWidget, Dock):
         self.label.hide()
         self.labelHidden = True
 
+    def show(self):
+        """
+        Show the dock.
+        """
+        super().show()
+        self.show_title_bar()
+
+    def hide(self):
+        """
+        Hide the dock.
+        """
+        self.hide_title_bar()
+        super().hide()
+
     def show_title_bar(self):
         """
         Hide the title bar of the dock.
@@ -211,7 +250,6 @@ class BECDock(BECWidget, Dock):
         """
         self.orig_area.docks[title] = self.orig_area.docks.pop(self.name())
         self.setTitle(title)
-        self._name = title
 
     def get_widgets_positions(self) -> dict:
         """
@@ -222,7 +260,7 @@ class BECDock(BECWidget, Dock):
         """
         return self.layout_manager.get_widgets_positions()
 
-    def list_eligible_widgets(
+    def available_widgets(
         self,
     ) -> list:  # TODO can be moved to some util mixin like container class for rpc widgets
         """
@@ -233,42 +271,69 @@ class BECDock(BECWidget, Dock):
         """
         return list(widget_handler.widget_classes.keys())
 
-    def add_widget(
+    def _get_list_of_widget_name_of_parent_dock_area(self) -> list[str]:
+        if (docks := self.parent_dock_area.panel_list) is None:
+            return []
+        widgets = []
+        for dock in docks:
+            widgets.extend(dock.elements.keys())
+        return widgets
+
+    @SafeSlot(popup_error=True)
+    def new(
         self,
         widget: BECWidget | str,
-        row=None,
-        col=0,
-        rowspan=1,
-        colspan=1,
+        name: str | None = None,
+        row: int | None = None,
+        col: int = 0,
+        rowspan: int = 1,
+        colspan: int = 1,
         shift: Literal["down", "up", "left", "right"] = "down",
     ) -> BECWidget:
         """
         Add a widget to the dock.
 
         Args:
-            widget(QWidget): The widget to add.
+            widget(QWidget): The widget to add. It can not be BECDock or BECDockArea.
+            name(str): The name of the widget.
             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 name is not None:
+            if not WidgetContainerUtils.has_name_valid_chars(name):
+                raise ValueError(
+                    f"Name {name} contains invalid characters. "
+                    f"Only alphanumeric characters and underscores are allowed."
+                )
+
         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)
 
+        # Check that Widget is not BECDock or BECDockArea
+        widget_class_name = widget if isinstance(widget, str) else widget.__class__.__name__
+        if widget_class_name in IGNORE_WIDGETS:
+            raise ValueError(f"Widget {widget} can not be added to dock.")
+
         if isinstance(widget, str):
-            widget = widget_handler.create_widget(widget)
+            widget = cast(
+                BECWidget,
+                widget_handler.create_widget(
+                    widget_type=widget, object_name=name, parent_dock=self, parent=self
+                ),
+            )
         else:
-            widget = widget
+            widget.object_name = name
 
         self.addWidget(widget, row=row, col=col, rowspan=rowspan, colspan=colspan)
-
         if hasattr(widget, "config"):
-            self.config.widgets[widget.gui_id] = widget.config
-
+            widget.config.gui_id = widget.gui_id
+            self.config.widgets[widget.object_name] = widget.config
         return widget
 
     def move_widget(self, widget: QWidget, new_row: int, new_col: int):
@@ -294,36 +359,68 @@ class BECDock(BECWidget, Dock):
         """
         self.float()
 
-    def remove_widget(self, widget_rpc_id: str):
+    def remove(self):
+        """
+        Remove the dock from the parent dock area.
+        """
+        self.parent_dock_area.delete(self.object_name)
+
+    def delete(self, widget_name: str) -> None:
         """
         Remove a widget from the dock.
 
         Args:
-            widget_rpc_id(str): The ID of the widget to remove.
+            widget_name(str): Delete the widget with the given name.
         """
-        widget = self.rpc_register.get_rpc_by_id(widget_rpc_id)
+        # pylint: disable=protected-access
+        widgets = [widget for widget in self.widgets if widget.object_name == widget_name]
+        if len(widgets) == 0:
+            logger.warning(
+                f"Widget with name {widget_name} not found in dock {self.name()}. "
+                f"Checking if gui_id was passed as widget_name."
+            )
+            # Try to find the widget in the RPC register, maybe the gui_id was passed as widget_name
+            widget = self.rpc_register.get_rpc_by_id(widget_name)
+            if widget is None:
+                logger.warning(
+                    f"Widget not found for name or gui_id: {widget_name} in dock {self.name()}"
+                )
+                return
+        else:
+            widget = widgets[0]
         self.layout.removeWidget(widget)
-        self.config.widgets.pop(widget_rpc_id, None)
+        self.config.widgets.pop(widget.object_name, None)
+        if widget in self.widgets:
+            self.widgets.remove(widget)
         widget.close()
 
-    def remove(self):
+    def delete_all(self):
         """
-        Remove the dock from the parent dock area.
+        Remove all widgets from the dock.
         """
-        # self.cleanup()
-        self.parent_dock_area.remove_dock(self.name())
+        for widget in self.widgets:
+            self.delete(widget.object_name)
 
     def cleanup(self):
         """
         Clean up the dock, including all its widgets.
         """
-        for widget in self.widgets:
-            if hasattr(widget, "cleanup"):
-                widget.cleanup()
+        # # FIXME Cleanup might be called twice
+        try:
+            logger.info(f"Cleaning up dock {self.name()}")
+            self.label.close()
+            self.label.deleteLater()
+        except Exception as e:
+            logger.error(f"Error while closing dock label: {e}")
+
+        # Remove the dock from the parent dock area
+        if self.parent_dock_area:
+            self.parent_dock_area.dock_area.docks.pop(self.name(), None)
+            self.parent_dock_area.config.docks.pop(self.name(), None)
+        self.delete_all()
         self.widgets.clear()
-        self.label.close()
-        self.label.deleteLater()
         super().cleanup()
+        self.deleteLater()
 
     def close(self):
         """
@@ -332,4 +429,15 @@ class BECDock(BECWidget, Dock):
         """
         self.cleanup()
         super().close()
-        self.parent_dock_area.dock_area.docks.pop(self.name(), None)
+
+
+if __name__ == "__main__":  # pragma: no cover
+    import sys
+
+    from qtpy.QtWidgets import QApplication
+
+    app = QApplication([])
+    dock = BECDock(name="dock")
+    dock.show()
+    app.exec_()
+    sys.exit(app.exec_())