koi_net.infra.build_artifact

Classes

BuildArtifact(assembler)

Used by the Assembler to determine the initialization, start and stop order of components using a graph solver.

class koi_net.infra.build_artifact.BuildArtifact(assembler)

Bases: object

Used by the Assembler to determine the initialization, start and stop order of components using a graph solver.

Parameters:

assembler (Assembler)

assembler: Assembler

build()

Builds artifact, populates orderings.

build_init_graph()

Builds initialization dependency graph and component type map. Results stored in init_graph and comp_types.

Graph representation is an adjacency list: the key is a component name, and the value is a tuple containing names of the depedencies.

build_start_graph()

Builds start dependency graph, results stored in start_graph.

build_stop_graph()

Builds stop dependency graph, results stored in stop_graph.

build_stop_order(start_order)

Builds component stop order.

Reverse of start order, only including components with a stop method.

Note

Components defining a stop method MUST also define a start method.

Return type:

list[str]

Parameters:

start_order (list[str])

collect_components()

Collects components from the assembler’s class variable definitions.

comp_dict: dict[str, Any]

comp_types: dict[str, CompType]

init_graph: dict[str, set[str]]

init_order: list[str]

static reverse_adj_list(adj)

Parameters:

adj (dict[str, set[str]])

start_graph: dict[str, set[str]]

start_order: list[str]

stop_graph: dict[str, set[str]]

stop_order: list[str]

static topo_sort(adj)

Topological sort of directed graph using Kahn’s algorithm.

Parameters:

adj (dict[str, set[str]])

static visualize(adj)

Returns representation of dependency graph in Graphviz DOT language.

Return type:

str

Parameters:

adj (dict[str, list[str]])