Data Structures
class	_ReadContext

class	_Reader

class	_TrackThread

class	BarColumn

class	DownloadColumn

class	FileSizeColumn

class	MofNCompleteColumn

class	Progress

class	ProgressColumn

class	ProgressSample

class	RenderableColumn

class	SpinnerColumn

class	Task

class	TaskProgressColumn

class	TextColumn

class	TimeElapsedColumn

class	TimeRemainingColumn

class	TotalFileSizeColumn

class	TransferSpeedColumn

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

Function Documentation

◆ open() [1/3]

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`
	)

Definition at line 385 of file progress.py.

) -> ContextManager[BinaryIO]:
    pass

◆ open() [2/3]

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`
	)

Read bytes from a file while tracking progress.

Args:
    path (Union[str, PathLike[str], BinaryIO]): The path to the file to read, or a file-like object in binary mode.
    mode (str): The mode to use to open the file. Only supports "r", "rb" or "rt".
    buffering (int): The buffering strategy to use, see :func:`io.open`.
    encoding (str, optional): The encoding to use when reading in text mode, see :func:`io.open`.
    errors (str, optional): The error handling strategy for decoding errors, see :func:`io.open`.
    newline (str, optional): The strategy for handling newlines in text mode, see :func:`io.open`
    total: (int, optional): Total number of bytes to read. Must be provided if reading from a file handle. Default for a path is os.stat(file).st_size.
    description (str, optional): Description of task show next to progress bar. Defaults to "Reading".
    auto_refresh (bool, optional): Automatic refresh, disable to force a refresh after each iteration. Default is True.
    transient: (bool, optional): Clear the progress on exit. Defaults to False.
    console (Console, optional): Console to write to. Default creates internal Console instance.
    refresh_per_second (float): Number of times per second to refresh the progress information. Defaults to 10.
    style (StyleType, optional): Style for the bar background. Defaults to "bar.back".
    complete_style (StyleType, optional): Style for the completed bar. Defaults to "bar.complete".
    finished_style (StyleType, optional): Style for a finished bar. Defaults to "bar.finished".
    pulse_style (StyleType, optional): Style for pulsing bars. Defaults to "bar.pulse".
    disable (bool, optional): Disable display of progress.
    encoding (str, optional): The encoding to use when reading in text mode.

Returns:
    ContextManager[BinaryIO]: A context manager yielding a progress reader.

Definition at line 409 of file progress.py.

) -> Union[ContextManager[BinaryIO], ContextManager[TextIO]]:
    """Read bytes from a file while tracking progress.
 
    Args:
        path (Union[str, PathLike[str], BinaryIO]): The path to the file to read, or a file-like object in binary mode.
        mode (str): The mode to use to open the file. Only supports "r", "rb" or "rt".
        buffering (int): The buffering strategy to use, see :func:`io.open`.
        encoding (str, optional): The encoding to use when reading in text mode, see :func:`io.open`.
        errors (str, optional): The error handling strategy for decoding errors, see :func:`io.open`.
        newline (str, optional): The strategy for handling newlines in text mode, see :func:`io.open`
        total: (int, optional): Total number of bytes to read. Must be provided if reading from a file handle. Default for a path is os.stat(file).st_size.
        description (str, optional): Description of task show next to progress bar. Defaults to "Reading".
        auto_refresh (bool, optional): Automatic refresh, disable to force a refresh after each iteration. Default is True.
        transient: (bool, optional): Clear the progress on exit. Defaults to False.
        console (Console, optional): Console to write to. Default creates internal Console instance.
        refresh_per_second (float): Number of times per second to refresh the progress information. Defaults to 10.
        style (StyleType, optional): Style for the bar background. Defaults to "bar.back".
        complete_style (StyleType, optional): Style for the completed bar. Defaults to "bar.complete".
        finished_style (StyleType, optional): Style for a finished bar. Defaults to "bar.finished".
        pulse_style (StyleType, optional): Style for pulsing bars. Defaults to "bar.pulse".
        disable (bool, optional): Disable display of progress.
        encoding (str, optional): The encoding to use when reading in text mode.
 
    Returns:
        ContextManager[BinaryIO]: A context manager yielding a progress reader.
 
    """
 
    columns: List["ProgressColumn"] = (
        [TextColumn("[progress.description]{task.description}")] if description else []
    )
    columns.extend(
        (
            BarColumn(
                style=style,
                complete_style=complete_style,
                finished_style=finished_style,
                pulse_style=pulse_style,
            ),
            DownloadColumn(),
            TimeRemainingColumn(),
        )
    )
    progress = Progress(
        *columns,
        auto_refresh=auto_refresh,
        console=console,
        transient=transient,
        get_time=get_time,
        refresh_per_second=refresh_per_second or 10,
        disable=disable,
    )
 
    reader = progress.open(
        file,
        mode=mode,
        buffering=buffering,
        encoding=encoding,
        errors=errors,
        newline=newline,
        total=total,
        description=description,
    )
    return _ReadContext(progress, reader)  # type: ignore[return-value, type-var]
 
 

