dplutils.pipeline.PipelineGraph

class dplutils.pipeline.PipelineGraph(graph=None)

Graph of pipeline tasks.

This class adds convenience functionality for task pipeline handling on top of networkx.DiGraph on which it is based.

Parameters:

graph – This is either a list of PipelineTask objects representing a simple-graph, or anything that is legal input to networkx.DiGraph.

__init__(graph=None)

Initialize a graph with edges, name, or graph attributes.

Parameters:

• incoming_graph_data (input graph (optional, default: None)) – Data to initialize graph. If None (default) an empty graph is created. The data can be an edge list, or any NetworkX graph object. If the corresponding optional Python packages are installed the data can also be a 2D NumPy array, a SciPy sparse array, or a PyGraphviz graph.

• attr (keyword arguments, optional (default= no attributes)) – Attributes to add to graph as key=value pairs.

See also

convert

Examples

>>> G = nx.Graph()  # or DiGraph, MultiGraph, MultiDiGraph, etc
>>> G = nx.Graph(name="my graph")
>>> e = [(1, 2), (2, 3), (3, 4)]  # list of edges
>>> G = nx.Graph(e)

Arbitrary graph attribute pairs (key=value) may be assigned

>>> G = nx.Graph(e, day="Friday")
>>> G.graph
{'day': 'Friday'}

Methods

__init__([graph])	Initialize a graph with edges, name, or graph attributes.
add_edge(u_of_edge, v_of_edge, **attr)	Add an edge between u and v.
add_edges_from(ebunch_to_add, **attr)	Add all the edges in ebunch_to_add.
add_node(node_for_adding, **attr)	Add a single node node_for_adding and update node attributes.
add_nodes_from(nodes_for_adding, **attr)	Add multiple nodes.
add_weighted_edges_from(ebunch_to_add[, weight])	Add weighted edges in ebunch_to_add with specified weight attr
adjacency()	Returns an iterator over (node, adjacency dict) tuples for all nodes.
clear()	Remove all nodes and edges from the graph.
clear_edges()	Remove all edges from the graph without altering nodes.
copy([as_view])	Returns a copy of the graph.
edge_subgraph(edges)	Returns the subgraph induced by the specified edges.
get_edge_data(u, v[, default])	Returns the attribute dictionary associated with edge (u, v).
has_edge(u, v)	Returns True if the edge (u, v) is in the graph.
has_node(n)	Returns True if the graph contains the node n.
has_predecessor(u, v)	Returns True if node u has predecessor v.
has_successor(u, v)	Returns True if node u has successor v.
is_directed()	Returns True if graph is directed, False otherwise.
is_multigraph()	Returns True if graph is a multigraph, False otherwise.
nbunch_iter([nbunch])	Returns an iterator over nodes contained in nbunch that are also in the graph.
neighbors(n)	Returns an iterator over successor nodes of n.
number_of_edges([u, v])	Returns the number of edges between two nodes.
number_of_nodes()	Returns the number of nodes in the graph.
order()	Returns the number of nodes in the graph.
predecessors(n)	Returns an iterator over predecessor nodes of n.
rank_nodes([reverse, source, sink])	Rank nodes based on distance from source/sink
remove_edge(u, v)	Remove the edge between u and v.
remove_edges_from(ebunch)	Remove all edges specified in ebunch.
remove_node(n)	Remove node n.
remove_nodes_from(nodes)	Remove multiple nodes.
reverse([copy])	Returns the reverse of the graph.
size([weight])	Returns the number of edges or total of all edge weights.
subgraph(nodes)	Returns a SubGraph view of the subgraph induced on nodes.
successors(n)	Returns an iterator over successor nodes of n.
to_directed([as_view])	Returns a directed representation of the graph.
to_directed_class()	Returns the class to use for empty directed copies.
to_list()	Return list representation of task iff it is a simple-path graph
to_undirected([reciprocal, as_view])	Returns an undirected representation of the digraph.
to_undirected_class()	Returns the class to use for empty undirected copies.
update([edges, nodes])	Update the graph using nodes/edges/graphs as input.
walk_back([source, sort_key])	Walk graph backward in breadth-first order from source
walk_fwd([source, sort_key])	Walk graph forward in breadth-first order from source
with_terminals()

Attributes

adj	Graph adjacency object holding the neighbors of each node.
degree	A DegreeView for the Graph as G.degree or G.degree().
edges	An OutEdgeView of the DiGraph as G.edges or G.edges().
in_degree	An InDegreeView for (node, in_degree) or in_degree for single node.
in_edges	A view of the in edges of the graph as G.in_edges or G.in_edges().
name	String identifier of the graph.
nodes	A NodeView of the Graph as G.nodes or G.nodes().
out_degree	An OutDegreeView for (node, out_degree)
out_edges	An OutEdgeView of the DiGraph as G.edges or G.edges().
pred	Graph adjacency object holding the predecessors of each node.
sink_tasks
source_tasks
succ	Graph adjacency object holding the successors of each node.
task_map