# Copyright (c) DataLab Platform Developers, BSD 3-Clause license, see LICENSE file. """ DataLab remote controlling class for Python 2.7 """ import io import os import os.path as osp import socket import sys import ConfigParser as cp import numpy as np from guidata.userconfig import get_config_dir from xmlrpclib import Binary, ServerProxy def array_to_rpcbinary(data): """Convert NumPy array to XML-RPC Binary object, with shape and dtype""" dbytes = io.BytesIO() np.save(dbytes, data, allow_pickle=False) return Binary(dbytes.getvalue()) def get_datalab_xmlrpc_port(): """Return DataLab current XML-RPC port""" if sys.platform == "win32" and "HOME" in os.environ: os.environ.pop("HOME") # Avoid getting old WinPython settings dir fname = osp.join(get_config_dir(), ".DataLab", "DataLab.ini") ini = cp.ConfigParser() ini.read(fname) try: return ini.get("main", "rpc_server_port") except (cp.NoSectionError, cp.NoOptionError): raise ConnectionRefusedError("DataLab has not yet been executed") class RemoteClient(object): """Object representing a proxy/client to DataLab XML-RPC server""" def __init__(self): self.port = None self.serverproxy = None def connect(self, port=None): """Connect to DataLab XML-RPC server""" if port is None: port = get_datalab_xmlrpc_port() self.port = port url = "http://127.0.0.1:" + port self.serverproxy = ServerProxy(url, allow_none=True) try: self.get_version() except socket.error: raise ConnectionRefusedError("DataLab is currently not running") def get_version(self): """Return DataLab public version""" return self.serverproxy.get_version() def close_application(self): """Close DataLab application""" self.serverproxy.close_application() def raise_window(self): """Raise DataLab window""" self.serverproxy.raise_window() def get_current_panel(self): """Return current panel""" return self.serverproxy.get_current_panel() def set_current_panel(self, panel): """Switch to panel""" self.serverproxy.set_current_panel(panel) def reset_all(self): """Reset all application data""" self.serverproxy.reset_all() def toggle_auto_refresh(self, state): """Toggle auto refresh state""" self.serverproxy.toggle_auto_refresh(state) def toggle_show_titles(self, state): """Toggle show titles state""" self.serverproxy.toggle_show_titles(state) def save_to_h5_file(self, filename): """Save to a DataLab HDF5 file""" self.serverproxy.save_to_h5_file(filename) def open_h5_files(self, h5files, import_all, reset_all): """Open a DataLab HDF5 file or import from any other HDF5 file""" self.serverproxy.open_h5_files(h5files, import_all, reset_all) def import_h5_file(self, filename, reset_all): """Open DataLab HDF5 browser to Import HDF5 file""" self.serverproxy.import_h5_file(filename, reset_all) def load_from_files(self, filenames): """Open objects from files in current panel (signals/images)""" self.serverproxy.load_from_files(filenames) def add_signal( self, title, xdata, ydata, xunit=None, yunit=None, xlabel=None, ylabel=None, group_id="", set_current=True, ): """Add signal data to DataLab""" xbinary = array_to_rpcbinary(xdata) ybinary = array_to_rpcbinary(ydata) p = self.serverproxy return p.add_signal( title, xbinary, ybinary, xunit, yunit, xlabel, ylabel, group_id, set_current ) def add_image( self, title, data, xunit=None, yunit=None, zunit=None, xlabel=None, ylabel=None, zlabel=None, group_id="", set_current=True, ): """Add image data to DataLab""" zbinary = array_to_rpcbinary(data) p = self.serverproxy return p.add_image( title, zbinary, xunit, yunit, zunit, xlabel, ylabel, zlabel, group_id, set_current, ) def get_object_titles(self, panel=None): """Get object (signal/image) list for current panel""" return self.serverproxy.get_object_titles(panel) def get_object(self, nb_id_title=None, panel=None): """Get object (signal/image) by number, id or title""" return self.serverproxy.get_object(nb_id_title, panel) def get_object_uuids(self, panel=None, group=None): """Get object (signal/image) list for current panel""" return self.serverproxy.get_object_uuids(panel, group) def test_remote_client(): """DataLab Remote Client test""" datalab = RemoteClient() datalab.connect() data = np.array([[3, 4, 5], [7, 8, 0]], dtype=np.uint16) datalab.add_image("toto", data) if __name__ == "__main__": test_remote_client()