bec-widgets 1.25.0__py3-none-any.whl → 2.0.0__py3-none-any.whl

bec_widgets/cli/generate_cli.py

@@ -2,17 +2,22 @@
 from __future__ import annotations
 
 import argparse
+import importlib
 import inspect
 import os
 import sys
+from pathlib import Path
 
 import black
 import isort
+from bec_lib.logger import bec_logger
 from qtpy.QtCore import Property as QtProperty
 
-from bec_widgets.utils.generate_designer_plugin import DesignerPluginGenerator
+from bec_widgets.utils.generate_designer_plugin import DesignerPluginGenerator, plugin_filenames
 from bec_widgets.utils.plugin_utils import BECClassContainer, get_custom_classes
 
+logger = bec_logger.logger
+
 if sys.version_info >= (3, 11):
     from typing import get_overloads
 else:
@@ -29,13 +34,28 @@ else:
 
 
 class ClientGenerator:
-    def __init__(self):
-        self.header = """# This file was automatically generated by generate_cli.py\n
+    def __init__(self, base=False):
+        self._base = base
+        base_imports = (
+            """import enum
+import inspect
+import traceback
+from functools import reduce
+from typing import Literal, Optional
+"""
+            if self._base
+            else "\n"
+        )
+        self.header = f"""# This file was automatically generated by generate_cli.py
+# type: ignore \n
 from __future__ import annotations
-import enum
-from typing import Literal, Optional, overload
+{base_imports}
+from bec_lib.logger import bec_logger
 
 from bec_widgets.cli.rpc.rpc_base import RPCBase, rpc_call
+{"from bec_widgets.utils.bec_plugin_helper import get_all_plugin_widgets, get_plugin_client_module" if self._base else ""}
+
+logger = bec_logger.logger
 
 # pylint: skip-file"""
 
@@ -62,6 +82,7 @@ from bec_widgets.cli.rpc.rpc_base import RPCBase, rpc_call
 
         self.write_client_enum(rpc_top_level_classes)
         for cls in connector_classes:
+            logger.debug(f"generating RPC client class for {cls.__name__}")
             self.content += "\n\n"
             self.generate_content_for_class(cls)
 
@@ -69,14 +90,50 @@ from bec_widgets.cli.rpc.rpc_base import RPCBase, rpc_call
         """
         Write the client enum to the content.
         """
+        if self._base:
+            self.content += """
+class _WidgetsEnumType(str, enum.Enum):
+    \"\"\" Enum for the available widgets, to be generated programatically  \"\"\"
+    ...
+    """
+
         self.content += """
-class Widgets(str, enum.Enum):
-    \"\"\"
-    Enum for the available widgets.
-    \"\"\"
+
+_Widgets = {
     """
         for cls in published_classes:
-            self.content += f'{cls.__name__} = "{cls.__name__}"\n    '
+            self.content += f'"{cls.__name__}": "{cls.__name__}",\n    '
+
+        self.content += """}
+"""
+        if self._base:
+            self.content += """
+
+try:
+    _plugin_widgets = get_all_plugin_widgets()
+    plugin_client = get_plugin_client_module()
+    Widgets = _WidgetsEnumType("Widgets", {name: name for name in _plugin_widgets} | _Widgets)
+
+    if (_overlap := _Widgets.keys() & _plugin_widgets.keys()) != set():
+        for _widget in _overlap:
+            logger.warning(f"Detected duplicate widget {_widget} in plugin repo file: {inspect.getfile(_plugin_widgets[_widget])} !")
+    for plugin_name, plugin_class in inspect.getmembers(plugin_client, inspect.isclass):
+        if issubclass(plugin_class, RPCBase) and plugin_class is not RPCBase:
+            if plugin_name in globals():
+                conflicting_file = (
+                    inspect.getfile(_plugin_widgets[plugin_name])
+                    if plugin_name in _plugin_widgets
+                    else f"{plugin_client}"
+                )
+                logger.warning(
+                    f"Plugin widget {plugin_name} from {conflicting_file} conflicts with a built-in class!"
+                )
+                continue
+            if plugin_name not in _overlap:
+                globals()[plugin_name] = plugin_class
+except ImportError as e:
+    logger.error(f"Failed loading plugins: \\n{reduce(add, traceback.format_exception(e))}")
+"""
 
     def generate_content_for_class(self, cls):
         """
@@ -95,9 +152,21 @@ class {class_name}(RPCBase):"""
             self.content += f"""
 class {class_name}(RPCBase):"""
 
