rs_rich.ext.workflow

Generated from the type stubs by scripts/gen_python_api.py; do not edit.

rs_rich.ext.workflow: workflows: command records and runner, task trees, completion summaries (rich_ext::workflow).

No Rich counterpart: this is the port's own rs-rich-ext crate.

WORKFLOW_STATES module-attribute

WORKFLOW_STATES: List[Any]

WORKFLOW_STYLES module-attribute

WORKFLOW_STYLES: List[Any]

STATES module-attribute

STATES = WORKFLOW_STATES

STYLES module-attribute

STYLES = WORKFLOW_STYLES

ManualClock

advance

advance(seconds: Any) -> Any

now

now() -> Any

set

set(seconds: Any) -> Any

TaskTree

is_finished property

is_finished: Any

title property

title: Any

add

add(label: Any, parent: Any = ...) -> Any

cancel

cancel(task: Any) -> Any

cancel_all

cancel_all() -> Any

children

children(task: Any) -> Any

counts

counts() -> Any

elapsed

elapsed(task: Any) -> Any

fail

fail(task: Any, message: Any) -> Any

get_note

get_note(task: Any) -> Any

get_progress

get_progress(task: Any) -> Any

label

label(task: Any) -> Any

leaves

leaves() -> Any

note

note(task: Any, note: Any) -> Any

overall

overall() -> Any

parent

parent(task: Any) -> Any

progress

progress(task: Any, completed: Any, total: Any = ...) -> Any

root_token

root_token() -> Any

roots

roots() -> Any

skip

skip(task: Any, reason: Any = ...) -> Any

start

start(task: Any) -> Any

state

state(task: Any) -> Any

succeed

succeed(task: Any) -> Any

summary

summary(*, next_steps: Any = ..., show_all_items: Any = ..., symbols: Any = ..., policy: Any = ...) -> Any

sync_cancelled

sync_cancelled() -> Any

tasks

tasks() -> Any

token

token(task: Any) -> Any

total_elapsed

total_elapsed() -> Any

view

view(*, collapse_finished: Any = ..., show_durations: Any = ..., symbols: Any = ..., animate: Any = ..., policy: Any = ...) -> Any

warn

warn(task: Any, message: Any) -> Any

TaskTreeView

SummaryItem

detail property

detail: Any

duration property

duration: Any

label property

label: Any

state property

state: Any

from_record classmethod

from_record(record: Any) -> Any

CompletionSummary

counts

counts() -> Any

overall

overall() -> Any

CommandRecord

args property

args: Any

command_line property

command_line: Any

cwd property

cwd: Any

detail property

detail: Any

duration property writable

duration: Any

lines property

lines: Any

program property

program: Any

returncode property

returncode: Any

state property

state: Any

status property writable

status: Any

success property

success: Any

diagnostic

diagnostic() -> Any

output

output(stream: Any = ...) -> Any

push

push(stream: Any, text: Any) -> Any

view

view(*, tail: Any = ..., full_on_failure: Any = ..., show_cwd: Any = ..., show_diagnostic: Any = ..., help: Any = ..., symbols: Any = ..., animate: Any = ..., policy: Any = ...) -> Any

CommandView

state_marker

state_marker(state: Any, symbols: Any = ...) -> Any

state_label

state_label(state: Any, count: Any) -> Any

run_command

run_command(args: Any, *, cwd: Any = ..., env: Any = ..., cancel: Any = ..., tick: Any = ..., on_update: Any = ...) -> Any