References i.

◆ open() [3/3]

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`
	)

Definition at line 360 of file progress.py.

) -> ContextManager[TextIO]:
    pass
 
 
@typing.overload

◆ track()

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`
	)

Track progress by iterating over a sequence.

Args:
    sequence (Iterable[ProgressType]): A sequence (must support "len") you wish to iterate over.
    description (str, optional): Description of task show next to progress bar. Defaults to "Working".
    total: (float, optional): Total number of steps. Default is len(sequence).
    auto_refresh (bool, optional): Automatic refresh, disable to force a refresh after each iteration. Default is True.
    transient: (bool, optional): Clear the progress on exit. Defaults to False.
    console (Console, optional): Console to write to. Default creates internal Console instance.
    refresh_per_second (float): Number of times per second to refresh the progress information. Defaults to 10.
    style (StyleType, optional): Style for the bar background. Defaults to "bar.back".
    complete_style (StyleType, optional): Style for the completed bar. Defaults to "bar.complete".
    finished_style (StyleType, optional): Style for a finished bar. Defaults to "bar.finished".
    pulse_style (StyleType, optional): Style for pulsing bars. Defaults to "bar.pulse".
    update_period (float, optional): Minimum time (in seconds) between calls to update(). Defaults to 0.1.
    disable (bool, optional): Disable display of progress.
    show_speed (bool, optional): Show speed if total isn't known. Defaults to True.
Returns:
    Iterable[ProgressType]: An iterable of the values in the sequence.

Definition at line 103 of file progress.py.

) -> Iterable[ProgressType]:
    """Track progress by iterating over a sequence.
 
    Args:
        sequence (Iterable[ProgressType]): A sequence (must support "len") you wish to iterate over.
        description (str, optional): Description of task show next to progress bar. Defaults to "Working".
        total: (float, optional): Total number of steps. Default is len(sequence).
        auto_refresh (bool, optional): Automatic refresh, disable to force a refresh after each iteration. Default is True.
        transient: (bool, optional): Clear the progress on exit. Defaults to False.
        console (Console, optional): Console to write to. Default creates internal Console instance.
        refresh_per_second (float): Number of times per second to refresh the progress information. Defaults to 10.
        style (StyleType, optional): Style for the bar background. Defaults to "bar.back".
        complete_style (StyleType, optional): Style for the completed bar. Defaults to "bar.complete".
        finished_style (StyleType, optional): Style for a finished bar. Defaults to "bar.finished".
        pulse_style (StyleType, optional): Style for pulsing bars. Defaults to "bar.pulse".
        update_period (float, optional): Minimum time (in seconds) between calls to update(). Defaults to 0.1.
        disable (bool, optional): Disable display of progress.
        show_speed (bool, optional): Show speed if total isn't known. Defaults to True.
    Returns:
        Iterable[ProgressType]: An iterable of the values in the sequence.
 
    """
 
    columns: List["ProgressColumn"] = (
        [TextColumn("[progress.description]{task.description}")] if description else []
    )
    columns.extend(
        (
            BarColumn(
                style=style,
                complete_style=complete_style,
                finished_style=finished_style,
                pulse_style=pulse_style,
            ),
            TaskProgressColumn(show_speed=show_speed),
            TimeRemainingColumn(elapsed_when_finished=True),
        )
    )
    progress = Progress(
        *columns,
        auto_refresh=auto_refresh,
        console=console,
        transient=transient,
        get_time=get_time,
        refresh_per_second=refresh_per_second or 10,
        disable=disable,
    )
 
    with progress:
        yield from progress.track(
            sequence, total=total, description=description, update_period=update_period
        )
 
 

References i.

