click._termui_impl.ProgressBar Class Reference

Inheritance diagram for click._termui_impl.ProgressBar:

Collaboration diagram for click._termui_impl.ProgressBar:

Public Member Functions
None	__init__ (self, cabc.Iterable[V]|None iterable, int|None length=None, str fill_char="#", str empty_char=" ", str bar_template="%(bar)s", str info_sep=" ", bool hidden=False, bool show_eta=True, bool|None show_percent=None, bool show_pos=False, t.Callable[[V|None], str|None]|None item_show_func=None, str|None label=None, t.TextIO|None file=None, bool|None color=None, int update_min_steps=1, int width=30)
ProgressBar[V]	__enter__ (self)
None	__exit__ (self, type[BaseException]|None exc_type, BaseException|None exc_value, TracebackType|None tb)
cabc.Iterator[V]	__iter__ (self)
V	__next__ (self)
None	render_finish (self)
float	pct (self)
float	time_per_iteration (self)
float	eta (self)
str	format_eta (self)
str	format_pos (self)
str	format_pct (self)
str	format_bar (self)
str	format_progress_line (self)
None	render_progress (self)
None	make_step (self, int n_steps)
None	update (self, int n_steps, V|None current_item=None)
None	finish (self)
cabc.Iterator[V]	generator (self)

Public Attributes
	fill_char
	empty_char
	bar_template
	info_sep
	hidden
	show_eta
	show_percent
	show_pos
	item_show_func
	file
	color
	update_min_steps
	length
	start
	entered
	avg
	pos
	time_per_iteration
	label
	width
	max_width
	finished
	last_eta
	eta_known
	current_item

Protected Attributes
	_completed_intervals
	_is_atty
	_last_line

Member Function Documentation

generator()

cabc.Iterator[V] click._termui_impl.ProgressBar.generator

(

self

)

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

update()

None click._termui_impl.ProgressBar.update	(		self,
		int	n_steps,
		V | None	current_item = None
	)

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.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/click/_termui_impl.py