class SourceWorker:
def __init__(self, port, parameters_topic, initialisation_function, end_of_life_function, num_sending_topics,
relic_path, ssh_local_ip=' ', ssh_local_username='******', ssh_local_password='******'):
self.parameters_topic = parameters_topic
self.data_port = port
self.pull_heartbeat_port = str(int(self.data_port) + 1)
self.initialisation_function = initialisation_function
self.end_of_life_function = end_of_life_function
self.num_sending_topics = int(num_sending_topics)
self.node_name = parameters_topic.split('##')[-2]
self.node_index = parameters_topic.split('##')[-1]
self.ssh_com = SSHCom(ssh_local_ip=ssh_local_ip, ssh_local_username=ssh_local_username,
ssh_local_password=ssh_local_password)
self.relic_path = relic_path
self.import_reliquery()
self.heron_relic = None
self.num_of_iters_to_update_relics_substate = None
self.time_of_pulse = time.perf_counter()
self.port_sub_parameters = ct.PARAMETERS_FORWARDER_PUBLISH_PORT
self.port_pub_proof_of_life = ct.PROOF_OF_LIFE_FORWARDER_SUBMIT_PORT
self.running_thread = True
self.loops_on = True
self.initialised = False
self.context = None
self.socket_push_data = None
self.socket_sub_parameters = None
self.stream_parameters = None
self.thread_parameters = None
self.parameters = None
self.socket_pull_heartbeat = None
self.stream_heartbeat = None
self.thread_heartbeat = None
self.socket_pub_proof_of_life = None
self.thread_proof_of_life = None
self.index = 0
def connect_socket(self):
"""
Sets up the sockets to do the communication with the source_com process through the forwarders
(for the link and the parameters).
:return: Nothing
"""
self.context = zmq.Context()
# Setup the socket that receives the parameters of the worker_exec function from the node
self.socket_sub_parameters = Socket(self.context, zmq.SUB)
self.socket_sub_parameters.setsockopt(zmq.LINGER, 0)
self.socket_sub_parameters.subscribe(self.parameters_topic)
self.ssh_com.connect_socket_to_local(self.socket_sub_parameters, r'tcp://127.0.0.1', self.port_sub_parameters)
self.socket_sub_parameters.subscribe(self.parameters_topic)
# Setup the socket that pushes the data to the com
self.socket_push_data = Socket(self.context, zmq.PUSH)
self.socket_push_data.setsockopt(zmq.LINGER, 0)
self.socket_push_data.set_hwm(1)
self.socket_push_data.bind(r"tcp://127.0.0.1:{}".format(self.data_port))
# Setup the socket that receives the heartbeat from the com
self.socket_pull_heartbeat = self.context.socket(zmq.PULL)
self.socket_pull_heartbeat.setsockopt(zmq.LINGER, 0)
self.ssh_com.connect_socket_to_local(self.socket_pull_heartbeat, r'tcp://127.0.0.1', self.pull_heartbeat_port)
# Setup the socket that publishes the fact that the worker_exec is up and running to the node com so that it
# can then update the parameters of the worker_exec.
self.socket_pub_proof_of_life = Socket(self.context, zmq.PUB)
self.socket_pub_proof_of_life.setsockopt(zmq.LINGER, 0)
self.ssh_com.connect_socket_to_local(self.socket_pub_proof_of_life, r'tcp://127.0.0.1',
self.port_pub_proof_of_life, skip_ssh=True)
def send_data_to_com(self, data):
self.socket_push_data.send_array(data, copy=False)
self.index += 1
def import_reliquery(self):
"""
This import is required because it takes a good few seconds to load the package and if the import is done
first time in the HeronRelic instance that delays the initialisation of the worker process which can be
a problem
:return: Nothing
"""
#
if self.relic_path != '_':
try:
import reliquery
import reliquery.storage
except ImportError:
pass
def relic_create_parameters_df(self, **parameters):
"""
Creates a new relic with the Parameters pandasdf in it or adds the Parameters pandasdf in the existing Node's
Relic.
:param parameters: The dictionary of the parameters. The keys of the dict will become the column names of the
pandasdf
:return: Nothing
"""
self._relic_create_df('Parameters', **parameters)
def relic_create_substate_df(self, **variables):
"""
Creates a new relic with the Substate pandasdf in it or adds the Substate pandasdf in the existing Node's Relic.
:param variables: The dictionary of the variables to save. The keys of the dict will become the column names of
the pandasdf
:return: Nothing
"""
self._relic_create_df('Substate', **variables)
def _relic_create_df(self, type, **variables):
"""
Base function to create either a Parameters or a Substate pandasdf in a new or the existing Node's Relic
:param type: Parameters or Substate
:param variables: The variables dictionary to be saved in the pandas. The keys of the dict will become the c
olumn names of the pandasdf
:return: Nothing
"""
if self.heron_relic is None:
self.heron_relic = HeronRelic(self.relic_path, self.node_name,
self.node_index, self.num_of_iters_to_update_relics_substate)
if self.heron_relic.operational:
self.heron_relic.create_the_pandasdf(type, **variables)
def relic_update_substate_df(self, **variables):
"""
Updates the Substate pandasdf of the Node's Relic
:param variables: The Substate's variables dict
:return: Nothing
"""
self.heron_relic.update_the_substate_pandasdf(self.index, **variables)
def update_parameters(self):
"""
This updates the self.parameters from the parameters send form the node (through the gui_com)
If the rlic system is up and running it also saves the new parameters into the Parameters df of the relic
:return: Nothing
"""
try:
topic = self.socket_sub_parameters.recv(flags=zmq.NOBLOCK)
parameters_in_bytes = self.socket_sub_parameters.recv(flags=zmq.NOBLOCK)
args = pickle.loads(parameters_in_bytes)
self.parameters = args
if not self.initialised and self.initialisation_function is not None:
self.initialised = self.initialisation_function(self)
if self.initialised and self.heron_relic is not None and self.heron_relic.operational:
self.heron_relic.update_the_parameters_pandasdf(parameters=self.parameters, worker_index=self.index)
except Exception as e:
pass
def parameters_loop(self):
"""
The loop that updates the arguments (self.parameters)
:return: Nothing
"""
while self.loops_on:
self.update_parameters()
time.sleep(0.2)
def start_parameters_thread(self):
"""
Start the thread that runs the infinite arguments_loop
:return: Nothing
"""
self.thread_parameters = threading.Thread(target=self.parameters_loop, daemon=True)
self.thread_parameters.start()
def heartbeat_loop(self):
"""
The loop that reads the heartbeat 'PULSE' from the source_com. If it takes too long to receive the new one
it kills the worker_exec process
:return: Nothing
"""
while self.loops_on:
if self.socket_pull_heartbeat.poll(timeout=(1000 * ct.HEARTBEAT_RATE * ct.HEARTBEATS_TO_DEATH)):
self.socket_pull_heartbeat.recv()
else:
pid = os.getpid()
self.end_of_life_function()
self.on_kill(pid)
os.kill(pid, signal.SIGTERM)
time.sleep(0.5)
time.sleep(int(ct.HEARTBEAT_RATE))
self.socket_pull_heartbeat.close()
def proof_of_life(self):
"""
When the worker_exec process starts it sends to the gui_com (through the proof_of_life_forwarder thread) a signal
that lets the node (in the gui_com process) that the worker_exec is running and ready to receive parameter updates.
:return: Nothing
"""
#print('---Sending POL {}'.format('topic = {}, msg = POL'.format(self.parameters_topic.encode('ascii'))))
for i in range(100):
try:
self.socket_pub_proof_of_life.send(self.parameters_topic.encode('ascii'), zmq.SNDMORE)
self.socket_pub_proof_of_life.send_string('POL')
except:
pass
time.sleep(0.1)
def start_heartbeat_thread(self):
"""
Start the heartbeat thread that run the infinite heartbeat_loop
:return: Nothing
"""
print('Started Worker {}##{} process with PID = {}'.format(self.node_name, self.node_index, os.getpid()))
self.thread_heartbeat = threading.Thread(target=self.heartbeat_loop, daemon=True)
self.thread_heartbeat.start()
self.thread_proof_of_life = threading.Thread(target=self.proof_of_life, daemon=True)
self.thread_proof_of_life.start()
def on_kill(self, pid):
print('Killing {} {} with pid {}'.format(self.node_name, self.node_index, pid))
if self.heron_relic is not None and self.heron_relic.substate_pandasdf_exists:
self.heron_relic.save_substate_at_death()
try:
self.loops_on = False
self.visualisation_on = False
self.socket_sub_parameters.close()
self.socket_push_data.close()
self.socket_pub_proof_of_life.close()
except Exception as e:
print('Trying to kill Source worker {} failed with error: {}'.format(self.node_name, e))
finally:
#self.context.term() # That causes an error
self.ssh_com.kill_tunneling_processes()
class TransformWorker:
def __init__(self,
recv_topics_buffer,
pull_port,
initialisation_function,
work_function,
end_of_life_function,
parameters_topic,
num_sending_topics,
relic_path,
ssh_local_ip=' ',
ssh_local_username='******',
ssh_local_password='******'):
self.pull_data_port = pull_port
self.push_data_port = str(int(self.pull_data_port) + 1)
self.pull_heartbeat_port = str(int(self.pull_data_port) + 2)
self.initialisation_function = initialisation_function
self.work_function = work_function
self.end_of_life_function = end_of_life_function
self.parameters_topic = parameters_topic
self.num_sending_topics = int(num_sending_topics)
self.recv_topics_buffer = recv_topics_buffer
self.node_name = parameters_topic.split('##')[-2]
self.node_index = self.parameters_topic.split('##')[-1]
self.relic_path = relic_path
self.import_reliquery()
self.heron_relic = None
self.num_of_iters_to_update_relics_substate = None
self.ssh_com = SSHCom(ssh_local_ip=ssh_local_ip,
ssh_local_username=ssh_local_username,
ssh_local_password=ssh_local_password)
self.time_of_pulse = time.perf_counter()
self.port_sub_parameters = ct.PARAMETERS_FORWARDER_PUBLISH_PORT
self.port_pub_proof_of_life = ct.PROOF_OF_LIFE_FORWARDER_SUBMIT_PORT
self.loops_on = True
self.initialised = False
self.context = None
self.socket_pull_data = None
self.stream_pull_data = None
self.socket_push_data = None
self.socket_sub_parameters = None
self.stream_parameters = None
self.parameters = None
self.socket_pull_heartbeat = None
self.stream_heartbeat = None
self.thread_heartbeat = None
self.socket_pub_proof_of_life = None
self.thread_proof_of_life = None
self.worker_visualisable_result = None
self.index = 0
def connect_sockets(self):
"""
Sets up the sockets to do the communication with the transform_com process through the forwarders
(for the link and the parameters).
:return: Nothing
"""
self.context = zmq.Context()
# Setup the socket and the stream that receives the pre-transformed data from the com
self.socket_pull_data = Socket(self.context, zmq.PULL)
self.socket_pull_data.setsockopt(zmq.LINGER, 0)
self.socket_pull_data.set_hwm(1)
self.ssh_com.connect_socket_to_local(self.socket_pull_data,
r'tcp://127.0.0.1',
self.pull_data_port)
self.stream_pull_data = zmqstream.ZMQStream(self.socket_pull_data)
self.stream_pull_data.on_recv(self.data_callback, copy=False)
# Setup the socket and the stream that receives the parameters of the worker_exec function from the node (gui_com)
self.socket_sub_parameters = Socket(self.context, zmq.SUB)
self.socket_sub_parameters.setsockopt(zmq.LINGER, 0)
self.ssh_com.connect_socket_to_local(self.socket_sub_parameters,
r'tcp://127.0.0.1',
self.port_sub_parameters)
self.socket_sub_parameters.subscribe(self.parameters_topic)
self.stream_parameters = zmqstream.ZMQStream(
self.socket_sub_parameters)
self.stream_parameters.on_recv(self.parameters_callback, copy=False)
# Setup the socket that pushes the transformed data to the com
self.socket_push_data = Socket(self.context, zmq.PUSH)
self.socket_push_data.setsockopt(zmq.LINGER, 0)
self.socket_push_data.set_hwm(1)
self.socket_push_data.bind(r"tcp://127.0.0.1:{}".format(
self.push_data_port))
# Setup the socket that receives the heartbeat from the com
self.socket_pull_heartbeat = self.context.socket(zmq.PULL)
self.socket_pull_heartbeat.setsockopt(zmq.LINGER, 0)
self.ssh_com.connect_socket_to_local(self.socket_pull_heartbeat,
r'tcp://127.0.0.1',
self.pull_heartbeat_port)
self.stream_heartbeat = zmqstream.ZMQStream(self.socket_pull_heartbeat)
self.stream_heartbeat.on_recv(self.heartbeat_callback, copy=False)
# Setup the socket that publishes the fact that the worker_exec is up and running to the node com so that it
# can then update the parameters of the worker_exec
self.socket_pub_proof_of_life = Socket(self.context, zmq.PUB)
self.socket_pub_proof_of_life.setsockopt(zmq.LINGER, 0)
self.ssh_com.connect_socket_to_local(self.socket_pub_proof_of_life,
r'tcp://127.0.0.1',
self.port_pub_proof_of_life,
skip_ssh=True)
def data_callback(self, data):
"""
The callback that is called when link is send from the previous com process this com process is connected to
(receives link from and shares a common topic) and pushes the link to the worker_exec.
The link is a three zmq.Frame list. The first is the topic (used for the worker_exec to distinguish which input the
link has come from in the case of multiple input nodes). The other two items are the details and the link load
of the numpy array coming from the previous node).
The link's load is then given to the work_function of the worker (together with the parameters of the node)
and the result is sent to the com process to be passed on.
The result must be a list of numpy arrays! Each element of the list represent one output of the node in the
same order as the order of Outputs specified in the xxx_com.py of the node
The callback will call the work_function only if the self.initialised is True (i.e. if the parameters_callback
has had a chance to call the initialisation_function and get back a True). Otherwise it will pass to the com
a set of ct.IGNORE (as many as the Node's outputs).
:param data: The link received
:return: Nothing
"""
if self.initialised:
data = [data[0].bytes, data[1].bytes, data[2].bytes]
try:
results = self.work_function(data, self.parameters,
self.relic_update_substate_df)
except TypeError:
results = self.work_function(data, self.parameters)
for i, array_in_list in enumerate(results):
if i < len(results) - 1:
self.socket_push_data.send_array(array_in_list,
flags=zmq.SNDMORE,
copy=False)
else:
self.socket_push_data.send_array(array_in_list, copy=False)
self.index += 1
else:
send_topics = 0
while send_topics < self.num_sending_topics - 1:
self.socket_push_data.send_array(np.array([ct.IGNORE]),
flags=zmq.SNDMORE,
copy=False)
send_topics += 1
self.socket_push_data.send_array(np.array([ct.IGNORE]), copy=False)
def import_reliquery(self):
"""
This import is required because it takes a good few seconds to load the package and if the import is done
first time in the HeronRelic instance that delays the initialisation of the worker process which can be
a problem
:return: Nothing
"""
#
if self.relic_path != '_':
try:
import reliquery
import reliquery.storage
except ImportError:
pass
def relic_create_parameters_df(self, **parameters):
"""
Creates a new relic with the Parameters pandasdf in it or adds the Parameters pandasdf in the existing Node's
Relic.
:param parameters: The dictionary of the parameters. The keys of the dict will become the column names of the
pandasdf
:return: Nothing
"""
self._relic_create_df('Parameters', **parameters)
def relic_create_substate_df(self, **variables):
"""
Creates a new relic with the Substate pandasdf in it or adds the Substate pandasdf in the existing Node's Relic.
:param variables: The dictionary of the variables to save. The keys of the dict will become the column names of
the pandasdf
:return: Nothing
"""
self._relic_create_df('Substate', **variables)
def _relic_create_df(self, type, **variables):
"""
Base function to create either a Parameters or a Substate pandasdf in a new or the existing Node's Relic
:param type: Parameters or Substate
:param variables: The variables dictionary to be saved in the pandas. The keys of the dict will become the c
olumn names of the pandasdf
:return: Nothing
"""
if self.heron_relic is None:
self.heron_relic = HeronRelic(
self.relic_path, self.node_name, self.node_index,
self.num_of_iters_to_update_relics_substate)
if self.heron_relic.operational:
self.heron_relic.create_the_pandasdf(type, **variables)
def relic_update_substate_df(self, **variables):
"""
Updates the Substate pandasdf of the Node's Relic
:param variables: The Substate's variables dict
:return: Nothing
"""
self.heron_relic.update_the_substate_pandasdf(self.index, **variables)
def parameters_callback(self, parameters_in_bytes):
"""
The callback called when there is an update of the parameters (worker_exec function's parameters) from the node
(send by the gui_com)
:param parameters_in_bytes:
:return:
"""
#print('UPDATING PARAMETERS OF {} {}'.format(self.node_name, self.node_index))
if len(parameters_in_bytes) > 1:
args_pyobj = parameters_in_bytes[1].bytes # remove the topic
args = pickle.loads(args_pyobj)
if args is not None:
self.parameters = args
if not self.initialised and self.initialisation_function is not None:
self.initialised = self.initialisation_function(self)
#print('Updated parameters in {} = {}'.format(self.parameters_topic, args))
if self.initialised and self.heron_relic is not None and self.heron_relic.operational:
self.heron_relic.update_the_parameters_pandasdf(
parameters=self.parameters, worker_index=self.index)
def heartbeat_callback(self, pulse):
"""
The callback called when the com sends a 'PULSE'. It registers the time the 'PULSE' has been received
:param pulse: The pulse (message from the com's push) received
:return:
"""
self.time_of_pulse = time.perf_counter()
def heartbeat_loop(self):
"""
The loop that checks whether the latest 'PULSE' received from the com's heartbeat push is not too stale.
If it is then the current process is killed
:return: Nothing
"""
while self.loops_on:
current_time = time.perf_counter()
if current_time - self.time_of_pulse > ct.HEARTBEAT_RATE * ct.HEARTBEATS_TO_DEATH:
pid = os.getpid()
self.end_of_life_function()
self.on_kill(pid)
os.kill(pid, signal.SIGTERM)
time.sleep(0.5)
time.sleep(ct.HEARTBEAT_RATE)
self.socket_pull_heartbeat.close()
def proof_of_life(self):
"""
When the worker_exec process starts AND ONCE IT HAS RECEIVED ITS FIRST BUNCH OF DATA, it sends to the gui_com
(through the proof_of_life_forwarder thread) a signal that lets the node (in the gui_com process) that the
worker_exec is running and ready to receive parameter updates.
:return: Nothing
"""
#print('---Sending POL {}'.format('{}##POL'.format(self.parameters_topic)))
for i in range(100):
try:
self.socket_pub_proof_of_life.send(
self.parameters_topic.encode('ascii'), zmq.SNDMORE)
self.socket_pub_proof_of_life.send_string('POL')
except:
pass
time.sleep(0.1)
#print('--- Finished sending POL from {} {}'.format(self.node_name, self.node_index))
def start_ioloop(self):
"""
Starts the heartbeat thread daemon and the ioloop of the zmqstreams
:return: Nothing
"""
self.thread_heartbeat = threading.Thread(target=self.heartbeat_loop,
daemon=True)
self.thread_heartbeat.start()
self.thread_proof_of_life = threading.Thread(target=self.proof_of_life,
daemon=True)
self.thread_proof_of_life.start()
print('Started Worker {}_{} process with PID = {}'.format(
self.node_name, self.node_index, os.getpid()))
ioloop.IOLoop.instance().start()
print('!!! WORKER {} HAS STOPPED'.format(self.parameters_topic))
def on_kill(self, pid):
print('Killing {} {} with pid {}'.format(self.node_name,
self.node_index, pid))
if self.heron_relic is not None and self.heron_relic.substate_pandasdf_exists:
self.heron_relic.save_substate_at_death()
try:
self.visualisation_on = False
self.loops_on = False
self.stream_pull_data.close()
self.stream_parameters.close()
self.stream_heartbeat.close()
self.socket_pull_data.close()
self.socket_sub_parameters.close()
self.socket_push_data.close()
self.socket_pub_proof_of_life.close()
except Exception as e:
print('Trying to kill Transform worker {} failed with error: {}'.
format(self.node_name, e))
finally:
self.context.term()
self.ssh_com.kill_tunneling_processes()
class Node:
def __init__(self, name, parent):
self.id = None
self.name = name
self.parent = parent
self.operation = None
self.node_index = None
self.process = None
self.topics_out = []
self.topics_in = []
self.links_list = []
self.starting_port = None
self.num_of_inputs = 0
self.num_of_outputs = 0
self.coordinates = [100, 100]
self.node_parameters = None
self.node_parameters_combos_items = []
self.parameter_inputs_ids = {}
self.com_verbosity = ''
self.relic_verbosity = ''
self.verbose = ''
self.context = None
self.socket_pub_parameters = None
self.socket_sub_proof_of_life = None
self.theme_id = None
self.extra_window_id = None
self.operations_list = op.operations_list
self.get_corresponding_operation()
self.get_node_index()
self.assign_default_parameters()
self.get_numbers_of_inputs_and_outputs()
#self.generate_default_topics()
self.ssh_server_id_and_names = None
self.get_ssh_server_names_and_ids()
self.ssh_local_server = self.ssh_server_id_and_names[0]
self.ssh_remote_server = self.ssh_server_id_and_names[0]
self.worker_executable = self.operation.worker_exec
def get_attribute_order(self, type):
number_of_static_attrs = 0
for at in self.operation.attribute_types:
if 'Static' in at:
number_of_static_attrs += 1
number_of_input_attrs = 0
number_of_output_attrs = 0
order = {}
for at, attr_order_num in zip(self.operation.attribute_types,
range(len(self.operation.attributes))):
if type == 'Input' and type in at:
order[self.operation.
attributes[attr_order_num]] = number_of_input_attrs
number_of_input_attrs += 1
if type == 'Output' and type in at:
order[self.operation.
attributes[attr_order_num]] = number_of_output_attrs
number_of_output_attrs += 1
return order
def initialise_parameters_socket(self):
if self.context is None:
self.context = zmq.Context()
self.socket_pub_parameters = Socket(self.context, zmq.PUB)
self.socket_pub_parameters.setsockopt(zmq.LINGER, 0)
self.socket_pub_parameters.connect(r"tcp://127.0.0.1:{}".format(
ct.PARAMETERS_FORWARDER_SUBMIT_PORT))
def initialise_proof_of_life_socket(self):
if self.context is None:
self.context = zmq.Context()
self.socket_sub_proof_of_life = self.context.socket(zmq.SUB)
self.socket_sub_proof_of_life.setsockopt(zmq.LINGER, 0)
self.socket_sub_proof_of_life.connect(r"tcp://127.0.0.1:{}".format(
ct.PROOF_OF_LIFE_FORWARDER_PUBLISH_PORT))
self.socket_sub_proof_of_life.setsockopt(
zmq.SUBSCRIBE, '{}'.format(self.name.replace(' ',
'_')).encode('ascii'))
def remove_from_editor(self):
dpg.remove_alias('verb#{}#{}'.format(self.operation.name,
self.node_index))
if dpg.does_alias_exist('relic#{}#{}'.format(self.operation.name,
self.node_index)):
dpg.remove_alias('relic#{}#{}'.format(self.operation.name,
self.node_index))
dpg.delete_item(self.id)
def get_numbers_of_inputs_and_outputs(self):
for at in self.operation.attribute_types:
if at == 'Input':
self.num_of_inputs = self.num_of_inputs + 1
if at == 'Output':
self.num_of_outputs = self.num_of_outputs + 1
def get_corresponding_operation(self):
name = self.name.split('##')[0]
for op in self.operations_list:
if op.name == name:
self.operation = copy.deepcopy(op)
break
def assign_default_parameters(self):
self.node_parameters = self.operation.parameters_def_values
for default_parameter in self.operation.parameters_def_values:
if type(default_parameter) == list:
self.node_parameters_combos_items.append(default_parameter)
else:
self.node_parameters_combos_items.append(None)
def get_node_index(self):
self.node_index = self.name.split('##')[-1]
def add_topic_in(self, topic):
topic = topic.replace(' ', '_')
for t in self.topics_in:
if t == topic:
return
self.topics_in.append(topic)
def add_topic_out(self, topic):
topic = topic.replace(' ', '_')
for t in self.topics_out:
if topic == t:
return
self.topics_out.append(topic)
def remove_topic_in(self, topic):
if len(self.topics_in) == 1:
if self.topics_in[0] == topic:
self.topics_in[0] = 'NothingIn'
else:
for i, t in enumerate(self.topics_in):
if t == topic:
# self.topics_in[i] = ''
del self.topics_in[i]
break
def remove_topic_out(self, topic):
if len(self.topics_out) == 1:
if self.topics_out[0] == topic:
self.topics_out[0] = 'NothingOut'
else:
for i, t in enumerate(self.topics_out):
if t == topic:
del self.topics_out[i]
break
def update_parameters(self):
if self.socket_pub_parameters is None:
self.initialise_parameters_socket()
attribute_name = 'Parameters' + '##{}##{}'.format(
self.operation.name, self.node_index)
for i, parameter in enumerate(self.operation.parameters):
self.node_parameters[i] = dpg.get_value(
self.parameter_inputs_ids[parameter])
topic = self.operation.name + '##' + self.node_index
topic = topic.replace(' ', '_')
self.socket_pub_parameters.send_string(topic, flags=zmq.SNDMORE)
self.socket_pub_parameters.send_pyobj(self.node_parameters)
def spawn_node_on_editor(self):
self.context = zmq.Context()
self.initialise_parameters_socket()
with dpg.node(label=self.name,
parent=self.parent,
pos=[self.coordinates[0],
self.coordinates[1]]) as self.id:
colour = choose_color_according_to_operations_type(
self.operation.parent_dir)
with dpg.theme() as self.theme_id:
with dpg.theme_component(0):
dpg.add_theme_color(dpg.mvNodeCol_TitleBar,
colour,
category=dpg.mvThemeCat_Nodes)
dpg.add_theme_color(dpg.mvNodeCol_TitleBarSelected,
colour,
category=dpg.mvThemeCat_Nodes)
dpg.add_theme_color(dpg.mvNodeCol_TitleBarHovered,
colour,
category=dpg.mvThemeCat_Nodes)
dpg.add_theme_color(dpg.mvNodeCol_NodeBackgroundSelected,
[120, 120, 120, 255],
category=dpg.mvThemeCat_Nodes)
dpg.add_theme_color(dpg.mvNodeCol_NodeBackground,
[70, 70, 70, 255],
category=dpg.mvThemeCat_Nodes)
dpg.add_theme_color(dpg.mvNodeCol_NodeBackgroundHovered,
[80, 80, 80, 255],
category=dpg.mvThemeCat_Nodes)
dpg.add_theme_color(dpg.mvNodeCol_NodeOutline,
[50, 50, 50, 255],
category=dpg.mvThemeCat_Nodes)
dpg.add_theme_style(dpg.mvNodeStyleVar_NodeBorderThickness,
x=4,
category=dpg.mvThemeCat_Nodes)
dpg.bind_item_theme(self.id, self.theme_id)
# Loop through all the attributes defined in the operation (as seen in the *_com.py file) and put them on
# the node
same_line_widget_ids = []
for i, attr in enumerate(self.operation.attributes):
if self.operation.attribute_types[i] == 'Input':
attribute_type = dpg.mvNode_Attr_Input
elif self.operation.attribute_types[i] == 'Output':
attribute_type = dpg.mvNode_Attr_Output
elif self.operation.attribute_types[i] == 'Static':
attribute_type = dpg.mvNode_Attr_Static
attribute_name = attr + '##{}##{}'.format(
self.operation.name, self.node_index)
with dpg.node_attribute(label=attribute_name,
parent=self.id,
attribute_type=attribute_type):
if attribute_type == 1:
dpg.add_spacer()
dpg.add_text(label='##' + attr + ' Name{}##{}'.format(
self.operation.name, self.node_index),
default_value=attr)
if 'Parameters' in attr:
for k, parameter in enumerate(
self.operation.parameters):
if self.operation.parameter_types[k] == 'int':
id = dpg.add_input_int(
label='{}##{}'.format(
parameter, attribute_name),
default_value=self.node_parameters[k],
callback=self.update_parameters,
width=100,
min_clamped=False,
max_clamped=False,
min_value=int(-1e8),
max_value=int(1e8),
on_enter=True)
elif self.operation.parameter_types[k] == 'str':
id = dpg.add_input_text(
label='{}##{}'.format(
parameter, attribute_name),
default_value=self.node_parameters[k],
callback=self.update_parameters,
width=100,
on_enter=True)
elif self.operation.parameter_types[k] == 'float':
id = dpg.add_input_float(
label='{}##{}'.format(
parameter, attribute_name),
default_value=self.node_parameters[k],
callback=self.update_parameters,
width=100,
min_clamped=False,
max_clamped=False,
min_value=-1e10,
max_value=1e10,
on_enter=True)
elif self.operation.parameter_types[k] == 'bool':
id = dpg.add_checkbox(
label='{}##{}'.format(
parameter, attribute_name),
default_value=self.node_parameters[k],
callback=self.update_parameters)
elif self.operation.parameter_types[k] == 'list':
default_value = self.node_parameters[k][0]
if type(self.node_parameters[k]) == str:
default_value = self.node_parameters[k]
id = dpg.add_combo(
label='{}##{}'.format(
parameter, attribute_name),
items=self.node_parameters_combos_items[k],
default_value=default_value,
callback=self.update_parameters,
width=100)
self.parameter_inputs_ids[parameter] = id
dpg.add_spacer(label='##Spacing##' + attribute_name,
indent=3)
# Add the extra input button with its popup window for extra inputs like ssh and verbosity
self.extra_input_window()
def extra_input_window(self):
attr = 'Extra_Input'
attribute_name = attr + '##{}##{}'.format(self.operation.name,
self.node_index)
with dpg.node_attribute(
label=attribute_name,
parent=self.id,
attribute_type=dpg.mvNode_Attr_Static) as attr_id:
image_file = os.path.join(
os.path.dirname(os.path.realpath(__file__)), os.path.pardir,
'resources', 'Blue_glass_button_square_34x34.png')
width, height, channels, data = dpg.load_image(image_file)
with dpg.texture_registry():
texture_id = dpg.add_static_texture(width, height, data)
image_button = dpg.add_image_button(
texture_tag=texture_id,
label='##' + attr +
' Name{}##{}'.format(self.operation.name, self.node_index),
callback=self.update_ssh_combo_boxes)
with dpg.window(
label='##Window#Extra input##{}##{}'.format(
self.operation.name, self.node_index),
width=450,
height=250,
pos=[self.coordinates[0] + 400, self.coordinates[1] + 200],
show=False,
popup=True) as self.extra_window_id:
# Add the local ssh input
dpg.add_spacer(height=10)
with dpg.group(horizontal=True):
dpg.add_spacer(width=10)
dpg.add_text('SSH local server')
dpg.add_spacer(width=80)
dpg.add_text('SSH remote server')
with dpg.group(horizontal=True):
dpg.add_spacer(width=10)
id = dpg.add_combo(
label='##SSH local server##Extra input##{}##{}'.format(
self.operation.name, self.node_index),
items=self.ssh_server_id_and_names,
width=140,
default_value=self.ssh_local_server,
callback=self.assign_local_server)
self.parameter_inputs_ids['SSH local server'] = id
dpg.add_spacer(width=40)
id = dpg.add_combo(
label='##SSH remote server ##Extra input##{}##{}'.
format(self.operation.name, self.node_index),
items=self.ssh_server_id_and_names,
width=140,
default_value=self.ssh_remote_server,
callback=self.assign_remote_server)
self.parameter_inputs_ids['SSH remote server'] = id
dpg.add_spacer(height=10)
with dpg.group(horizontal=True):
dpg.add_spacer(width=10)
dpg.add_text(
'Python script of worker process OR Python.exe and script:'
)
with dpg.group(horizontal=True):
dpg.add_spacer(width=10)
dpg.add_input_text(
label='##Worker executable##Extra input##{}##{}'.
format(self.operation.name, self.node_index),
width=400,
default_value=self.worker_executable,
callback=self.assign_worker_executable)
# Add the verbocity input
dpg.add_spacer(height=6)
with dpg.group(horizontal=True):
dpg.add_spacer(width=10)
attr = 'Log file or Verbosity level:'
attribute_name = attr + '##{}##{}'.format(
self.operation.name, self.node_index)
self.verbosity_id = dpg.add_text(
label='##' + attr + ' Name{}##{}'.format(
self.operation.name, self.node_index),
default_value=attr)
with dpg.group(horizontal=True):
dpg.add_spacer(width=10)
dpg.add_input_text(
label='##{}'.format(attribute_name),
default_value=self.com_verbosity,
callback=self.update_verbosity,
width=400,
hint='Log file name or verbosity level integer.',
tag='verb#{}#{}'.format(self.operation.name,
self.node_index))
if importlib.util.find_spec('reliquery') is not None:
# Create the relic input only if reliquery is present
with dpg.group(horizontal=True):
dpg.add_spacer(width=10)
dpg.add_text(default_value='Save Relic to directory:')
with dpg.group(horizontal=True):
dpg.add_spacer(width=10)
dpg.add_input_text(
default_value=self.relic_verbosity,
callback=self.update_verbosity,
hint=
'The path where the Relic for this worker process will be saved',
tag='relic#{}#{}'.format(self.operation.name,
self.node_index))
def update_verbosity(self, sender, data):
self.com_verbosity = ''
self.relic_verbosity = ''
if importlib.util.find_spec('reliquery') is not None:
self.relic_verbosity = dpg.get_value('relic#{}#{}'.format(
self.operation.name, self.node_index))
self.com_verbosity = dpg.get_value('verb#{}#{}'.format(
self.operation.name, self.node_index))
self.verbose = '{}||{}'.format(self.com_verbosity,
self.relic_verbosity)
def get_ssh_server_names_and_ids(self):
ssh_info_file = os.path.join(
Path(os.path.dirname(os.path.realpath(__file__))).parent,
'communication', 'ssh_info.json')
with open(ssh_info_file) as f:
ssh_info = json.load(f)
self.ssh_server_id_and_names = ['None']
for id in ssh_info:
self.ssh_server_id_and_names.append(id + ' ' +
ssh_info[id]['Name'])
def update_ssh_combo_boxes(self):
dpg.configure_item(self.extra_window_id, show=True)
self.get_ssh_server_names_and_ids()
if dpg.does_item_exist(self.parameter_inputs_ids['SSH local server']):
dpg.configure_item(self.parameter_inputs_ids['SSH local server'],
items=self.ssh_server_id_and_names)
if dpg.does_item_exist(self.parameter_inputs_ids['SSH remote server']):
dpg.configure_item(self.parameter_inputs_ids['SSH remote server'],
items=self.ssh_server_id_and_names)
def assign_local_server(self, sender, data):
self.ssh_local_server = dpg.get_value(sender)
def assign_remote_server(self, sender, data):
self.ssh_remote_server = dpg.get_value(sender)
def assign_worker_executable(self, sender, data):
self.worker_executable = dpg.get_value(sender)
def start_com_process(self):
self.initialise_proof_of_life_socket()
arguments_list = [
'python', self.operation.executable, self.starting_port
]
num_of_inputs = len(self.topics_in)
num_of_outputs = len(self.topics_out)
arguments_list.append(str(num_of_inputs))
if 'Input' in self.operation.attribute_types:
for topic_in in self.topics_in:
arguments_list.append(topic_in)
arguments_list.append(str(num_of_outputs))
if 'Output' in self.operation.attribute_types:
for topic_out in self.topics_out:
arguments_list.append(topic_out)
arguments_list.append(self.name.replace(" ", "_"))
self.update_verbosity(
None, None
) # This is required to make the debugger work because in debug this callback
# is never called
arguments_list.append(str(self.verbose))
arguments_list.append(self.ssh_local_server.split(
' ')[0]) # pass only the ID part of the 'ID name' string
arguments_list.append(self.ssh_remote_server.split(' ')[0])
arguments_list.append(self.worker_executable)
self.process = subprocess.Popen(
arguments_list, creationflags=subprocess.CREATE_NEW_PROCESS_GROUP)
print('Started COM {}_{} process with PID = {}'.format(
self.name, self.node_index, self.process.pid))
# Wait until the worker_exec sends a proof_of_life signal (i.e. it is up and running).
self.wait_for_proof_of_life()
# Then update the parameters
self.update_parameters()
self.start_thread_to_send_parameters_multiple_times()
with dpg.theme_component(0, parent=self.theme_id):
dpg.add_theme_color(dpg.mvNodeCol_NodeOutline,
[255, 255, 255, 255],
category=dpg.mvThemeCat_Nodes)
def sending_parameters_multiple_times(self):
for i in range(ct.NUMBER_OF_INITIAL_PARAMETERS_UPDATES):
self.update_parameters()
time.sleep(0.5)
def start_thread_to_send_parameters_multiple_times(self):
thread_parameters = threading.Thread(
target=self.sending_parameters_multiple_times, daemon=True)
thread_parameters.start()
def wait_for_proof_of_life(self):
self.socket_sub_proof_of_life.recv()
self.socket_sub_proof_of_life.recv_string()
def stop_com_process(self):
try:
self.socket_sub_proof_of_life.disconnect(
r"tcp://127.0.0.1:{}".format(
ct.PROOF_OF_LIFE_FORWARDER_PUBLISH_PORT))
self.socket_sub_proof_of_life.close()
except:
pass
if platform.system() == 'Windows':
self.process.send_signal(signal.CTRL_BREAK_EVENT)
elif platform.system() == 'Linux':
self.process.terminate()
time.sleep(0.5)
self.process.kill()
self.process = None
with dpg.theme_component(0, parent=self.theme_id):
dpg.add_theme_color(dpg.mvNodeCol_NodeOutline, [50, 50, 50, 255],
category=dpg.mvThemeCat_Nodes)
