All docs
Context·
method
StepContext.progress
reports run progress from 0 to 1 with an optional message
Python
progress(fraction: float, message: str = "") -> None
Parameters#
| name | type | default | description |
|---|---|---|---|
fraction |
float |
— | progress in [0, 1] (clamped to that range) |
message |
str |
"" |
optional status text shown alongside the bar |
Example#
Python
@tool.shape
def heavy(t: Table, ctx: StepContext) -> Table:
ctx.progress(0.25, "reading rows")
return t
Notes#
fraction is clamped to [0, 1]. Reporting is best-effort: it emits a pipeline/step/progress
event only when a bus is set, and never fails the step if emission raises. It is cache-neutral —
calling it does not affect the resume cache.
See also#
API: cancelled · emit · set_output · StepContext
Guides: Parameters vs ports
By LSD Team · Last updated Jul 17, 2026
Ask on Discord
View as Markdown