feat: added websitewidget

Automatically generated by python-semantic-release

.gitlab-ci.yml

@@ -6,7 +6,7 @@ image: $CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX/python:3.10
 variables:
   DOCKER_TLS_CERTDIR: ""
   BEC_CORE_BRANCH: "main"
-  OPHYD_DEVICES_BRANCH: "master"
+  OPHYD_DEVICES_BRANCH: "main"
 
 workflow:
   rules:

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 <!--next-version-placeholder-->
 
+## v0.46.6 (2024-04-19)
+
+### Fix
+
+* **cli:** Fixed support for devices as cli input ([`1111610`](https://gitlab.psi.ch/bec/bec-widgets/-/commit/1111610f3206c5c46db6b4bd1e8827f1a4cd9e3f))
+
 ## v0.46.5 (2024-04-19)
 
 ### Fix

bec_widgets/cli/client_utils.py

@@ -36,6 +36,17 @@ def rpc_call(func):
 
     @wraps(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...
+        out = []
+        for arg in args:
+            if hasattr(arg, "name"):
+                arg = arg.name
+            out.append(arg)
+        args = tuple(out)
+        for key, val in kwargs.items():
+            if hasattr(val, "name"):
+                kwargs[key] = val.name
         if not self.gui_is_alive():
             raise RuntimeError("GUI is not alive")
         return self._run_rpc(func.__name__, *args, **kwargs)

bec_widgets/widgets/editor/vscode.py

@@ -0,0 +1,32 @@
+from qtpy.QtCore import QUrl
+from qtpy.QtWebEngineWidgets import QWebEngineView
+from qtpy.QtWidgets import QApplication, QVBoxLayout, QWidget
+
+
+class WebsiteWidget(QWidget):
+    def __init__(self, url):
+        super().__init__()
+        self.editor = QWebEngineView(self)
+
+        layout = QVBoxLayout()
+        layout.addWidget(self.editor)
+        self.setLayout(layout)
+        self.editor.setUrl(QUrl(url))
+
+
+class VSCodeEditor(WebsiteWidget):
+    token = "bec"
+    host = "localhost"
+    port = 7000
+
+    def __init__(self):
+        super().__init__(f"http://{self.host}:{self.port}?tkn={self.token}")
+
+
+if __name__ == "__main__":
+    import sys
+
+    app = QApplication(sys.argv)
+    mainWin = WebsiteWidget("https://scilog.psi.ch")
+    mainWin.show()
+    sys.exit(app.exec())

bec_widgets/widgets/editor/vscode_server.py

@@ -0,0 +1,59 @@
+"""
+Module to handle the vscode server
+"""
+
+import subprocess
+
+
+class VSCodeServer:
+    """
+    Class to handle the vscode server
+    """
+
+    _instance = None
+
+    def __init__(self, port=7000, token="bec"):
+        self.started = False
+        self._server = None
+        self.port = port
+        self.token = token
+
+    def __new__(cls, *args, forced=False, **kwargs):
+        if cls._instance is None or forced:
+            cls._instance = super(VSCodeServer, cls).__new__(cls)
+        return cls._instance
+
+    def start_server(self):
+        """
+        Start the vscode server in a subprocess
+        """
+        if self.started:
+            return
+        self._server = subprocess.Popen(
+            f"code serve-web --port {self.port} --connection-token={self.token} --accept-server-license-terms",
+            shell=True,
+        )
+        self.started = True
+
+    def wait(self):
+        """
+        Wait for the server to finish
+        """
+        if not self.started:
+            return
+        if not self._server:
+            return
+        self._server.wait()
+
+
+if __name__ == "__main__":
+    import argparse
+
+    parser = argparse.ArgumentParser(description="Start the vscode server")
+    parser.add_argument("--port", type=int, default=7000, help="Port to start the server")
+    parser.add_argument("--token", type=str, default="bec", help="Token to start the server")
+    args = parser.parse_args()
+
+    server = VSCodeServer(port=args.port, token=args.token)
+    server.start_server()
+    server.wait()

setup.py

@@ -1,7 +1,7 @@
 # pylint: disable= missing-module-docstring
 from setuptools import find_packages, setup
 
-__version__ = "0.46.5"
+__version__ = "0.46.6"
 
 # Default to PyQt6 if no other Qt binding is installed
 QT_DEPENDENCY = "PyQt6>=6.0"

tests/unit_tests/test_client_utils.py

@@ -0,0 +1,29 @@
+from unittest import mock
+
+import pytest
+
+from bec_widgets.cli.client import BECFigure
+
+from .client_mocks import FakeDevice
+
+
+@pytest.fixture
+def cli_figure():
+    fig = BECFigure(gui_id="test")
+    with mock.patch.object(fig, "_run_rpc") as mock_rpc_call:
+        with mock.patch.object(fig, "gui_is_alive", return_value=True):
+            yield fig, mock_rpc_call
+
+
+def test_rpc_call_plot(cli_figure):
+    fig, mock_rpc_call = cli_figure
+    fig.plot("samx", "bpm4i")
+    mock_rpc_call.assert_called_with("plot", "samx", "bpm4i")
+
+
+def test_rpc_call_accepts_device_as_input(cli_figure):
+    dev1 = FakeDevice("samx")
+    dev2 = FakeDevice("bpm4i")
+    fig, mock_rpc_call = cli_figure
+    fig.plot(dev1, dev2)
+    mock_rpc_call.assert_called_with("plot", "samx", "bpm4i")