+        if cls.__doc__:
+            # We only want the first line of the docstring
+            # But skip the first line if it's a blank line
+            first_line = cls.__doc__.split("\n")[0]
+            if first_line:
+                class_docs = first_line
+            else:
+                class_docs = cls.__doc__.split("\n")[1]
+            self.content += f"""
+    \"\"\"{class_docs}\"\"\"
+    """
         if not cls.USER_ACCESS:
             self.content += """...
     """
+
         for method in cls.USER_ACCESS:
             is_property_setter = False
             obj = getattr(cls, method, None)
@@ -176,41 +245,78 @@ def main():
     """
 
     parser = argparse.ArgumentParser(description="Auto-generate the client for RPC widgets")
-    parser.add_argument("--core", action="store_true", help="Whether to generate the core client")
+    parser.add_argument(
+        "--target",
+        action="store",
+        type=str,
+        help="Which package to generate plugin files for. Should be installed in the local environment (example: my_plugin_repo)",
+    )
 
     args = parser.parse_args()
+    if args.target is None:
+        logger.error(
+            "You must provide a target - for safety, the default of running this on bec_widgets core has been removed. To generate the client for bec_widgets, run `bw-generate-cli --target bec_widgets`"
+        )
+        return
 
-    if args.core:
-        current_path = os.path.dirname(__file__)
-        client_path = os.path.join(current_path, "client.py")
+    logger.info(f"BEC Widget code generation tool started with args: {args}")
 
-        rpc_classes = get_custom_classes("bec_widgets")
+    client_subdir = "cli" if args.target == "bec_widgets" else "widgets"
+    module_name = "bec_widgets" if args.target == "bec_widgets" else f"{args.target}.bec_widgets"
 
-        generator = ClientGenerator()
-        generator.generate_client(rpc_classes)
-        generator.write(client_path)
+    try:
+        module = importlib.import_module(module_name)
+        assert module.__file__ is not None
+        module_file = Path(module.__file__)
+        module_dir = module_file.parent if module_file.is_file() else module_file
+    except Exception as e:
+        logger.error(f"Failed to load module {module_name} for code generation: {e}")
+        return
 
-        for cls in rpc_classes.plugins:
-            plugin = DesignerPluginGenerator(cls)
-            if not hasattr(plugin, "info"):
-                continue
+    client_path = module_dir / client_subdir / "client.py"
 
-            # if the class directory already has a register, plugin and pyproject file, skip
-            if os.path.exists(
-                os.path.join(plugin.info.base_path, f"register_{plugin.info.plugin_name_snake}.py")
-            ):
-                continue
-            if os.path.exists(
-                os.path.join(plugin.info.base_path, f"{plugin.info.plugin_name_snake}_plugin.py")
-            ):
-                continue
-            if os.path.exists(
-                os.path.join(plugin.info.base_path, f"{plugin.info.plugin_name_snake}.pyproject")
-            ):
-                continue
-            plugin.run()
+    rpc_classes = get_custom_classes(module_name)
+    logger.info(f"Obtained classes with RPC objects: {rpc_classes!r}")
+
+    generator = ClientGenerator(base=module_name == "bec_widgets")
+    logger.info(f"Generating client file at {client_path}")
+    generator.generate_client(rpc_classes)
+    generator.write(str(client_path))
+
+    if module_name != "bec_widgets":
+        non_overwrite_classes = list(clsinfo.name for clsinfo in get_custom_classes("bec_widgets"))
+        logger.info(
+            f"Not writing plugins which would conflict with builtin classes: {non_overwrite_classes}"
+        )
+    else:
+        non_overwrite_classes = []
+
+    for cls in rpc_classes.plugins:
+        logger.info(f"Writing bec-designer plugin files for {cls.__name__}...")
+
+        if cls.__name__ in non_overwrite_classes:
+            logger.error(
+                f"Not writing plugin files for {cls.__name__} because a built-in widget with that name exists"
+            )
+
+        plugin = DesignerPluginGenerator(cls)
+        if not hasattr(plugin, "info"):
+            continue
+
+        def _exists(file: str):
+            return os.path.exists(os.path.join(plugin.info.base_path, file))
+
+        if any(_exists(file) for file in plugin_filenames(plugin.info.plugin_name_snake)):
+            logger.debug(
+                f"Skipping generation of extra plugin files for {plugin.info.plugin_name_snake} - at least one file out of 'plugin.py', 'pyproject', and 'register_{plugin.info.plugin_name_snake}.py' already exists."
+            )
+            continue
+
+        plugin.run()
 
 
 if __name__ == "__main__":  # pragma: no cover
-    sys.argv = ["generate_cli.py", "--core"]
+    import sys
+
+    sys.argv = ["bw-generate-cli", "--target", "csaxs_bec"]
     main()

bec_widgets/cli/rpc/rpc_base.py

@@ -1,24 +1,28 @@
 from __future__ import annotations
 
+import inspect
 import threading
 import uuid
 from functools import wraps
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, cast
 
 from bec_lib.client import BECClient
 from bec_lib.endpoints import MessageEndpoints
 from bec_lib.utils.import_utils import lazy_import, lazy_import_from
 
-import bec_widgets.cli.client as client
-
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     from bec_lib import messages
     from bec_lib.connector import MessageObject
+
+    import bec_widgets.cli.client as client
+    from bec_widgets.cli.client_utils import BECGuiClient
 else:
+    client = lazy_import("bec_widgets.cli.client")  # avoid circular import
     messages = lazy_import("bec_lib.messages")
-    # from bec_lib.connector import MessageObject
     MessageObject = lazy_import_from("bec_lib.connector", ("MessageObject",))
 
+# pylint: disable=protected-access
+
 
 def rpc_call(func):
     """
