bec-widgets 0.117.0__tar.gz → 0.117.1__tar.gz

{bec_widgets-0.117.0 → bec_widgets-0.117.1}/CHANGELOG.md

@@ -1,6 +1,19 @@
 # CHANGELOG
 
 
+## v0.117.1 (2024-10-11)
+
+### Fixes
+
+* fix(FPS): qtimer cleanup leaking ([`3a22392`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3a2239278075de7489ad10a58c31d7d89715e221))
+
+### Unknown
+
+* feature(vscode): added support for vscode instructions ([`f5f1f6c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f5f1f6c304b890dc162e8653005233bce4ea82e4))
+
+* feature(vscode): support for controlling vscode from widgets ([`9238679`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/923867947f62db026ac0378c30ef62c883596058))
+
+
 ## v0.117.0 (2024-10-11)
 
 ### Features
@@ -159,18 +172,3 @@ Fixes #361, do not try to change x axis when not permitted ([`efa2763`](https://
 ### Features
 
 * feat(accent colors): added helper function to get all accent colors ([`84a59f7`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/84a59f70eed6d8a3c3aeeabc77a5f9ea4e864f61))
-
-### Fixes
-
-* fix(theme): fixed theme access for themecontainer ([`de303f0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/de303f0227fc9d3a74a0410f1e7999ac5132273c))
-
-
-## v0.108.0 (2024-09-06)
-
-### Documentation
-
-* docs(progressbar): added docs ([`7d07cea`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7d07cea946f9c884477b01bebfb60b332ff09e0a))
-
-### Features
-
-* feat(progressbar): added bec progressbar ([`f6d1d0b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f6d1d0bbe3ba30a3b7291cd36a1f7f8e6bd5b895))

{bec_widgets-0.117.0 → bec_widgets-0.117.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.117.0
+Version: 0.117.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.117.0 → bec_widgets-0.117.1}/bec_widgets/widgets/figure/plots/plot_base.py

@@ -452,13 +452,14 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
 
             self.fps_monitor.sigFpsUpdate.connect(self.update_fps_label)
 
-    def unhook_fps_monitor(self):
+    def unhook_fps_monitor(self, delete_label=True):
         """Unhook the FPS monitor from the plot."""
         if self.fps_monitor is not None:
             # Remove Monitor
             self.fps_monitor.cleanup()
             self.fps_monitor.deleteLater()
             self.fps_monitor = None
+        if self.fps_label is not None and delete_label:
             # Remove Label
             self.removeItem(self.fps_label)
             self.fps_label.deleteLater()
@@ -490,6 +491,7 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
     def cleanup_pyqtgraph(self):
         """Cleanup pyqtgraph items."""
         self.unhook_crosshair()
+        self.unhook_fps_monitor(delete_label=False)
         self.tick_item.cleanup()
         self.arrow_item.cleanup()
         item = self.plot_item

bec_widgets-0.117.1/bec_widgets/widgets/vscode/vscode.py

@@ -0,0 +1,203 @@
+import os
+import select
+import shlex
+import signal
+import socket
+import subprocess
+import sys
+from typing import Literal
+
+from pydantic import BaseModel
+from qtpy.QtCore import Signal, Slot
+
+from bec_widgets.widgets.website.website import WebsiteWidget
+
+
+class VSCodeInstructionMessage(BaseModel):
+    command: Literal["open", "write", "close", "zenMode", "save", "new", "setCursor"]
+    content: str = ""
+
+
+def get_free_port():
+    """
+    Get a free port on the local machine.
+
+    Returns:
+        int: The free port number
+    """
+    sock = socket.socket()
+    sock.bind(("", 0))
+    port = sock.getsockname()[1]
+    sock.close()
+    return port
+
+
+class VSCodeEditor(WebsiteWidget):
+    """
+    A widget to display the VSCode editor.
+    """
+
+    file_saved = Signal(str)
+
+    token = "bec"
+    host = "127.0.0.1"
+
+    USER_ACCESS = []
+    ICON_NAME = "developer_mode_tv"
+
+    def __init__(self, parent=None, config=None, client=None, gui_id=None):
+
+        self.process = None
+        self.port = get_free_port()
+        self._url = f"http://{self.host}:{self.port}?tkn={self.token}"
+        super().__init__(parent=parent, config=config, client=client, gui_id=gui_id)
+        self.start_server()
+        self.bec_dispatcher.connect_slot(self.on_vscode_event, f"vscode-events/{self.gui_id}")
+
+    def start_server(self):
+        """
+        Start the server.
+
+        This method starts the server for the VSCode editor in a subprocess.
+        """
+
+        env = os.environ.copy()
+        env["BEC_Widgets_GUIID"] = self.gui_id
+        env["BEC_REDIS_HOST"] = self.client.connector.host
+        cmd = shlex.split(
+            f"code serve-web --port {self.port} --connection-token={self.token} --accept-server-license-terms"
+        )
+        self.process = subprocess.Popen(
+            cmd,
+            text=True,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.DEVNULL,
+            preexec_fn=os.setsid,
+            env=env,
+        )
+
+        os.set_blocking(self.process.stdout.fileno(), False)
+        while self.process.poll() is None:
+            readylist, _, _ = select.select([self.process.stdout], [], [], 1)
+            if self.process.stdout in readylist:
+                output = self.process.stdout.read(1024)
+                if output and f"available at {self._url}" in output:
+                    break
+        self.set_url(self._url)
+        self.wait_until_loaded()
+
+    @Slot(str)
+    def open_file(self, file_path: str):
+        """
+        Open a file in the VSCode editor.
+
+        Args:
+            file_path: The file path to open
+        """
+        msg = VSCodeInstructionMessage(command="open", content=f"file://{file_path}")
+        self.client.connector.raw_send(f"vscode-instructions/{self.gui_id}", msg.model_dump_json())
+
+    @Slot(dict, dict)
+    def on_vscode_event(self, content, _metadata):
+        """
+        Handle the VSCode event. VSCode events are received as RawMessages.
+
+        Args:
+            content: The content of the event
+            metadata: The metadata of the event
+        """
+
+        # the message also contains the content but I think is fine for now to just emit the file path
+        if not isinstance(content["data"], dict):
+            return
+        if "uri" not in content["data"]:
+            return
+        if not content["data"]["uri"].startswith("file://"):
+            return
+        file_path = content["data"]["uri"].split("file://")[1]
+        self.file_saved.emit(file_path)
+
+    @Slot()
+    def save_file(self):
+        """
+        Save the file in the VSCode editor.
+        """
+        msg = VSCodeInstructionMessage(command="save")
+        self.client.connector.raw_send(f"vscode-instructions/{self.gui_id}", msg.model_dump_json())
+
+    @Slot()
+    def new_file(self):
+        """
+        Create a new file in the VSCode editor.
+        """
+        msg = VSCodeInstructionMessage(command="new")
+        self.client.connector.raw_send(f"vscode-instructions/{self.gui_id}", msg.model_dump_json())
+
+    @Slot()
+    def close_file(self):
+        """
+        Close the file in the VSCode editor.
+        """
+        msg = VSCodeInstructionMessage(command="close")
+        self.client.connector.raw_send(f"vscode-instructions/{self.gui_id}", msg.model_dump_json())
+
+    @Slot(str)
+    def write_file(self, content: str):
+        """
+        Write content to the file in the VSCode editor.
+
+        Args:
+            content: The content to write
+        """
+        msg = VSCodeInstructionMessage(command="write", content=content)
+        self.client.connector.raw_send(f"vscode-instructions/{self.gui_id}", msg.model_dump_json())
+
+    @Slot()
+    def zen_mode(self):
+        """
+        Toggle the Zen mode in the VSCode editor.
+        """
+        msg = VSCodeInstructionMessage(command="zenMode")
+        self.client.connector.raw_send(f"vscode-instructions/{self.gui_id}", msg.model_dump_json())
+
+    @Slot(int, int)
+    def set_cursor(self, line: int, column: int):
+        """
+        Set the cursor in the VSCode editor.
+
+        Args:
+            line: The line number
+            column: The column number
+        """
+        msg = VSCodeInstructionMessage(command="setCursor", content=f"{line},{column}")
+        self.client.connector.raw_send(f"vscode-instructions/{self.gui_id}", msg.model_dump_json())
+
+    def cleanup_vscode(self):
+        """
+        Cleanup the VSCode editor.
+        """
+        if not self.process or self.process.poll() is not None:
+            return
+        os.killpg(os.getpgid(self.process.pid), signal.SIGTERM)
+        self.process.wait()
+
+    def cleanup(self):
+        """
+        Cleanup the widget. This method is called from the dock area when the widget is removed.
+        """
+        self.bec_dispatcher.disconnect_slot(self.on_vscode_event, f"vscode-events/{self.gui_id}")
+        self.cleanup_vscode()
+        return super().cleanup()
+
+
+if __name__ == "__main__":  # pragma: no cover
+    import sys
+
+    from qtpy.QtWidgets import QApplication
+
+    app = QApplication(sys.argv)
+    widget = VSCodeEditor(gui_id="unknown")
+    widget.show()
+    app.exec_()
+    widget.bec_dispatcher.disconnect_all()
+    widget.client.shutdown()

{bec_widgets-0.117.0 → bec_widgets-0.117.1}/pyproject.toml

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

bec_widgets-0.117.0/bec_widgets/widgets/vscode/vscode.py

@@ -1,96 +0,0 @@
-import os
-import select
-import shlex
-import signal
-import socket
-import subprocess
-import sys
-
-from bec_widgets.widgets.website.website import WebsiteWidget
-
-
-def get_free_port():
-    """
-    Get a free port on the local machine.
-
-    Returns:
-        int: The free port number
-    """
-    sock = socket.socket()
-    sock.bind(("", 0))
-    port = sock.getsockname()[1]
-    sock.close()
-    return port
-
-
-class VSCodeEditor(WebsiteWidget):
-    """
-    A widget to display the VSCode editor.
-    """
-
-    token = "bec"
-    host = "127.0.0.1"
-
-    USER_ACCESS = []
-    ICON_NAME = "developer_mode_tv"
-
-    def __init__(self, parent=None, config=None, client=None, gui_id=None):
-
-        self.process = None
-        self.port = get_free_port()
-        self._url = f"http://{self.host}:{self.port}?tkn={self.token}"
-        super().__init__(parent=parent, config=config, client=client, gui_id=gui_id)
-        self.start_server()
-
-    def start_server(self):
-        """
-        Start the server.
-
-        This method starts the server for the VSCode editor in a subprocess.
-        """
-
-        cmd = shlex.split(
-            f"code serve-web --port {self.port} --connection-token={self.token} --accept-server-license-terms"
-        )
-        self.process = subprocess.Popen(
-            cmd, text=True, stdout=subprocess.PIPE, stderr=subprocess.DEVNULL, preexec_fn=os.setsid
-        )
-
-        os.set_blocking(self.process.stdout.fileno(), False)
-        while self.process.poll() is None:
-            readylist, _, _ = select.select([self.process.stdout], [], [], 1)
-            if self.process.stdout in readylist:
-                output = self.process.stdout.read(1024)
-                if output and f"available at {self._url}" in output:
-                    break
-        self.set_url(self._url)
-        self.wait_until_loaded()
-
-    def cleanup_vscode(self):
-        """
-        Cleanup the VSCode editor.
-        """
-        if not self.process or self.process.poll() is not None:
-            return
-        os.killpg(os.getpgid(self.process.pid), signal.SIGTERM)
-        self.process.wait()
-
-    def cleanup(self):
-        """
-        Cleanup the widget. This method is called from the dock area when the widget is removed.
-        """
-        self.cleanup_vscode()
-        return super().cleanup()
-
-
-if __name__ == "__main__":  # pragma: no cover
-    import sys
-
-    from qtpy.QtWidgets import QApplication
-
-    app = QApplication(sys.argv)
-    widget = VSCodeEditor()
-    widget.show()
-    app.exec_()
-    widget.bec_dispatcher.disconnect_all()
-    widget.client.shutdown()