pylupnt.ProgressBar¶

class pylupnt.ProgressBar¶

Terminal progress bar.

finish(self: pylupnt._pylupnt.ProgressBar) → None¶: Complete and finalize the bar.

is_done(self: pylupnt._pylupnt.ProgressBar) → bool¶: True once the bar has reached its total.

reset(self: pylupnt._pylupnt.ProgressBar) → None¶: Reset progress back to zero.

set_description(self: pylupnt._pylupnt.ProgressBar, description: str) → None¶: Set the text shown alongside the bar.

set_leave(self: pylupnt._pylupnt.ProgressBar, leave: bool) → None¶: Whether to leave the finished bar on screen.

set_max_update_freq(self: pylupnt._pylupnt.ProgressBar, max_update_freq: SupportsFloat | SupportsIndex) → None¶: Cap the redraw frequency [Hz].

set_width(self: pylupnt._pylupnt.ProgressBar, width: SupportsInt | SupportsIndex) → None¶: Set the bar width in characters.

update(*args, **kwargs)¶

Overloaded function.

update(self: pylupnt._pylupnt.ProgressBar) -> None

Advance the bar by one step.

update(self: pylupnt._pylupnt.ProgressBar, value: typing.SupportsInt | typing.SupportsIndex) -> None

Set the bar’s current progress to an absolute value.