@@ -35,6 +39,14 @@ def rpc_call(func):
     def wrapper(self, *args, **kwargs):
         # we could rely on a strict type check here, but this is more flexible
         # moreover, it would anyway crash for objects...
+        caller_frame = inspect.currentframe().f_back  # type: ignore
+        while caller_frame:
+            if "jedi" in caller_frame.f_globals:
+                # Jedi module is present, likely tab completion
+                # Do not run the RPC call
+                return None  # func(*args, **kwargs)
+            caller_frame = caller_frame.f_back
+
         out = []
         for arg in args:
             if hasattr(arg, "name"):
@@ -44,7 +56,7 @@ def rpc_call(func):
         for key, val in kwargs.items():
             if hasattr(val, "name"):
                 kwargs[key] = val.name
-        if not self.gui_is_alive():
+        if not self._root._gui_is_alive():
             raise RuntimeError("GUI is not alive")
         return self._run_rpc(func.__name__, *args, **kwargs)
 
@@ -60,24 +72,96 @@ class RPCResponseTimeoutError(Exception):
         )
 
 
+class DeletedWidgetError(Exception): ...
+
+
+def check_for_deleted_widget(func):
+    @wraps(func)
+    def wrapper(self, *args, **kwargs):
+        if self._gui_id not in self._registry:
+            raise DeletedWidgetError(f"Widget with gui_id {self._gui_id} has been deleted")
+        return func(self, *args, **kwargs)
+
+    return wrapper
+
+
+class RPCReference:
+    def __init__(self, registry: dict, gui_id: str) -> None:
+        self._registry = registry
+        self._gui_id = gui_id
+        self.object_name = self._registry[self._gui_id].object_name
+
+    @check_for_deleted_widget
+    def __getattr__(self, name):
+        if name in ["_registry", "_gui_id", "_is_deleted", "object_name"]:
+            return super().__getattribute__(name)
+        return self._registry[self._gui_id].__getattribute__(name)
+
+    def __setattr__(self, name, value):
+        if name in ["_registry", "_gui_id", "_is_deleted", "object_name"]:
+            return super().__setattr__(name, value)
+        if self._gui_id not in self._registry:
+            raise DeletedWidgetError(f"Widget with gui_id {self._gui_id} has been deleted")
+        self._registry[self._gui_id].__setattr__(name, value)
+
+    def __repr__(self):
+        if self._gui_id not in self._registry:
+            return f"<Deleted widget with gui_id {self._gui_id}>"
+        return self._registry[self._gui_id].__repr__()
+
+    def __str__(self):
+        if self._gui_id not in self._registry:
+            return f"<Deleted widget with gui_id {self._gui_id}>"
+        return self._registry[self._gui_id].__str__()
+
+    def __dir__(self):
+        if self._gui_id not in self._registry:
+            return []
+        return self._registry[self._gui_id].__dir__()
+
+    def _is_deleted(self) -> bool:
+        return self._gui_id not in self._registry
+
+
 class RPCBase:
