yr.spinner

spinner(
    message: str,
) → SpinnerStream

Show a spinner with a message while a block of work runs.

Use as a context manager: the spinner shows while the block runs and is removed on exit. The update method on the returned stream can change the message mid-flight.

Parameters

message
type: str

Initial message shown alongside the spinner.

Returns

type: SpinnerStream

A SpinnerStream context manager.