swh.alter.progressbar module

class swh.alter.progressbar.ProgressBar(*args, **kwargs)

Bases: Protocol, Generic[V]

Interface for the ProgressBar object, mimicking click’s.

update(n_steps: int, current_item: V | None = None) → None

class swh.alter.progressbar.NoProgressBar(iterable: Iterable[V], label: str | None = None)

Bases: Generic[V]

A ProgressBar implementation that displays nothing.

Typically returned by no_progressbar().

update(n_steps: int, current_item: V | None = None) → None

class swh.alter.progressbar.ProgressBarInit(*args, **kwargs)

Bases: Protocol

A protocol abstracting the click.progressbar() function.

swh.alter.progressbar.no_progressbar(iterable: Iterable[V] | None = None, length: int | None = None, label: str | None = None, show_eta: bool = True, show_pos: bool = False, show_percent: bool | None = None, item_show_func: Callable[[V], str] | None = None) → ProgressBar[V]

Returns a ProgressBar that displays nothing.

This function allows to use the same code structure wherever a progressbar has to be displayed or not.