-    def __init__(self, gui_id: str = None, config: dict = None, parent=None) -> None:
+    def __init__(
+        self,
+        gui_id: str | None = None,
+        config: dict | None = None,
+        object_name: str | None = None,
+        parent=None,
+        **kwargs,
+    ) -> None:
         self._client = BECClient()  # BECClient is a singleton; here, we simply get the instance
         self._config = config if config is not None else {}
         self._gui_id = gui_id if gui_id is not None else str(uuid.uuid4())[:5]
+        self.object_name = object_name if object_name is not None else str(uuid.uuid4())[:5]
         self._parent = parent
         self._msg_wait_event = threading.Event()
         self._rpc_response = None
         super().__init__()
-        # print(f"RPCBase: {self._gui_id}")
+        self._rpc_references: dict[str, str] = {}
 
     def __repr__(self):
         type_ = type(self)
         qualname = type_.__qualname__
-        return f"<{qualname} object at {hex(id(self))}>"
+        return f"<{qualname} with name: {self.object_name}>"
+
+    def remove(self):
+        """
+        Remove the widget.
+        """
+        obj = self._root._server_registry.get(self._gui_id)
+        if obj is None:
+            raise ValueError(f"Widget {self._gui_id} not found.")
+        if proxy := obj.get("container_proxy"):
+            assert isinstance(proxy, str)
+            self._run_rpc("remove", gui_id=proxy)
+            return
+        self._run_rpc("remove")
 
     @property
-    def _root(self):
+    def _root(self) -> BECGuiClient:
         """
         Get the root widget. This is the BECFigure widget that holds
         the anchor gui_id.
@@ -86,9 +170,17 @@ class RPCBase:
         # pylint: disable=protected-access
         while parent._parent is not None:
             parent = parent._parent
-        return parent
+        return parent  # type: ignore
 
-    def _run_rpc(self, method, *args, wait_for_rpc_response=True, timeout=3, **kwargs):
+    def _run_rpc(
+        self,
+        method,
+        *args,
+        wait_for_rpc_response=True,
+        timeout=5,
+        gui_id: str | None = None,
+        **kwargs,
+    ) -> Any:
         """
         Run the RPC call.
 
