progress.py File Reference

Go to the source code of this file.

Data Structures
class	_TrackThread
class	_Reader
class	_ReadContext
class	ProgressColumn
class	RenderableColumn
class	SpinnerColumn
class	TextColumn
class	BarColumn
class	TimeElapsedColumn
class	TaskProgressColumn
class	TimeRemainingColumn
class	FileSizeColumn
class	TotalFileSizeColumn
class	MofNCompleteColumn
class	DownloadColumn
class	TransferSpeedColumn
class	ProgressSample
class	Task
class	Progress

Namespaces
namespace	pip
namespace	pip._vendor
namespace	pip._vendor.rich
namespace	pip._vendor.rich.progress

Functions
Iterable[ProgressType]	track (Union[Sequence[ProgressType], Iterable[ProgressType]] sequence, str description="Working...", Optional[float] total=None, bool auto_refresh=True, Optional[Console] console=None, bool transient=False, Optional[Callable[[], float]] get_time=None, float refresh_per_second=10, StyleType style="bar.back", StyleType complete_style="bar.complete", StyleType finished_style="bar.finished", StyleType pulse_style="bar.pulse", float update_period=0.1, bool disable=False, bool show_speed=True)
ContextManager[BinaryIO]	wrap_file (BinaryIO file, int total, *str description="Reading...", bool auto_refresh=True, Optional[Console] console=None, bool transient=False, Optional[Callable[[], float]] get_time=None, float refresh_per_second=10, StyleType style="bar.back", StyleType complete_style="bar.complete", StyleType finished_style="bar.finished", StyleType pulse_style="bar.pulse", bool disable=False)
ContextManager[TextIO]	open (Union[str, "PathLike[str]", bytes] file, Union[Literal["rt"], Literal["r"]] mode, int buffering=-1, Optional[str] encoding=None, Optional[str] errors=None, Optional[str] newline=None, *Optional[int] total=None, str description="Reading...", bool auto_refresh=True, Optional[Console] console=None, bool transient=False, Optional[Callable[[], float]] get_time=None, float refresh_per_second=10, StyleType style="bar.back", StyleType complete_style="bar.complete", StyleType finished_style="bar.finished", StyleType pulse_style="bar.pulse", bool disable=False)
ContextManager[BinaryIO]	open (Union[str, "PathLike[str]", bytes] file, Literal["rb"] mode, int buffering=-1, Optional[str] encoding=None, Optional[str] errors=None, Optional[str] newline=None, *Optional[int] total=None, str description="Reading...", bool auto_refresh=True, Optional[Console] console=None, bool transient=False, Optional[Callable[[], float]] get_time=None, float refresh_per_second=10, StyleType style="bar.back", StyleType complete_style="bar.complete", StyleType finished_style="bar.finished", StyleType pulse_style="bar.pulse", bool disable=False)
Union[ContextManager[BinaryIO], ContextManager[TextIO]]	open (Union[str, "PathLike[str]", bytes] file, Union[Literal["rb"], Literal["rt"], Literal["r"]] mode="r", int buffering=-1, Optional[str] encoding=None, Optional[str] errors=None, Optional[str] newline=None, *Optional[int] total=None, str description="Reading...", bool auto_refresh=True, Optional[Console] console=None, bool transient=False, Optional[Callable[[], float]] get_time=None, float refresh_per_second=10, StyleType style="bar.back", StyleType complete_style="bar.complete", StyleType finished_style="bar.finished", StyleType pulse_style="bar.pulse", bool disable=False)

Variables
	TaskID = NewType("TaskID", int)
	ProgressType = TypeVar("ProgressType")
	GetTimeCallable = Callable[[], float]
	_I = typing.TypeVar("_I", TextIO, BinaryIO)
	syntax
	table = Table("foo", "bar", "baz")
list	progress_renderables
	examples = cycle(progress_renderables)
	console = Console(record=True)
	transient
	task1 = progress.add_task("[red]Downloading", total=1000)
	task2 = progress.add_task("[green]Processing", total=1000)
	task3 = progress.add_task("[yellow]Thinking", total=None)
	advance