progress.track_progress() – freezebase

progress.track_progress()

Yield items while tracking progress with the shared layout.

Usage

progress.track_progress(
    sequence,
    description="Working...",
    *,
    total=None,
    completed=0,
    update_period=0.1,
    show_progress=True,
    **progress_kwargs
)

Parameters

sequence: Iterable[ProgressType]: Items to track.
description: str = "Working…": Task label.
total: float or None = None: Total steps, inferred when possible.
completed: int = 0: Initially completed steps.
update_period: float = 0.1: Minimum update interval in seconds.
show_progress: bool = True: Whether to display the progress bar.
**progress_kwargs: Any: Additional Progress arguments.

Yields

ProgressType: Items from sequence.