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: BeamPlugin

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

abstract classmethod option() → str[source]

The corresponding rendering option for the renderer.

abstract render_pipeline_graph(pipeline_graph: PipelineGraph) → str[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.

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

Bases: PipelineGraphRenderer

Use this renderer to mute the pipeline display.

classmethod option() → str[source]
render_pipeline_graph(pipeline_graph: PipelineGraph) → str[source]
class apache_beam.runners.interactive.display.pipeline_graph_renderer.TextRenderer[source]

Bases: PipelineGraphRenderer

This renderer simply returns the dot representation in text format.

classmethod option() → str[source]
render_pipeline_graph(pipeline_graph: PipelineGraph) → str[source]
class apache_beam.runners.interactive.display.pipeline_graph_renderer.PydotRenderer[source]

Bases: 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() → str[source]
render_pipeline_graph(pipeline_graph: PipelineGraph) → str[source]
apache_beam.runners.interactive.display.pipeline_graph_renderer.get_renderer(option: str | None = None) → Type[PipelineGraphRenderer][source]

Get an instance of PipelineGraphRenderer given rendering option.

Parameters:

option – (str) the rendering option.

Returns:

(PipelineGraphRenderer)