def
status
cauldron.display.status()

Updates the status display, which is only visible while a step is running. This is useful for providing feedback and information during long-running steps. A section progress is also available for cases where long running tasks consist of multiple tasks and you want to display sub-progress messages within the context of the larger status. Note: this is only supported when running in the Cauldron desktop application.

Arguments
Required
Optional
message

str

The status message you want to display. If left blank the previously set status message will be retained. Should you desire to remove an existing message, specify a blank string for this argument.

Default Value: 

None

progress

float

A number between zero and one that indicates the overall progress for the current status. If no value is specified, the previously assigned progress will be retained.

Default Value: 

None

section_message

str

The status message you want to display for a particular task within a long-running step. If left blank the previously set section message will be retained. Should you desire to remove an existing message, specify a blank string for this argument.

Default Value: 

None

section_progress

float

A number between zero and one that indicates the progress for the current section status. If no value is specified, the previously assigned section progress value will be retained.

Default Value: 

None