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

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

Public Member Functions
None	__init__ (self, str text_format="[progress.percentage]{task.percentage:>3.0f}%", str text_format_no_percentage="", StyleType style="none", JustifyMethod justify="left", bool markup=True, Optional[Highlighter] highlighter=None, Optional[Column] table_column=None, bool show_speed=False)

Text	render_speed (cls, Optional[float] speed)

Text	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
	text_format_no_percentage

	show_speed

Public Attributes inherited from pip._vendor.rich.progress.TextColumn
	text_format

	style

	markup

	highlighter

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

Show task progress as a percentage.

Args:
    text_format (str, optional): Format for percentage display. Defaults to "[progress.percentage]{task.percentage:>3.0f}%".
    text_format_no_percentage (str, optional): Format if percentage is unknown. Defaults to "".
    style (StyleType, optional): Style of output. Defaults to "none".
    justify (JustifyMethod, optional): Text justification. Defaults to "left".
    markup (bool, optional): Enable markup. Defaults to True.
    highlighter (Optional[Highlighter], optional): Highlighter to apply to output. Defaults to None.
    table_column (Optional[Column], optional): Table Column to use. Defaults to None.
    show_speed (bool, optional): Show speed if total is unknown. Defaults to False.

Constructor & Destructor Documentation

◆ init()

None pip._vendor.rich.progress.TaskProgressColumn.__init__	(		self,
		str	text_format = `"[progress.percentage]{task.percentage:>3.0f}%"`,
		str	text_format_no_percentage = `""`,
		StyleType	style = `"none"`,
		JustifyMethod	justify = `"left"`,
		bool	markup = `True`,
		Optional[Highlighter]	highlighter = `None`,
		Optional[Column]	table_column = `None`,
		bool	show_speed = `False`
	)

Reimplemented from pip._vendor.rich.progress.TextColumn.

Member Function Documentation

◆ render()

Text pip._vendor.rich.progress.TaskProgressColumn.render	(		self,
		"Task"	task
	)

Should return a renderable object.

Reimplemented from pip._vendor.rich.progress.TextColumn.

◆ render_speed()

Text pip._vendor.rich.progress.TaskProgressColumn.render_speed	(		cls,
		Optional[float]	speed
	)

Render the speed in iterations per second.

Args:
    task (Task): A Task object.

Returns:
    Text: Text object containing the task speed.

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

Public Member Functions

Public Attributes