apache_beam.runners.interactive.display.pipeline_graph module

For generating Beam pipeline graph in DOT representation.

This module is experimental. No backwards-compatibility guarantees.

class apache_beam.runners.interactive.display.pipeline_graph.PipelineGraph(pipeline, default_vertex_attrs={'shape': 'box'}, default_edge_attrs=None, render_option=None)

Bases: object

Creates a DOT representing the pipeline. Thread-safe. Runner agnostic.

Constructor of PipelineGraph.

Examples

graph = pipeline_graph.PipelineGraph(pipeline_proto) graph.get_dot()

or

graph = pipeline_graph.PipelineGraph(pipeline) graph.get_dot()

Parameters:

• pipeline – (Pipeline proto) or (Pipeline) pipeline to be rendered.
• default_vertex_attrs – (Dict[str, str]) a dict of default vertex attributes
• default_edge_attrs – (Dict[str, str]) a dict of default edge attributes
• render_option – (str) this parameter decides how the pipeline graph is rendered. See display.pipeline_graph_renderer for available options.

get_dot()

display_graph()

Displays the graph generated.