pip._vendor.rich.progress.ProgressColumn Class Reference

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

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

Public Member Functions
None	__init__ (self, Optional[Column] table_column=None)
Column	get_table_column (self)
RenderableType	__call__ (self, "Task" task)
RenderableType	render (self, "Task" task)

Static Public Attributes
Optional	max_refresh = None

Protected Attributes
	_table_column

Detailed Description

Base class for a widget to use in progress display.

Member Function Documentation

__call__()

RenderableType pip._vendor.rich.progress.ProgressColumn.__call__	(		self,
		"Task"	task
	)

Called by the Progress object to return a renderable for the given task.

Args:
    task (Task): An object containing information regarding the task.

Returns:
    RenderableType: Anything renderable (including str).

get_table_column()

Column pip._vendor.rich.progress.ProgressColumn.get_table_column

(

self

)

Get a table column, used to build tasks table.

render()

RenderableType pip._vendor.rich.progress.ProgressColumn.render	(		self,
		"Task"	task
	)

Should return a renderable object.

Reimplemented in pip._vendor.rich.progress.RenderableColumn, pip._vendor.rich.progress.SpinnerColumn, pip._vendor.rich.progress.TextColumn, pip._vendor.rich.progress.BarColumn, pip._vendor.rich.progress.TimeElapsedColumn, pip._vendor.rich.progress.TaskProgressColumn, pip._vendor.rich.progress.TimeRemainingColumn, pip._vendor.rich.progress.FileSizeColumn, pip._vendor.rich.progress.TotalFileSizeColumn, pip._vendor.rich.progress.MofNCompleteColumn, pip._vendor.rich.progress.DownloadColumn, and pip._vendor.rich.progress.TransferSpeedColumn.

---

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