click._termui_impl.ProgressBar

class documentation

class ProgressBar(t.Generic[V]): (source)

View In Hierarchy

Undocumented

Method __enter__ Undocumented
Method __exit__ Undocumented
Method __init__ Undocumented
Method __iter__ Undocumented
Method __next__ Undocumented
Method finish Undocumented
Method format_bar Undocumented
Method format_eta Undocumented
Method format_pct Undocumented
Method format_pos Undocumented
Method format_progress_line Undocumented
Method generator Return a generator which yields the items added to the bar during construction, and updates the progress bar *after* the yielded block returns.
Method make_step Undocumented
Method render_finish Undocumented
Method render_progress Undocumented
Method update Update the progress bar by advancing a specified number of steps, and optionally set the ``current_item`` for this new position.
Instance Variable autowidth Undocumented
Instance Variable avg Undocumented
Instance Variable bar_template Undocumented
Instance Variable color Undocumented
Instance Variable current_item Undocumented
Instance Variable empty_char Undocumented
Instance Variable entered Undocumented
Instance Variable eta_known Undocumented
Instance Variable file Undocumented
Instance Variable fill_char Undocumented
Instance Variable finished Undocumented
Instance Variable info_sep Undocumented
Instance Variable is_hidden Undocumented
Instance Variable item_show_func Undocumented
Instance Variable iter Undocumented
Instance Variable label Undocumented
Instance Variable last_eta Undocumented
Instance Variable length Undocumented
Instance Variable max_width Undocumented
Instance Variable pos Undocumented
Instance Variable show_eta Undocumented
Instance Variable show_percent Undocumented
Instance Variable show_pos Undocumented
Instance Variable start Undocumented
Instance Variable update_min_steps Undocumented
Instance Variable width Undocumented
Property eta Undocumented
Property pct Undocumented
Property time_per_iteration Undocumented
Instance Variable _completed_intervals Undocumented
Instance Variable _last_line Undocumented
def __enter__(self): (source)

Undocumented

Returns
ProgressBarUndocumented
def __exit__(self, exc_type, exc_value, tb): (source)

Undocumented

def __init__(self, iterable, length=None, fill_char='#', empty_char=' ', bar_template='%(bar)s', info_sep=' ', show_eta=True, show_percent=None, show_pos=False, item_show_func=None, label=None, file=None, color=None, update_min_steps=1, width=30): (source)

Undocumented

Parameters
iterable:t.Optional[t.Iterable[V]]Undocumented
length:t.Optional[int]Undocumented
fill_char:strUndocumented
empty_char:strUndocumented
bar_template:strUndocumented
info_sep:strUndocumented
show_eta:boolUndocumented
show_percent:t.Optional[bool]Undocumented
show_pos:boolUndocumented
item_show_func:t.Optional[t.Callable[[t.Optional[V]], t.Optional[str]]]Undocumented
label:t.Optional[str]Undocumented
file:t.Optional[t.TextIO]Undocumented
color:t.Optional[bool]Undocumented
update_min_steps:intUndocumented
width:intUndocumented
def __iter__(self): (source)

Undocumented

Returns
t.Iterator[V]Undocumented
def __next__(self): (source)

Undocumented

Returns
VUndocumented
def finish(self): (source)

Undocumented

def format_bar(self): (source)

Undocumented

Returns
strUndocumented
def format_eta(self): (source)

Undocumented

Returns
strUndocumented
def format_pct(self): (source)

Undocumented

Returns
strUndocumented
def format_pos(self): (source)

Undocumented

Returns
strUndocumented
def format_progress_line(self): (source)

Undocumented

Returns
strUndocumented
def generator(self): (source)

Return a generator which yields the items added to the bar during construction, and updates the progress bar *after* the yielded block returns.

Returns
t.Iterator[V]Undocumented
def make_step(self, n_steps): (source)

Undocumented

Parameters
n_steps:intUndocumented
def render_finish(self): (source)

Undocumented

def render_progress(self): (source)

Undocumented

def update(self, n_steps, current_item=None): (source)

Update the progress bar by advancing a specified number of steps, and optionally set the ``current_item`` for this new position. :param n_steps: Number of steps to advance. :param current_item: Optional item to set as ``current_item`` for the updated position. .. versionchanged:: 8.0 Added the ``current_item`` optional parameter. .. versionchanged:: 8.0 Only render when the number of steps meets the ``update_min_steps`` threshold.

Parameters
n_steps:intUndocumented
current_item:t.Optional[V]Undocumented
autowidth = (source)

Undocumented

avg = (source)

Undocumented

bar_template = (source)

Undocumented

color = (source)

Undocumented

current_item = (source)

Undocumented

empty_char = (source)

Undocumented

entered: bool = (source)

Undocumented

eta_known: bool = (source)

Undocumented

file = (source)

Undocumented

fill_char = (source)

Undocumented

finished: bool = (source)

Undocumented

info_sep = (source)

Undocumented

is_hidden = (source)

Undocumented

item_show_func = (source)

Undocumented

iter = (source)

Undocumented

label = (source)

Undocumented

last_eta = (source)

Undocumented

length = (source)

Undocumented

max_width = (source)

Undocumented

pos: int = (source)

Undocumented

show_eta = (source)

Undocumented

show_percent = (source)

Undocumented

show_pos = (source)

Undocumented

start = (source)

Undocumented

update_min_steps = (source)

Undocumented

width = (source)

Undocumented

@property
eta: float = (source)

Undocumented

@property
pct: float = (source)

Undocumented

@property
time_per_iteration: float = (source)

Undocumented

_completed_intervals: int = (source)

Undocumented

_last_line = (source)

Undocumented