| 1 |
# Copyright (c) DataLab Platform Developers, BSD 3-Clause license, see LICENSE file. |
| 2 |
|
| 3 |
""" |
| 4 |
DataLab remote controlling class for Python 2.7 |
| 5 |
""" |
| 6 |
|
| 7 |
import io |
| 8 |
import os |
| 9 |
import os.path as osp |
| 10 |
import socket |
| 11 |
import sys |
| 12 |
|
| 13 |
import ConfigParser as cp |
| 14 |
import numpy as np |
| 15 |
from guidata.userconfig import get_config_dir |
| 16 |
from xmlrpclib import Binary, ServerProxy |
| 17 |
|
| 18 |
|
| 19 |
def array_to_rpcbinary(data): |
| 20 |
"""Convert NumPy array to XML-RPC Binary object, with shape and dtype""" |
| 21 |
dbytes = io.BytesIO() |
| 22 |
np.save(dbytes, data, allow_pickle=False) |
| 23 |
return Binary(dbytes.getvalue()) |
| 24 |
|
| 25 |
|
| 26 |
def get_datalab_xmlrpc_port(): |
| 27 |
"""Return DataLab current XML-RPC port""" |
| 28 |
if sys.platform == "win32" and "HOME" in os.environ: |
| 29 |
os.environ.pop("HOME") # Avoid getting old WinPython settings dir |
| 30 |
fname = osp.join(get_config_dir(), ".DataLab", "DataLab.ini") |
| 31 |
ini = cp.ConfigParser() |
| 32 |
ini.read(fname) |
| 33 |
try: |
| 34 |
return ini.get("main", "rpc_server_port") |
| 35 |
except (cp.NoSectionError, cp.NoOptionError): |
| 36 |
raise ConnectionRefusedError("DataLab has not yet been executed") |
| 37 |
|
| 38 |
|
| 39 |
class RemoteClient(object): |
| 40 |
"""Object representing a proxy/client to DataLab XML-RPC server""" |
| 41 |
|
| 42 |
def __init__(self): |
| 43 |
self.port = None |
| 44 |
self.serverproxy = None |
| 45 |
|
| 46 |
def connect(self, port=None): |
| 47 |
"""Connect to DataLab XML-RPC server""" |
| 48 |
if port is None: |
| 49 |
port = get_datalab_xmlrpc_port() |
| 50 |
self.port = port |
| 51 |
url = "http://127.0.0.1:" + port |
| 52 |
self.serverproxy = ServerProxy(url, allow_none=True) |
| 53 |
try: |
| 54 |
self.get_version() |
| 55 |
except socket.error: |
| 56 |
raise ConnectionRefusedError("DataLab is currently not running") |
| 57 |
|
| 58 |
def get_version(self): |
| 59 |
"""Return DataLab public version""" |
| 60 |
return self.serverproxy.get_version() |
| 61 |
|
| 62 |
def close_application(self): |
| 63 |
"""Close DataLab application""" |
| 64 |
self.serverproxy.close_application() |
| 65 |
|
| 66 |
def raise_window(self): |
| 67 |
"""Raise DataLab window""" |
| 68 |
self.serverproxy.raise_window() |
| 69 |
|
| 70 |
def get_current_panel(self): |
| 71 |
"""Return current panel""" |
| 72 |
return self.serverproxy.get_current_panel() |
| 73 |
|
| 74 |
def set_current_panel(self, panel): |
| 75 |
"""Switch to panel""" |
| 76 |
self.serverproxy.set_current_panel(panel) |
| 77 |
|
| 78 |
def reset_all(self): |
| 79 |
"""Reset all application data""" |
| 80 |
self.serverproxy.reset_all() |
| 81 |
|
| 82 |
def toggle_auto_refresh(self, state): |
| 83 |
"""Toggle auto refresh state""" |
| 84 |
self.serverproxy.toggle_auto_refresh(state) |
| 85 |
|
| 86 |
def toggle_show_titles(self, state): |
| 87 |
"""Toggle show titles state""" |
| 88 |
self.serverproxy.toggle_show_titles(state) |
| 89 |
|
| 90 |
def save_to_h5_file(self, filename): |
| 91 |
"""Save to a DataLab HDF5 file""" |
| 92 |
self.serverproxy.save_to_h5_file(filename) |
| 93 |
|
| 94 |
def open_h5_files(self, h5files, import_all, reset_all): |
| 95 |
"""Open a DataLab HDF5 file or import from any other HDF5 file""" |
| 96 |
self.serverproxy.open_h5_files(h5files, import_all, reset_all) |
| 97 |
|
| 98 |
def import_h5_file(self, filename, reset_all): |
| 99 |
"""Open DataLab HDF5 browser to Import HDF5 file""" |
| 100 |
self.serverproxy.import_h5_file(filename, reset_all) |
| 101 |
|
| 102 |
def load_from_files(self, filenames): |
| 103 |
"""Open objects from files in current panel (signals/images)""" |
| 104 |
self.serverproxy.load_from_files(filenames) |
| 105 |
|
| 106 |
def add_signal( |
| 107 |
self, |
| 108 |
title, |
| 109 |
xdata, |
| 110 |
ydata, |
| 111 |
xunit=None, |
| 112 |
yunit=None, |
| 113 |
xlabel=None, |
| 114 |
ylabel=None, |
| 115 |
group_id="", |
| 116 |
set_current=True, |
| 117 |
): |
| 118 |
"""Add signal data to DataLab""" |
| 119 |
xbinary = array_to_rpcbinary(xdata) |
| 120 |
ybinary = array_to_rpcbinary(ydata) |
| 121 |
p = self.serverproxy |
| 122 |
return p.add_signal( |
| 123 |
title, xbinary, ybinary, xunit, yunit, xlabel, ylabel, group_id, set_current |
| 124 |
) |
| 125 |
|
| 126 |
def add_image( |
| 127 |
self, |
| 128 |
title, |
| 129 |
data, |
| 130 |
xunit=None, |
| 131 |
yunit=None, |
| 132 |
zunit=None, |
| 133 |
xlabel=None, |
| 134 |
ylabel=None, |
| 135 |
zlabel=None, |
| 136 |
group_id="", |
| 137 |
set_current=True, |
| 138 |
): |
| 139 |
"""Add image data to DataLab""" |
| 140 |
zbinary = array_to_rpcbinary(data) |
| 141 |
p = self.serverproxy |
| 142 |
return p.add_image( |
| 143 |
title, |
| 144 |
zbinary, |
| 145 |
xunit, |
| 146 |
yunit, |
| 147 |
zunit, |
| 148 |
xlabel, |
| 149 |
ylabel, |
| 150 |
zlabel, |
| 151 |
group_id, |
| 152 |
set_current, |
| 153 |
) |
| 154 |
|
| 155 |
def get_object_titles(self, panel=None): |
| 156 |
"""Get object (signal/image) list for current panel""" |
| 157 |
return self.serverproxy.get_object_titles(panel) |
| 158 |
|
| 159 |
def get_object(self, nb_id_title=None, panel=None): |
| 160 |
"""Get object (signal/image) by number, id or title""" |
| 161 |
return self.serverproxy.get_object(nb_id_title, panel) |
| 162 |
|
| 163 |
def get_object_uuids(self, panel=None, group=None): |
| 164 |
"""Get object (signal/image) list for current panel""" |
| 165 |
return self.serverproxy.get_object_uuids(panel, group) |
| 166 |
|
| 167 |
|
| 168 |
def test_remote_client(): |
| 169 |
"""DataLab Remote Client test""" |
| 170 |
datalab = RemoteClient() |
| 171 |
datalab.connect() |
| 172 |
data = np.array([[3, 4, 5], [7, 8, 0]], dtype=np.uint16) |
| 173 |
datalab.add_image("toto", data) |
| 174 |
|
| 175 |
|
| 176 |
if __name__ == "__main__": |
| 177 |
test_remote_client() |