apache_beam.runners.interactive.display.pipeline_graph_renderer module

For rendering pipeline graph in HTML-compatible format.

This module is experimental. No backwards-compatibility guarantees.

class apache_beam.runners.interactive.display.pipeline_graph_renderer.PipelineGraphRenderer[source]

Bases: apache_beam.utils.plugin.BeamPlugin

Abstract class for renderers, who decide how pipeline graphs are rendered.

classmethod option()[source]

The corresponding rendering option for the renderer.

render_pipeline_graph(pipeline_graph)[source]

Renders the pipeline graph in HTML-compatible format.

Parameters:pipeline_graph – (pipeline_graph.PipelineGraph) the graph to be rendererd.
Returns:unicode, str or bytes that can be expressed as HTML.
classmethod get_all_plugin_paths()

Get full import paths of the BeamPlugin subclass.

classmethod get_all_subclasses()

Get all the subclasses of the BeamPlugin class.

class apache_beam.runners.interactive.display.pipeline_graph_renderer.MuteRenderer[source]

Bases: apache_beam.runners.interactive.display.pipeline_graph_renderer.PipelineGraphRenderer

Use this renderer to mute the pipeline display.

classmethod option()[source]
render_pipeline_graph(pipeline_graph)[source]
classmethod get_all_plugin_paths()

Get full import paths of the BeamPlugin subclass.

classmethod get_all_subclasses()

Get all the subclasses of the BeamPlugin class.

class apache_beam.runners.interactive.display.pipeline_graph_renderer.TextRenderer[source]

Bases: apache_beam.runners.interactive.display.pipeline_graph_renderer.PipelineGraphRenderer

This renderer simply returns the dot representation in text format.

classmethod option()[source]
render_pipeline_graph(pipeline_graph)[source]
classmethod get_all_plugin_paths()

Get full import paths of the BeamPlugin subclass.

classmethod get_all_subclasses()

Get all the subclasses of the BeamPlugin class.

class apache_beam.runners.interactive.display.pipeline_graph_renderer.PydotRenderer[source]

Bases: apache_beam.runners.interactive.display.pipeline_graph_renderer.PipelineGraphRenderer

This renderer renders the graph using pydot.

It depends on
  1. The software Graphviz: https://www.graphviz.org/
  2. The python module pydot: https://pypi.org/project/pydot/
classmethod option()[source]
render_pipeline_graph(pipeline_graph)[source]
classmethod get_all_plugin_paths()

Get full import paths of the BeamPlugin subclass.

classmethod get_all_subclasses()

Get all the subclasses of the BeamPlugin class.

apache_beam.runners.interactive.display.pipeline_graph_renderer.get_renderer(option=None)[source]

Get an instance of PipelineGraphRenderer given rendering option.

Parameters:option – (str) the rendering option.
Returns:(PipelineGraphRenderer)