cstar.execution.scheduler_job.SchedulerJob.updates

Attention

This project is still in an early phase of development.

The python API is not yet stable, and some aspects of the schema for the blueprint and workplan will likely evolve. Therefore whilst you are welcome to try out using the package, we cannot yet guarantee backwards compatibility. We expect to reach a more stable version in 2026.

cstar.execution.scheduler_job.SchedulerJob.updates#

async SchedulerJob.updates(seconds: float = 10) None#

Stream live updates from the task’s output file.

This method streams updates from the task’s output file for the specified duration. If the task is not running or pending, a message will indicate the inability to provide updates. If the output file exists and the task has already finished, the method provides a reference to the output file for review.

Parameters:

seconds (int, optional, default = 10) – The duration (in seconds) for which updates should be streamed. If set to 0, updates will be streamed indefinitely until interrupted by the user.

Notes

  • This method moves to the end of the output file and streams only new lines appended during the specified duration.

  • When streaming indefinitely (seconds=0), user confirmation is required before proceeding.