rich.progress_bar¶
- class rich.progress_bar.ProgressBar(total=100.0, completed=0, width=None, pulse=False, style='bar.back', complete_style='bar.complete', finished_style='bar.finished', pulse_style='bar.pulse', animation_time=None)[source]¶
Renders a (progress) bar. Used by rich.progress.
- Parameters
total (float, optional) – Number of steps in the bar. Defaults to 100. Set to None to render a pulsing animation.
completed (float, optional) – Number of steps completed. Defaults to 0.
width (int, optional) – Width of the bar, or
None
for maximum width. Defaults to None.pulse (bool, optional) – Enable pulse effect. Defaults to False. Will pulse if a None total was passed.
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”.
animation_time (Optional[float], optional) – Time in seconds to use for animation, or None to use system time.