@@ -96,6 +188,8 @@ class RPCBase:
             method: The method to call.
             args: The arguments to pass to the method.
             wait_for_rpc_response: Whether to wait for the RPC response.
+            timeout: The timeout for the RPC response.
+            gui_id: The GUI ID to use for the RPC call. If None, the default GUI ID is used.
             kwargs: The keyword arguments to pass to the method.
 
         Returns:
@@ -104,10 +198,9 @@ class RPCBase:
         request_id = str(uuid.uuid4())
         rpc_msg = messages.GUIInstructionMessage(
             action=method,
-            parameter={"args": args, "kwargs": kwargs, "gui_id": self._gui_id},
+            parameter={"args": args, "kwargs": kwargs, "gui_id": gui_id or self._gui_id},
             metadata={"request_id": request_id},
         )
-
         # pylint: disable=protected-access
         receiver = self._root._gui_id
         if wait_for_rpc_response:
@@ -131,7 +224,11 @@ class RPCBase:
                 self._client.connector.unregister(
                     MessageEndpoints.gui_instruction_response(request_id), cb=self._on_rpc_response
                 )
-            # get class name
+
+            # we can assume that the response is a RequestResponseMessage, updated by
+            # the _on_rpc_response method
+            assert isinstance(self._rpc_response, messages.RequestResponseMessage)
+
             if not self._rpc_response.accepted:
                 raise ValueError(self._rpc_response.message["error"])
             msg_result = self._rpc_response.message.get("result")
@@ -139,10 +236,10 @@ class RPCBase:
             return self._create_widget_from_msg_result(msg_result)
 
     @staticmethod
-    def _on_rpc_response(msg: MessageObject, parent: RPCBase) -> None:
-        msg = msg.value
-        parent._msg_wait_event.set()
+    def _on_rpc_response(msg_obj: MessageObject, parent: RPCBase) -> None:
+        msg = cast(messages.RequestResponseMessage, msg_obj.value)
         parent._rpc_response = msg
+        parent._msg_wait_event.set()
 
     def _create_widget_from_msg_result(self, msg_result):
         if msg_result is None:
@@ -161,11 +258,21 @@ class RPCBase:
                 return msg_result
 
             cls = getattr(client, cls)
-            # print(msg_result)
-            return cls(parent=self, **msg_result)
+            # The namespace of the object will be updated dynamically on the client side
+            # Therefore it is important to check if the object is already in the registry
+            # If yes, we return the reference to the object, otherwise we create a new object
+            # pylint: disable=protected-access
+            if msg_result["gui_id"] in self._root._ipython_registry:
+                return RPCReference(self._root._ipython_registry, msg_result["gui_id"])
+            ret = cls(parent=self, **msg_result)
+            self._root._ipython_registry[ret._gui_id] = ret
+            self._refresh_references()
+            obj = RPCReference(self._root._ipython_registry, ret._gui_id)
+            return obj
+            # return ret
         return msg_result
 
-    def gui_is_alive(self):
+    def _gui_is_alive(self):
         """
         Check if the GUI is alive.
         """
@@ -175,3 +282,27 @@ class RPCBase:
         if heart.status == messages.BECStatus.RUNNING:
             return True
         return False
+
+    def _refresh_references(self):
+        """
+        Refresh the references.
+        """
+        with self._root._lock:
+            references = {}
+            for key, val in self._root._server_registry.items():
+                parent_id = val["config"].get("parent_id")
+                if parent_id == self._gui_id:
+                    references[key] = {
+                        "gui_id": val["config"]["gui_id"],
+                        "object_name": val["object_name"],
+                    }
+            removed_references = set(self._rpc_references.keys()) - set(references.keys())
+            for key in removed_references:
+                delattr(self, self._rpc_references[key]["object_name"])
+            self._rpc_references = references
+            for key, val in references.items():
+                setattr(
+                    self,
+                    val["object_name"],
+                    RPCReference(self._root._ipython_registry, val["gui_id"]),
+                )