apache_beam.runners.interactive.display.display_manager module

Manages displaying pipeline graph and execution status on the frontend.

This module is experimental. No backwards-compatibility guarantees.

class apache_beam.runners.interactive.display.display_manager.DisplayManager(pipeline_proto, pipeline_analyzer, cache_manager, pipeline_graph_renderer)

Bases: object

Manages displaying pipeline graph and execution status on the frontend.

Constructor of DisplayManager.

Parameters:

• pipeline_proto – (Pipeline proto)
• pipeline_analyzer – (PipelineAnalyzer) the pipeline analyzer that corresponds to this round of execution. This will provide more detailed informations about the pipeline
• cache_manager – (interactive_runner.CacheManager) DisplayManager fetches the latest status of pipeline execution by querying cache_manager.
• pipeline_graph_renderer – (pipeline_graph_renderer.PipelineGraphRenderer) decides how a pipeline graph is rendered.

update_display(force=False)

Updates display on the frontend.

Retrieves the latest execution status by querying CacheManager and updates display on the fronend. The assumption is that there is only one pipeline in a cell, because it clears up everything in the cell output every update cycle.

Parameters:force – (bool) whether to force updating when no stats change happens.

start_periodic_update()

Start a thread that periodically updates the display.

stop_periodic_update()

Stop periodically updating the display.