fix(rpc/client_utils): getoutput more transparent + error handling

bec_widgets/cli/client_utils.py

@@ -157,17 +157,24 @@ class BECFigureClientMixin:
         self.stderr_output.clear()
 
     def _get_output(self) -> str:
-        os.set_blocking(self._process.stdout.fileno(), False)
-        os.set_blocking(self._process.stderr.fileno(), False)
-        while self._process.poll() is None:
-            readylist, _, _ = select.select([self._process.stdout, self._process.stderr], [], [], 1)
-            if self._process.stdout in readylist:
-                # print("*"*10, self._process.stdout.read(1024), flush=True, end="")
-                self._process.stdout.read(1024)
-            if self._process.stderr in readylist:
-                # print("!"*10, self._process.stderr.read(1024), flush=True, end="", file=sys.stderr)
-                print(self._process.stderr.read(1024), flush=True, end="", file=sys.stderr)
-                self.stderr_output.append(self._process.stderr.read(1024))
+        try:
+            os.set_blocking(self._process.stdout.fileno(), False)
+            os.set_blocking(self._process.stderr.fileno(), False)
+            while self._process.poll() is None:
+                readylist, _, _ = select.select(
+                    [self._process.stdout, self._process.stderr], [], [], 1
+                )
+                if self._process.stdout in readylist:
+                    output = self._process.stdout.read(1024)
+                    if output:
+                        print(output, end="")
+                if self._process.stderr in readylist:
+                    error_output = self._process.stderr.read(1024)
+                    if error_output:
+                        print(error_output, end="", file=sys.stderr)
+                        self.stderr_output.append(error_output)
+        except Exception as e:
+            print(f"Error reading process output: {str(e)}")
 
 
 class RPCResponseTimeoutError(Exception):

bec_widgets/cli/rpc_register.py

@@ -1,8 +1,14 @@
 from threading import Lock
 from weakref import WeakValueDictionary
 
+from qtpy.QtCore import QObject
+
 
 class RPCRegister:
+    """
+    A singleton class that keeps track of all the RPC objects registered in the system for CLI usage.
+    """
+
     _instance = None
     _initialized = False
     _lock = Lock()
@@ -19,27 +25,52 @@ class RPCRegister:
         self._rpc_register = WeakValueDictionary()
         self._initialized = True
 
-    def add_rpc(self, rpc):
+    def add_rpc(self, rpc: QObject):
+        """
+        Add an RPC object to the register.
+        Args:
+            rpc(QObject): The RPC object to be added to the register.
+        """
         if not hasattr(rpc, "gui_id"):
             raise ValueError("RPC object must have a 'gui_id' attribute.")
         self._rpc_register[rpc.gui_id] = rpc
 
-    def remove_rpc(self, rpc):
+    def remove_rpc(self, rpc: str):
+        """
+        Remove an RPC object from the register.
+        Args:
+            rpc(str): The RPC object to be removed from the register.
+        """
         if not hasattr(rpc, "gui_id"):
             raise ValueError(f"RPC object {rpc} must have a 'gui_id' attribute.")
         self._rpc_register.pop(rpc.gui_id, None)
 
-    def get_rpc_by_id(self, gui_id):
+    def get_rpc_by_id(self, gui_id: str) -> QObject:
+        """
+        Get an RPC object by its ID.
+        Args:
+            gui_id(str): The ID of the RPC object to be retrieved.
+
+        Returns:
+            QObject: The RPC object with the given ID.
+        """
         rpc_object = self._rpc_register.get(gui_id, None)
-        print(f"get rpc by id: {rpc_object}")
         return rpc_object
 
-    def list_all_connections(self):
+    def list_all_connections(self) -> dict:
+        """
+        List all the registered RPC objects.
+        Returns:
+            dict: A dictionary containing all the registered RPC objects.
+        """
         with self._lock:
             connections = dict(self._rpc_register)
         return connections
 
     @classmethod
     def reset_singleton(cls):
+        """
+        Reset the singleton instance.
+        """
         cls._instance = None
         cls._initialized = False

bec_widgets/cli/server.py

@@ -37,10 +37,10 @@ class BECWidgetsCLIServer:
     def on_rpc_update(self, msg: dict, metadata: dict):
         request_id = metadata.get("request_id")
         try:
+            obj = self.get_object_from_config(msg["parameter"])
             method = msg["action"]
             args = msg["parameter"].get("args", [])
             kwargs = msg["parameter"].get("kwargs", {})
-            obj = self.get_object_from_config(msg["parameter"])
             res = self.run_rpc(obj, method, args, kwargs)
         except Exception as e:
             print(e)

bec_widgets/widgets/figure/figure.py

@@ -658,7 +658,6 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
             self._reindex_grid()
             if widget_id in self.config.widgets:
                 self.config.widgets.pop(widget_id)
-            print(f"Removed widget {widget_id}.")
         else:
             raise ValueError(f"Widget with ID '{widget_id}' does not exist.")
 
@@ -701,7 +700,6 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
 
     def _reindex_grid(self):
         """Reindex the grid to remove empty rows and columns."""
-        print(f"old grid: {self.grid}")
         new_grid = []
         for row in self.grid:
             new_row = [widget for widget in row if widget is not None]