obci.control.common package

Submodules

obci.control.common.cfg_messages_pb2 module

obci.control.common.config_helpers module

exception obci.control.common.config_helpers.OBCISystemError

Bases: Exception

obci.control.common.config_helpers.argument_not_empty_check(p_arg)

obci.control.common.config_helpers.module_id_type_check(p_module_id)

obci.control.common.config_helpers.param_name_type_check(p_param_name)

obci.control.common.config_helpers.reference_split(p_reference)

obci.control.common.config_helpers.reference_type_check(p_reference)

obci.control.common.config_message module

exception obci.control.common.config_message.ConfigMessageError

Bases: Exception

obci.control.common.config_message.dict2params(dic, config_params_msg, field_name='params')

Take parameters from the dictionary dic, encode values to json and put them in the config_params_msg. The message should have a ‘params’ attribute

obci.control.common.config_message.fill_and_pack(mx_type, **kwargs)

obci.control.common.config_message.fill_msg(mx_type, **kwargs)

This does NOT encode any values to json!

obci.control.common.config_message.launcher_cmd(sender_id, encoded_launcher_msg)

obci.control.common.config_message.msg_for_type(mx_type)

obci.control.common.config_message.msg_to_dict(msg, val_f=None)

Does not convert nested messages!

obci.control.common.config_message.pack_msg(msg)

obci.control.common.config_message.params2dict(config_params_msg, field_name='params')

Take parameters from the config_params_msg, put them in a dictionary (with decoded values from json) and return it. The message should have a ‘params’ attribute

obci.control.common.config_message.str2val(string)

obci.control.common.config_message.unpack_msg(mx_type, msg_str)

obci.control.common.config_message.val2str(value)

obci.control.common.graph module

class obci.control.common.graph.Graph(bidirectional=False)

Bases: object

add_edge(v_a, v_z)

add_vertex(vertex)

copy()

is_bidirectional()

remove_edge(edge)

remove_vertex(vertex)

topo_sort()

vertices()

class obci.control.common.graph.Vertex(graph, model, id_method=None)

Bases: object

copy(new_graph)

in_edges()

neighbours()

out_edges()

obci.control.common.message module

class obci.control.common.message.LauncherMessage

Bases: object

ParseFromString(bytes)

SerializeToString()

dict()

keys()

raw()

exception obci.control.common.message.OBCIMessageError

Bases: Exception

class obci.control.common.message.OBCIMessageTool(msg_templates, errors=[])

Bases: object

add_templates(msg_templates)

decode_msg(msg)

fill_msg(msg_type, **kwargs)

unpack_msg(msg)

class obci.control.common.message.PollingObject

Bases: object

poll_recv(socket, timeout)

obci.control.common.message.recv_msg(sock, flags=0)

obci.control.common.message.send_msg(sock, message, flags=0)

obci.control.common.net_tools module

class obci.control.common.net_tools.DNS(allowed_silence_time=45, logger=None)

Bases: object

clean_silent()

copy()

dict_snapshot()

hostname(ip=None, uuid=None)

http_addr(hostname=None, ip=None, uuid=None)

ip(hostname=None, uuid=None)

is_this_machine(address)

mass_update(server_dict)

snapshot()

tcp_rep_addr(hostname=None, ip=None, uuid=None)

this_addr_local()

this_addr_network()

update(ip, hostname, uuid, rep_port, pub_port, http_port=None)

class obci.control.common.net_tools.PeerNetworkDescriptor(ip, hostname, uuid, rep_port, pub_port, http_port=None, timestamp=None)

Bases: object

as_dict()

obci.control.common.net_tools.addr_is_local(addr)

obci.control.common.net_tools.choose_addr(addr_list)

obci.control.common.net_tools.choose_local(addrs, ip=False)

obci.control.common.net_tools.choose_not_local(addrs)

obci.control.common.net_tools.ext_ip(peer_ip=None)

obci.control.common.net_tools.is_ip(addr_string)

obci.control.common.net_tools.is_net_addr(addr)

obci.control.common.net_tools.lo_ip()

obci.control.common.net_tools.peer_loglevel()

obci.control.common.net_tools.port(addr_string)

obci.control.common.net_tools.server_address(sock_type='rep', local=False, peer_ip=None)

obci.control.common.net_tools.server_bcast_port()

obci.control.common.net_tools.server_pub_port()

obci.control.common.net_tools.server_rep_port()

obci.control.common.net_tools.server_tcp_proxy_port()

obci.control.common.obci_control_settings module

Module contents