pip._internal.cli.progress_bars Namespace Reference

Functions
Generator[bytes, None, None]	_rich_progress_bar (Iterable[bytes] iterable, *str bar_type, int size)
DownloadProgressRenderer	get_download_progress_renderer (*str bar_type, Optional[int] size=None)

Variables
	DownloadProgressRenderer = Callable[[Iterable[bytes]], Iterator[bytes]]

Function Documentation

_rich_progress_bar()

Generator[bytes, None, None] _rich_progress_bar ( Iterable[bytes]  iterable, *str  bar_type, int  size  )

protected

Definition at line 22 of file progress_bars.py.

) -> Generator[bytes, None, None]:
    assert bar_type == "on", "This should only be used in the default mode."
 
    if not size:
        total = float("inf")
        columns: Tuple[ProgressColumn, ...] = (
            TextColumn("[progress.description]{task.description}"),
            SpinnerColumn("line", speed=1.5),
            FileSizeColumn(),
            TransferSpeedColumn(),
            TimeElapsedColumn(),
        )
    else:
        total = size
        columns = (
            TextColumn("[progress.description]{task.description}"),
            BarColumn(),
            DownloadColumn(),
            TransferSpeedColumn(),
            TextColumn("eta"),
            TimeRemainingColumn(),
        )
 
    progress = Progress(*columns, refresh_per_second=30)
    task_id = progress.add_task(" " * (get_indentation() + 2), total=total)
    with progress:
        for chunk in iterable:
            yield chunk
            progress.update(task_id, advance=len(chunk))
 
 

References i.

get_download_progress_renderer()

DownloadProgressRenderer get_download_progress_renderer	(	*str	bar_type,
		Optional[int]	size = None
	)

Get an object that can be used to render the download progress.

Returns a callable, that takes an iterable to "wrap".

Definition at line 58 of file progress_bars.py.

) -> DownloadProgressRenderer:
    """Get an object that can be used to render the download progress.
 
    Returns a callable, that takes an iterable to "wrap".
    """
    if bar_type == "on":
        return functools.partial(_rich_progress_bar, bar_type=bar_type, size=size)
    else:
        return iter  # no-op, when passed an iterator

References i.

Variable Documentation

DownloadProgressRenderer

DownloadProgressRenderer = Callable[[Iterable[bytes]], Iterator[bytes]]

Definition at line 19 of file progress_bars.py.