datalab-platform 1.0.4__py3-none-any.whl → 1.1.0__py3-none-any.whl

datalab/gui/main.py

@@ -71,6 +71,8 @@ from datalab.utils.qthelpers import (
     bring_to_front,
     configure_menu_about_to_show,
 )
+from datalab.webapi import WEBAPI_AVAILABLE, get_webapi_controller
+from datalab.webapi.actions import WebApiActions
 from datalab.widgets import instconfviewer, logviewer, status
 from datalab.widgets.warningerror import go_to_error
 
@@ -146,6 +148,7 @@ class DLMainWindow(QW.QMainWindow, AbstractDLControl, metaclass=DLMainWindowMeta
         self.__old_size: tuple[int, int] | None = None
         self.__memory_warning = False
         self.memorystatus: status.MemoryStatus | None = None
+        self.webapistatus: status.WebAPIStatus | None = None
 
         self.consolestatus: status.ConsoleStatus | None = None
         self.console: DockableConsole | None = None
@@ -162,6 +165,7 @@ class DLMainWindow(QW.QMainWindow, AbstractDLControl, metaclass=DLMainWindowMeta
         self.tabmenu: QW.QMenu | None = None
         self.docks: dict[AbstractPanel | DockableConsole, QW.QDockWidget] | None = None
         self.h5inputoutput = H5InputOutput(self)
+        self.webapi_actions: WebApiActions | None = None
 
         self.openh5_action: QW.QAction | None = None
         self.saveh5_action: QW.QAction | None = None
@@ -448,6 +452,116 @@ class DLMainWindow(QW.QMainWindow, AbstractDLControl, metaclass=DLMainWindowMeta
         panel = self.__get_current_basedatapanel()
         panel.delete_metadata(refresh_plot, keep_roi)
 
+    @remote_controlled
+    def call_method(
+        self,
+        method_name: str,
+        *args,
+        panel: Literal["signal", "image"] | None = None,
+        **kwargs,
+    ):
+        """Call a public method on a panel or main window.
+
+        This generic method allows calling any public method that is not explicitly
+        exposed in the proxy API. The method resolution follows this order:
+
+        1. If panel is specified: call method on that specific panel
+        2. If panel is None:
+           a. Try to call method on main window (DLMainWindow)
+           b. If not found, try to call method on current panel (BaseDataPanel)
+
+        This makes it convenient to call panel methods without specifying the panel
+        parameter when working on the current panel.
+
+        Args:
+            method_name: Name of the method to call
+            *args: Positional arguments to pass to the method
+            panel: Panel name ("signal", "image", or None for auto-detection).
+             Defaults to None.
+            **kwargs: Keyword arguments to pass to the method
+
+        Returns:
+            The return value of the called method
+
+        Raises:
+            AttributeError: If the method does not exist or is not public
+            ValueError: If the panel name is invalid
+
+        Examples:
+            >>> # Call remove_object on current panel (auto-detected)
+            >>> win.call_method("remove_object", force=True)
+            >>> # Call a signal panel method specifically
+            >>> win.call_method("delete_all_objects", panel="signal")
+            >>> # Call main window method
+            >>> win.call_method("get_current_panel")
+        """
+        # Security check: only allow public methods (not starting with _)
+        if method_name.startswith("_"):
+            raise AttributeError(
+                f"Cannot call private method '{method_name}' through proxy"
+            )
+
+        # If panel is specified, use that panel directly
+        if panel is not None:
+            target = self.__get_datapanel(panel)
+            if not hasattr(target, method_name):
+                raise AttributeError(
+                    f"Method '{method_name}' does not exist on {panel} panel"
+                )
+            method = getattr(target, method_name)
+            if not callable(method):
+                raise AttributeError(f"'{method_name}' is not a callable method")
+            return method(*args, **kwargs)
+
+        # Panel is None: try main window first, then current panel
+        # Try main window first
+        if hasattr(self, method_name):
+            method = getattr(self, method_name)
+            if callable(method):
+                return method(*args, **kwargs)
+
+        # Method not found on main window, try current panel
+        current_panel = self.__get_current_basedatapanel()
+        if hasattr(current_panel, method_name):
+            method = getattr(current_panel, method_name)
+            if callable(method):
+                return method(*args, **kwargs)
+
+        # Method not found anywhere
+        raise AttributeError(
+            f"Method '{method_name}' does not exist on main window or current panel"
+        )
+
+    @remote_controlled
+    def call_method_slot(
+        self,
+        method_name: str,
+        args: list,
+        panel: Literal["signal", "image"] | None,
+        kwargs: dict,
+    ) -> None:
+        """Slot to call a method from RemoteServer thread in GUI thread.
+
+        This slot receives signals from RemoteServer and executes the method in
+        the GUI thread, avoiding thread-safety issues with Qt widgets and dialogs.
+
+        Args:
+            method_name: Name of the method to call
+            args: Positional arguments as a list
+            panel: Panel name or None for auto-detection
+            kwargs: Keyword arguments as a dict
+        """
+        # Call the method and store result in RemoteServer
+        try:
+            result = self.call_method(method_name, *args, panel=panel, **kwargs)
+            # Store result in RemoteServer for retrieval by XML-RPC thread
+            self.remote_server.result = result
+            self.remote_server.exception = None  # Clear any previous exception
+        except Exception as exc:  # pylint: disable=broad-except
+            # Store exception for re-raising in XML-RPC thread
+            self.remote_server.result = None
+            self.remote_server.exception = exc
+
     @remote_controlled
     def get_object_shapes(
         self,
@@ -526,6 +640,60 @@ class DLMainWindow(QW.QMainWindow, AbstractDLControl, metaclass=DLMainWindowMeta
         """
         self.macropanel.import_macro_from_file(filename)
 
+    # ------WebAPI control
+    @remote_controlled
+    def start_webapi_server(
+        self,
+        host: str | None = None,
+        port: int | None = None,
+    ) -> dict:
+        """Start the Web API server.
+
+        Args:
+            host: Host address to bind to. Defaults to "127.0.0.1".
+            port: Port number. Defaults to auto-detect available port.
+
+        Returns:
+            Dictionary with "url" and "token" keys.
+
+        Raises:
+            RuntimeError: If Web API deps not installed or server already running.
+        """
+        if not WEBAPI_AVAILABLE:
+            raise RuntimeError(
+                "Web API dependencies not installed. "
+                "Install with: pip install datalab-platform[webapi]"
+            )
+
+        controller = get_webapi_controller()
+        controller.set_main_window(self)
+        url, token = controller.start(host=host, port=port)
+        return {"url": url, "token": token}
+
+    @remote_controlled
+    def stop_webapi_server(self) -> None:
+        """Stop the Web API server."""
+        if not WEBAPI_AVAILABLE:
+            return
+
+        controller = get_webapi_controller()
+        controller.stop()
+
+    @remote_controlled
+    def get_webapi_status(self) -> dict:
+        """Get Web API server status.
+
+        Returns:
+            Dictionary with "running", "url", and "token" keys.
+        """
+        if not WEBAPI_AVAILABLE:
+            return {"running": False, "url": None, "token": None, "available": False}
+
+        controller = get_webapi_controller()
+        info = controller.get_connection_info()
+        info["available"] = True
+        return info
+
     # ------Misc.
     @property
     def panels(self) -> tuple[AbstractPanel, ...]:
@@ -540,6 +708,16 @@ class DLMainWindow(QW.QMainWindow, AbstractDLControl, metaclass=DLMainWindowMeta
         """Set memory warning state"""
         self.__memory_warning = state
 
+    def __show_webapi_info(self) -> None:
+        """Show Web API connection info when status widget is clicked."""
+        if self.webapi_actions is not None:
+            self.webapi_actions.show_connection_info()
+
+    def __start_webapi_server(self) -> None:
+        """Start Web API server when status widget is clicked."""
+        if self.webapi_actions is not None:
+            self.webapi_actions.start_server_from_status_widget()
+
     def confirm_memory_state(self) -> bool:  # pragma: no cover
         """Check memory warning state and eventually show a warning dialog
 
@@ -600,6 +778,10 @@ class DLMainWindow(QW.QMainWindow, AbstractDLControl, metaclass=DLMainWindowMeta
             # Showing the log viewer for testing purpose (unattended mode) but only
             # if option 'do_not_quit' is not set, to avoid blocking the test suite
             self.__show_logviewer()
+        elif execenv.do_not_quit:
+            # If 'do_not_quit' is set, we do not show any message box to avoid blocking
+            # the test suite
+            return
         elif Conf.main.faulthandler_log_available.get(
             False
         ) or Conf.main.traceback_log_available.get(False):
@@ -677,6 +859,12 @@ class DLMainWindow(QW.QMainWindow, AbstractDLControl, metaclass=DLMainWindowMeta
         if tour:
             Conf.main.tour_enabled.set(False)
             self.show_tour()
+        # Auto-start WebAPI server if environment variable is set
+        if os.environ.get("DATALAB_WEBAPI_ENABLED") == "1":
+            try:
+                self.start_webapi_server()
+            except Exception as e:  # pylint: disable=broad-exception-caught
+                print(f"Warning: Failed to auto-start WebAPI server: {e}")
 
     def take_screenshot(self, name: str) -> None:  # pragma: no cover
         """Take main window screenshot"""
@@ -788,6 +976,7 @@ class DLMainWindow(QW.QMainWindow, AbstractDLControl, metaclass=DLMainWindowMeta
         self.__create_plugins_actions()
         self.__setup_central_widget()
         self.__add_menus()
+        self.__setup_webapi()
         if console:
             self.__setup_console()
         self.__update_actions(update_other_data_panel=True)
@@ -796,6 +985,11 @@ class DLMainWindow(QW.QMainWindow, AbstractDLControl, metaclass=DLMainWindowMeta
         # Now that everything is set up, we can restore the window state:
         self.__restore_state()
 
+    def __setup_webapi(self) -> None:
+        """Setup Web API actions."""
+        self.webapi_actions = WebApiActions(self)
+        # Note: Menu is added in __update_view_menu since view_menu is cleared each show
+
     def __register_plugins(self) -> None:
         """Register plugins"""
         with qth.try_or_log_error("Discovering plugins"):
@@ -842,6 +1036,11 @@ class DLMainWindow(QW.QMainWindow, AbstractDLControl, metaclass=DLMainWindowMeta
         xmlrpcstatus = status.XMLRPCStatus()
         xmlrpcstatus.set_port(self.remote_server.port)
         self.statusBar().addPermanentWidget(xmlrpcstatus)
+        # Web API server status
+        self.webapistatus = status.WebAPIStatus()
+        self.webapistatus.SIG_SHOW_INFO.connect(self.__show_webapi_info)
+        self.webapistatus.SIG_START_SERVER.connect(self.__start_webapi_server)
+        self.statusBar().addPermanentWidget(self.webapistatus)
         # Memory status
         threshold = Conf.main.available_memory_threshold.get()
         self.memorystatus = status.MemoryStatus(threshold)
@@ -1304,7 +1503,9 @@ class DLMainWindow(QW.QMainWindow, AbstractDLControl, metaclass=DLMainWindowMeta
             raise ValueError(f"Unknown panel {panel}")
 
     @remote_controlled
-    def calc(self, name: str, param: gds.DataSet | None = None) -> None:
+    def calc(
+        self, name: str, param: gds.DataSet | None = None, edit: bool = True
+    ) -> None:
         """Call computation feature ``name``
 
         .. note::
@@ -1317,6 +1518,8 @@ class DLMainWindow(QW.QMainWindow, AbstractDLControl, metaclass=DLMainWindowMeta
         Args:
             name: Compute function name
             param: Compute function parameter. Defaults to None.
+            edit: Whether to show parameter edit dialog. Defaults to True.
+             Set to False when calling from remote/API to avoid blocking dialogs.
 
         Raises:
             ValueError: unknown function
@@ -1340,7 +1543,7 @@ class DLMainWindow(QW.QMainWindow, AbstractDLControl, metaclass=DLMainWindowMeta
                 # registered feature:
                 try:
                     feature = panel.processor.get_feature(name)
-                    panel.processor.run_feature(feature, param)
+                    panel.processor.run_feature(feature, param, edit=edit)
                     return
                 except ValueError:
                     continue
@@ -1438,6 +1641,10 @@ class DLMainWindow(QW.QMainWindow, AbstractDLControl, metaclass=DLMainWindowMeta
                 self.settings_action,
             ],
         )
+        # Add Web API submenu
+        if self.webapi_actions is not None:
+            self.file_menu.addSeparator()
+            self.webapi_actions.create_menu(self.file_menu)
         if self.quit_action is not None:
             add_actions(self.file_menu, [self.quit_action])
 
@@ -1531,6 +1738,16 @@ class DLMainWindow(QW.QMainWindow, AbstractDLControl, metaclass=DLMainWindowMeta
             if panel is not None:
                 panel.remove_all_objects()
 
+    @remote_controlled
+    def remove_object(self, force: bool = False) -> None:
+        """Remove current object from current panel.
+
+        Args:
+            force: if True, remove object without confirmation. Defaults to False.
+        """
+        panel = self.__get_current_basedatapanel()
+        panel.remove_object(force)
+
     @staticmethod
     def __check_h5file(filename: str, operation: str) -> str:
         """Check HDF5 filename"""
@@ -2115,6 +2332,8 @@ class DLMainWindow(QW.QMainWindow, AbstractDLControl, metaclass=DLMainWindowMeta
                 # it would represent too much effort for an error occuring in test
                 # configurations only.
                 pass
+        if self.webapi_actions is not None:
+            self.webapi_actions.cleanup()
         self.reset_all()
         self.__save_pos_size_and_state()
         self.__unregister_plugins()

datalab/gui/settings.py

@@ -47,6 +47,16 @@ class MainSettings(gds.DataSet):
             "<br>like your own scripts (e.g. from Spyder or Jupyter) or other software."
         ),
     )
+    webapi_localhost_no_token = gds.BoolItem(
+        "",
+        _("Web API localhost bypass"),
+        help=_(
+            "When enabled (default), connections from localhost (127.0.0.1) to the "
+            "<br>Web API do not require authentication. This simplifies notebook "
+            "<br>integration when DataLab-Kernel runs on the same machine."
+            "<br>Disable for stricter security if needed."
+        ),
+    )
     available_memory_threshold = gds.IntItem(
         _("Memory threshold"),
         default=0,

datalab/gui/tour.py

@@ -456,9 +456,8 @@ class BaseTour(QW.QWidget, metaclass=BaseTourMeta):
         Args:
             factor: Factor by which the size of the window is multiplied.
         """
-        desktop = QW.QApplication.desktop()
-        screen = desktop.screenNumber(desktop.cursor().pos())
-        screen_geometry = desktop.screenGeometry(screen)
+        screen = QW.QApplication.primaryScreen()
+        screen_geometry = screen.geometry()
         width = int(screen_geometry.width() * factor)
         height = int(screen_geometry.height() * factor)
         self.win.resize(width, height)

datalab/locale/fr/LC_MESSAGES/datalab.po

@@ -1298,7 +1298,7 @@ msgid "Macro panel"
 msgstr "Panneau des macros"
 
 msgid "Python files"
-msgstr "Fichiers Python""
+msgstr "Fichiers Python"
 
 msgid "-***- Macro Console -***-"
 msgstr "-***- Console des macros -***-"
@@ -2162,6 +2162,12 @@ msgstr "Serveur XML-RPC"
 msgid "RPC server is used to communicate with external applications,<br>like your own scripts (e.g. from Spyder or Jupyter) or other software."
 msgstr "Le serveur XML-RPC est utilisé pour communiquer avec des applications externes,<br>comme vos propres scripts (par exemple depuis Spyder ou Jupyter) ou d'autres logiciels."
 
+msgid "Web API localhost bypass"
+msgstr "Contournement localhost de l'API Web"
+
+msgid "When enabled (default), connections from localhost (127.0.0.1) to the <br>Web API do not require authentication. This simplifies notebook <br>integration when DataLab-Kernel runs on the same machine.<br>Disable for stricter security if needed."
+msgstr "Lorsque cette option est activée (par défaut), les connexions depuis localhost (127.0.0.1) <br>vers l'API Web ne nécessitent pas d'authentification. Cela simplifie l'intégration <br>des notebooks lorsque DataLab-Kernel s'exécute sur la même machine.<br>Désactiver pour une sécurité plus stricte si nécessaire."
+
 msgid "Memory threshold"
 msgstr "Seuil de mémoire"
 
@@ -2804,6 +2810,70 @@ msgstr "dans ce dossier"
 msgid "Open tab menu"
 msgstr "Ouvrir le menu des onglets"
 
+msgid "Start Web API Server"
+msgstr "Démarrer le serveur API Web"
+
+msgid "Start the HTTP/JSON Web API server for external access"
+msgstr "Démarrer le serveur API Web HTTP/JSON pour l'accès externe"
+
+msgid "Stop Web API Server"
+msgstr "Arrêter le serveur API Web"
+
+msgid "Copy Connection Info"
+msgstr "Copier les infos de connexion"
+
+msgid "Copy URL and token to clipboard"
+msgstr "Copier l'URL et le jeton dans le presse-papier"
+
+msgid "Status: Not running"
+msgstr "Statut : Non démarré"
+
+msgid "Web API unavailable (install datalab-platform[webapi])"
+msgstr "API Web non disponible (installer datalab-platform[webapi])"
+
+msgid "Web API"
+msgstr "API Web"
+
+msgid "Failed to start Web API server:"
+msgstr "Échec du démarrage du serveur API Web :"
+
+msgid "Connection info copied to clipboard"
+msgstr "Infos de connexion copiées dans le presse-papier"
+
+msgid "Web API Server Started"
+msgstr "Serveur API Web démarré"
+
+msgid "The Web API server is now running. Use the following credentials to connect:"
+msgstr "Le serveur API Web est maintenant en cours d'exécution. Utilisez les identifiants suivants pour vous connecter :"
+
+msgid "URL:"
+msgstr "URL :"
+
+msgid "Token:"
+msgstr "Jeton :"
+
+msgid "Tip: Set these environment variables in your notebook:\n"
+msgstr "Astuce : Définissez ces variables d'environnement dans votre notebook :\n"
+
+msgid "Copy to Clipboard"
+msgstr "Copier dans le presse-papier"
+
+#, python-brace-format
+msgid "Status: Running at {}"
+msgstr "Statut : En cours d'exécution à {}"
+
+msgid "Web API server error:"
+msgstr "Erreur du serveur API Web :"
+
+msgid ""
+"Do you want to start the Web API server?\n"
+"\n"
+"This will allow external applications to connect to DataLab and control it remotely via HTTP/JSON."
+msgstr ""
+"Souhaitez-vous démarrer le serveur API Web ?\n"
+"\n"
+"Cela permettra aux applications externes de se connecter à DataLab et de le contrôler à distance via HTTP/JSON."
+
 msgid "Connection to DataLab"
 msgstr "Connexion à DataLab"
 
@@ -3044,6 +3114,21 @@ msgstr "Plugins :"
 msgid "XML-RPC:"
 msgstr "XML-RPC :"
 
+msgid "Web API server is not running"
+msgstr "Serveur API Web arrêté"
+
+msgid "Click to start"
+msgstr "Cliquer pour démarrer"
+
+msgid "Web API:"
+msgstr "API Web :"
+
+msgid "Web API server is running"
+msgstr "Serveur API Web démarré"
+
+msgid "Click to view connection info"
+msgstr "Cliquer pour voir les infos de connexion"
+
 msgid "Source"
 msgstr "Source"
 
@@ -3294,3 +3379,4 @@ msgstr "Merci de sélectionner le fichier à importer."
 
 msgid "Example Wizard"
 msgstr "Assistant exemple"
+

datalab/tests/__init__.py

@@ -34,7 +34,7 @@ from sigima.tests import helpers
 
 import datalab.config  # Loading icons
 from datalab.config import MOD_NAME, SHOTPATH
-from datalab.control.proxy import RemoteProxy
+from datalab.control.proxy import RemoteProxy, proxy_context
 from datalab.env import execenv
 from datalab.gui.main import DLMainWindow
 from datalab.gui.panel.image import ImagePanel
@@ -172,6 +172,37 @@ def run_datalab_in_background(wait_until_ready: bool = True) -> None:
             ) from exc
 
 
+def close_datalab_background() -> None:
+    """Close DataLab application running as a service.
+
+    This function connects to the DataLab application running in the background
+    (started with `run_datalab_in_background`) and sends a command to close it.
+    It uses the `RemoteProxy` class to establish the connection and send the
+    close command.
+
+    Raises:
+        ConnectionRefusedError: If unable to connect to the DataLab application.
+    """
+    proxy = RemoteProxy(autoconnect=False)
+    proxy.connect(timeout=5.0)  # 5 seconds max to connect
+    proxy.close_application()
+    proxy.disconnect()
+
+
+@contextmanager
+def datalab_in_background_context() -> Generator[RemoteProxy, None, None]:
+    """Context manager for DataLab instance with proxy connection"""
+    run_datalab_in_background()
+    with proxy_context("remote") as proxy:
+        try:
+            yield proxy
+        except Exception as exc:  # pylint: disable=broad-except
+            proxy.close_application()
+            raise exc
+        # Cleanup
+        proxy.close_application()
+
+
 @contextmanager
 def skip_if_opencv_missing() -> Generator[None, None, None]:
     """Skip test if OpenCV is not available"""

datalab/tests/backbone/config_unit_test.py

@@ -128,7 +128,7 @@ def check_conf(conf, name, win: QW.QMainWindow, h5files):
         #  Check position, taking into account screen offset (e.g. Linux/Gnome)
         conf_x, conf_y = sec_main[OPT_POS.option]
         conf_w, conf_h = sec_main[OPT_SIZ.option]
-        available_go = QW.QDesktopWidget().availableGeometry()
+        available_go = QW.QApplication.primaryScreen().availableGeometry()
         x_offset, y_offset = available_go.x(), available_go.y()
         assert_in_interval(win.x(), conf_x - x_offset, 0, "X position")
         assert_in_interval(win.y(), conf_y - y_offset / 2, 15 + y_offset, "Y position")

datalab/tests/backbone/main_app_test.py

@@ -54,6 +54,10 @@ def test_main_app():
         # Add signals to signal panel
         sig1 = create_paracetamol_signal(500)
         panel.add_object(sig1)
+        nobj0 = len(panel)
+        win.remove_object(force=True)  # Test remove object method, then add it back
+        assert len(panel) == nobj0 - 1, "One object should have been removed"
+        panel.add_object(sig1)
         panel.rename_selected_object_or_group("Paracetamol Signal 1")
         panel.processor.run_feature(sips.derivative)
         panel.processor.run_feature(sips.wiener)

datalab/tests/backbone/memory_leak.py

@@ -13,7 +13,7 @@ import os
 import numpy as np
 import psutil
 from guidata.qthelpers import qt_app_context
-from sigima.tests.vistools import view_curves
+from sigima.viz import view_curves
 
 from datalab.env import execenv
 from datalab.tests.features.control.embedded1_unit_test import HostWindow

datalab/tests/features/common/createobject_unit_test.py

@@ -14,7 +14,7 @@ from __future__ import annotations
 
 import sigima.objects
 from guidata.qthelpers import qt_app_context
-from sigima.tests.vistools import view_curves, view_images
+from sigima.viz import view_curves, view_images
 
 from datalab.env import execenv
 from datalab.gui.newobject import create_image_gui, create_signal_gui

datalab/tests/features/common/misc_app_test.py

@@ -164,6 +164,11 @@ def __misc_unit_function(win: DLMainWindow) -> None:
         group_id=get_uuid(gp2),
         set_current=False,
     )
+    sig = win.get_object()  # Get the last added signal
+    nobj0 = len(win.signalpanel)
+    win.remove_object(force=True)  # Test the remove object method, then add it back
+    assert len(win.signalpanel) == nobj0 - 1, "One object should have been removed"
+    win.add_object(sig)
 
     # Add image
     __print_test_result("Add image")