Skip to content

rs_rich.progress

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

rich.progress: Progress, its columns, track, wrap_file and open.

BarColumn

Bases: ProgressColumn

bar_width instance-attribute 

bar_width: Optional[int]

style instance-attribute 

style: StyleType

complete_style instance-attribute 

complete_style: StyleType

finished_style instance-attribute 

finished_style: StyleType

pulse_style instance-attribute 

pulse_style: StyleType

DownloadColumn

Bases: ProgressColumn

binary_units instance-attribute 

binary_units: bool

FileSizeColumn

Bases: ProgressColumn

MofNCompleteColumn

Bases: ProgressColumn

separator instance-attribute 

separator: str

Progress

columns instance-attribute 

columns: Tuple[Union[str, ProgressColumn], ...]

speed_estimate_period instance-attribute 

speed_estimate_period: float

disable instance-attribute 

disable: bool

expand instance-attribute 

expand: bool

get_time instance-attribute 

get_time: GetTimeCallable

live property 

live: Live

console property 

console: Console

print property 

print: Callable[..., None]

log property 

log: Callable[..., None]

tasks property 

tasks: List[Task]

task_ids property 

task_ids: List[int]

finished property 

finished: bool

get_default_columns classmethod 

get_default_columns() -> Tuple[ProgressColumn, ...]

start 

start() -> None

stop 

stop() -> None

track 

track(sequence: Iterable[Any], total: Optional[float] = None, completed: int = 0, task_id: Optional[int] = None, description: str = 'Working...', update_period: float = 0.1) -> Iterator[Any]

wrap_file 

wrap_file(file: Any, total: Optional[int] = None, *, task_id: Optional[int] = None, description: str = 'Reading...') -> Any

open 

open(file: Any, mode: str = 'r', buffering: int = -1, encoding: Optional[str] = None, errors: Optional[str] = None, newline: Optional[str] = None, *, total: Optional[int] = None, task_id: Optional[int] = None, description: str = 'Reading...') -> Any

start_task 

start_task(task_id: int) -> None

stop_task 

stop_task(task_id: int) -> None

update 

update(task_id: int, *, total: Optional[float] = None, completed: Optional[float] = None, advance: Optional[float] = None, description: Optional[str] = None, visible: Optional[bool] = None, refresh: bool = False, **fields: Any) -> None

reset 

reset(task_id: int, *, start: bool = True, total: Optional[float] = None, completed: int = 0, visible: Optional[bool] = None, description: Optional[str] = None, **fields: Any) -> None

advance 

advance(task_id: int, advance: float = 1) -> None

refresh 

refresh() -> None

get_renderable 

get_renderable() -> RenderableType

get_renderables 

get_renderables() -> Iterable[RenderableType]

make_tasks_table 

make_tasks_table(tasks: Iterable[Task]) -> RenderableType

add_task 

add_task(description: str, start: bool = True, total: Optional[float] = 100.0, completed: int = 0, visible: bool = True, **fields: Any) -> int

remove_task 

remove_task(task_id: int) -> None

ProgressColumn

max_refresh instance-attribute 

max_refresh: Optional[float]

get_table_column 

get_table_column() -> Any

render 

render(task: Task) -> RenderableType

RenderableColumn

Bases: ProgressColumn

renderable instance-attribute 

renderable: RenderableType

SpinnerColumn

Bases: ProgressColumn

finished_text instance-attribute 

finished_text: Text

set_spinner 

set_spinner(spinner_name: str, spinner_style: Optional[StyleType] = 'progress.spinner', speed: float = 1.0) -> None

Task

id instance-attribute 

id: int

description instance-attribute 

description: str

total instance-attribute 

total: Optional[float]

completed instance-attribute 

completed: float

finished_time instance-attribute 

finished_time: Optional[float]

visible instance-attribute 

visible: bool

fields instance-attribute 

fields: Dict[str, Any]

start_time instance-attribute 

start_time: Optional[float]

stop_time instance-attribute 

stop_time: Optional[float]

finished_speed instance-attribute 

finished_speed: Optional[float]

started property 

started: bool

remaining property 

remaining: Optional[float]

elapsed property 

elapsed: Optional[float]

finished property 

finished: bool

percentage property 

percentage: float

speed property 

speed: Optional[float]

time_remaining property 

time_remaining: Optional[float]

get_time 

get_time() -> float

TaskID

Bases: int

TaskProgressColumn

Bases: TextColumn

text_format_no_percentage instance-attribute 

text_format_no_percentage: str

show_speed instance-attribute 

show_speed: bool

render_speed classmethod 

render_speed(speed: Optional[float]) -> Text

TextColumn

Bases: ProgressColumn

text_format instance-attribute 

text_format: str

style instance-attribute 

style: StyleType

justify instance-attribute 

justify: JustifyMethod

markup instance-attribute 

markup: bool

highlighter instance-attribute 

highlighter: Optional[Any]

TimeElapsedColumn

Bases: ProgressColumn

TimeRemainingColumn

Bases: ProgressColumn

compact instance-attribute 

compact: bool

elapsed_when_finished instance-attribute 

elapsed_when_finished: bool

TotalFileSizeColumn

Bases: ProgressColumn

TransferSpeedColumn

Bases: ProgressColumn

open 

open(file: Any, mode: str = 'r', buffering: int = -1, encoding: Optional[str] = None, errors: Optional[str] = None, newline: Optional[str] = None, *, total: Optional[int] = None, description: str = 'Reading...', auto_refresh: bool = True, console: Optional[Console] = None, transient: bool = False, get_time: Optional[GetTimeCallable] = None, refresh_per_second: float = 10, style: StyleType = 'bar.back', complete_style: StyleType = 'bar.complete', finished_style: StyleType = 'bar.finished', pulse_style: StyleType = 'bar.pulse', disable: bool = False) -> Any

track 

track(sequence: Iterable[Any], description: str = 'Working...', total: Optional[float] = None, completed: int = 0, auto_refresh: bool = True, console: Optional[Console] = None, transient: bool = False, get_time: Optional[GetTimeCallable] = None, refresh_per_second: float = 10, style: StyleType = 'bar.back', complete_style: StyleType = 'bar.complete', finished_style: StyleType = 'bar.finished', pulse_style: StyleType = 'bar.pulse', update_period: float = 0.1, disable: bool = False, show_speed: bool = True) -> Iterator[Any]

wrap_file 

wrap_file(file: Any, total: int, *, description: str = 'Reading...', auto_refresh: bool = True, console: Optional[Console] = None, transient: bool = False, get_time: Optional[GetTimeCallable] = None, refresh_per_second: float = 10, style: StyleType = 'bar.back', complete_style: StyleType = 'bar.complete', finished_style: StyleType = 'bar.finished', pulse_style: StyleType = 'bar.pulse', disable: bool = False) -> Any