Skip to main content

prefect.cli.flow_runs_watching

Utilities for following flow runs with interleaved events and logs

Functions

watch_flow_run

watch_flow_run(flow_run_id: UUID, console: Console, timeout: int | None = None) -> FlowRun
Watch a flow run, displaying interleaved events and logs until completion. Args:
  • flow_run_id: The ID of the flow run to watch
  • console: Rich console for output
  • timeout: Maximum time to wait for flow run completion in seconds. If None, waits indefinitely.
Returns:
  • The finished flow run
Raises:
  • FlowRunWaitTimeout: If the flow run exceeds the timeout

Classes

FlowRunFormatter

Handles formatting of logs and events for CLI display Methods:

format

format(self, item: Log | Event) -> str
Format a log or event for display

format_event

format_event(self, event: Event) -> str
Format an event

format_log

format_log(self, log: Log) -> str
Format a log entry

format_run_id

format_run_id(self, run_id_short: str) -> str
Format run ID

format_timestamp

format_timestamp(self, dt: datetime) -> str
Format timestamp with incremental display
I