pip._vendor.rich.progress.BarColumn Class Reference

Inheritance diagram for pip._vendor.rich.progress.BarColumn:

Collaboration diagram for pip._vendor.rich.progress.BarColumn:

Public Member Functions
None	__init__ (self, Optional[int] bar_width=40, StyleType style="bar.back", StyleType complete_style="bar.complete", StyleType finished_style="bar.finished", StyleType pulse_style="bar.pulse", Optional[Column] table_column=None)
ProgressBar	render (self, "Task" task)
Public Member Functions inherited from pip._vendor.rich.progress.ProgressColumn
Column	get_table_column (self)
RenderableType	__call__ (self, "Task" task)

Public Attributes
	bar_width
	style
	complete_style
	finished_style
	pulse_style

Additional Inherited Members
Static Public Attributes inherited from pip._vendor.rich.progress.ProgressColumn
Optional	max_refresh = None
Protected Attributes inherited from pip._vendor.rich.progress.ProgressColumn
	_table_column

Detailed Description

Renders a visual progress bar.

Args:
    bar_width (Optional[int], optional): Width of bar or None for full width. Defaults to 40.
    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".

Constructor & Destructor Documentation

__init__()

None pip._vendor.rich.progress.BarColumn.__init__	(		self,
		Optional[int]	bar_width = 40,
		StyleType	style = "bar.back",
		StyleType	complete_style = "bar.complete",
		StyleType	finished_style = "bar.finished",
		StyleType	pulse_style = "bar.pulse",
		Optional[Column]	table_column = None
	)

Reimplemented from pip._vendor.rich.progress.ProgressColumn.

Member Function Documentation

render()

ProgressBar pip._vendor.rich.progress.BarColumn.render	(		self,
		"Task"	task
	)

Gets a progress bar widget for a task.

Reimplemented from pip._vendor.rich.progress.ProgressColumn.

---

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

• docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/rich/progress.py