yr.action

action(
    message: str,
) → ActionStream

Mark a unit of app work in progress.

Use as a context manager: the action is shown as active while the block runs and marked complete on exit. The update method on the returned stream can change the message mid-flight.

Parameters

message
type: str

Initial description of the work in progress.

Returns

type: ActionStream

An ActionStream context manager.