pipert.core.component

Module Contents

Classes

BaseComponent

class pipert.core.component.BaseComponent(component_config, start_component=False)

setup_component(self, component_config)

_replace_queue_names_with_queue_objects(self, routine_parameters_kwargs)

_start(self)

Goes over the component’s routines registered in self.routines and starts running them.

run_comp(self)

Starts running all the component’s routines.

register_routine(self, routine: Union[Routine, Process, Thread])

Registers routine to the list of component’s routines Args:

routine: the routine to register

_teardown_callback(self, *args, **kwargs)

Implemented by subclasses of BaseComponent. Used for stopping or tearing down things that are not stopped by setting the stop_event. Returns: None

stop_run(self)

Signals all the component’s routines to stop.

create_queue(self, queue_name, queue_size=1)

Create a new queue for the component. Returns True if created or False otherwise Args:

queue_name: the name of the queue, must be unique queue_size: the size of the queue

get_queue(self, queue_name)

Returns the queue object by its name Args:

queue_name: the name of the queue

Raises:

KeyError - if no queue has the name

get_all_queue_names(self)

Returns the list of names of queues that the component expose.

does_queue_exist(self, queue_name)

Returns True the component has a queue named queue_name or False otherwise Args:

queue_name: the name of the queue to check

delete_queue(self, queue_name)

Deletes a queue with the name queue_name. Returns True if succeeded. Args:

queue_name: the name of the queue to delete

Raises:

KeyError - if no queue has the name queue_name

does_routine_name_exist(self, routine_name)

remove_routine(self, routine_name)

does_routines_use_queue(self, queue_name)

is_component_running(self)

get_routines(self)

get_component_configuration(self)

_get_routine_creation(self, routine)

set_monitoring_system(self, monitoring_system_parameters)

set_routine_attribute(self, routine_name, attribute_name, attribute_value)