◆ wrap_file()

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`
	)

Read bytes from a file while tracking progress.

Args:
    file (Union[str, PathLike[str], BinaryIO]): The path to the file to read, or a file-like object in binary mode.
    total (int): Total number of bytes to read.
    description (str, optional): Description of task show next to progress bar. Defaults to "Reading".
    auto_refresh (bool, optional): Automatic refresh, disable to force a refresh after each iteration. Default is True.
    transient: (bool, optional): Clear the progress on exit. Defaults to False.
    console (Console, optional): Console to write to. Default creates internal Console instance.
    refresh_per_second (float): Number of times per second to refresh the progress information. Defaults to 10.
    style (StyleType, optional): Style for the bar background. Defaults to "bar.back".
    complete_style (StyleType, optional): Style for the completed bar. Defaults to "bar.complete".
    finished_style (StyleType, optional): Style for a finished bar. Defaults to "bar.finished".
    pulse_style (StyleType, optional): Style for pulsing bars. Defaults to "bar.pulse".
    disable (bool, optional): Disable display of progress.
Returns:
    ContextManager[BinaryIO]: A context manager yielding a progress reader.

Definition at line 294 of file progress.py.

) -> ContextManager[BinaryIO]:
    """Read bytes from a file while tracking progress.
 
    Args:
        file (Union[str, PathLike[str], BinaryIO]): The path to the file to read, or a file-like object in binary mode.
        total (int): Total number of bytes to read.
        description (str, optional): Description of task show next to progress bar. Defaults to "Reading".
        auto_refresh (bool, optional): Automatic refresh, disable to force a refresh after each iteration. Default is True.
        transient: (bool, optional): Clear the progress on exit. Defaults to False.
        console (Console, optional): Console to write to. Default creates internal Console instance.
        refresh_per_second (float): Number of times per second to refresh the progress information. Defaults to 10.
        style (StyleType, optional): Style for the bar background. Defaults to "bar.back".
        complete_style (StyleType, optional): Style for the completed bar. Defaults to "bar.complete".
        finished_style (StyleType, optional): Style for a finished bar. Defaults to "bar.finished".
        pulse_style (StyleType, optional): Style for pulsing bars. Defaults to "bar.pulse".
        disable (bool, optional): Disable display of progress.
    Returns:
        ContextManager[BinaryIO]: A context manager yielding a progress reader.
 
    """
 
    columns: List["ProgressColumn"] = (
        [TextColumn("[progress.description]{task.description}")] if description else []
    )
    columns.extend(
        (
            BarColumn(
                style=style,
                complete_style=complete_style,
                finished_style=finished_style,
                pulse_style=pulse_style,
            ),
            DownloadColumn(),
            TimeRemainingColumn(),
        )
    )
    progress = Progress(
        *columns,
        auto_refresh=auto_refresh,
        console=console,
        transient=transient,
        get_time=get_time,
        refresh_per_second=refresh_per_second or 10,
        disable=disable,
    )
 
    reader = progress.wrap_file(file, total=total, description=description)
    return _ReadContext(progress, reader)
 
 
@typing.overload

References i.

Variable Documentation

◆ _I

_I = typing.TypeVar("_I", TextIO, BinaryIO)

protected

Definition at line 60 of file progress.py.

◆ advance

advance

Definition at line 1698 of file progress.py.

Referenced by _Reader.__next__(), _Reader.read(), _Reader.readinto(), _Reader.readline(), _Reader.readlines(), _TrackThread.run(), and Progress.track().

◆ console

console = Console(record=True)

Definition at line 1683 of file progress.py.

◆ examples

examples = cycle(progress_renderables)

Definition at line 1681 of file progress.py.

◆ GetTimeCallable

GetTimeCallable = Callable[[], float]

Definition at line 57 of file progress.py.

◆ progress_renderables

list progress_renderables

Initial value:

=  [
        "Text may be printed while the progress bars are rendering.",
        Panel("In fact, [i]any[/i] renderable will work"),
        "Such as [magenta]tables[/]...",
        table,
        "Pretty printed structures...",
        {"type": "example", "text": "Pretty printed"},
        "Syntax...",
        syntax,
        Rule("Give it a try!"),
    ]

Definition at line 1667 of file progress.py.

◆ ProgressType

ProgressType = TypeVar("ProgressType")

Definition at line 55 of file progress.py.

◆ syntax

syntax

Initial value:

=  Syntax(
        ,
        "python",
        line_numbers=True,
    )

Definition at line 1648 of file progress.py.

◆ table

table = Table("foo", "bar", "baz")

Definition at line 1664 of file progress.py.

◆ task1

task1 = progress.add_task("[red]Downloading", total=1000)

Definition at line 1693 of file progress.py.

◆ task2

task2 = progress.add_task("[green]Processing", total=1000)

Definition at line 1694 of file progress.py.

◆ task3

task3 = progress.add_task("[yellow]Thinking", total=None)

Definition at line 1695 of file progress.py.

◆ TaskID

TaskID = NewType("TaskID", int)

Definition at line 53 of file progress.py.

◆ transient

transient

Definition at line 1690 of file progress.py.

Data Structures

Functions

Variables

Function Documentation

◆ open() [1/3]

◆ open() [2/3]

◆ open() [3/3]

◆ track()

◆ wrap_file()

Variable Documentation

◆ _I

◆ advance

◆ console

◆ examples

◆ GetTimeCallable

◆ progress_renderables

◆ ProgressType

◆ syntax

◆ table

◆ task1

◆ task2

◆ task3

◆ TaskID

◆ transient