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

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

Public Member Functions
	__init__ (self, str spinner_name="dots", Optional[StyleType] style="progress.spinner", float speed=1.0, TextType finished_text=" ", Optional[Column] table_column=None)

None	set_spinner (self, str spinner_name, Optional[StyleType] spinner_style="progress.spinner", float speed=1.0)

RenderableType	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
	spinner

	finished_text

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

A column with a 'spinner' animation.

Args:
    spinner_name (str, optional): Name of spinner animation. Defaults to "dots".
    style (StyleType, optional): Style of spinner. Defaults to "progress.spinner".
    speed (float, optional): Speed factor of spinner. Defaults to 1.0.
    finished_text (TextType, optional): Text used when task is finished. Defaults to " ".

Constructor & Destructor Documentation

◆ init()

pip._vendor.rich.progress.SpinnerColumn.__init__	(		self,
		str	spinner_name = `"dots"`,
		Optional[StyleType]	style = `"progress.spinner"`,
		float	speed = `1.0`,
		TextType	finished_text = `" "`,
		Optional[Column]	table_column = `None`
	)

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

Member Function Documentation

◆ render()

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

Should return a renderable object.

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

◆ set_spinner()

None pip._vendor.rich.progress.SpinnerColumn.set_spinner	(		self,
		str	spinner_name,
		Optional[StyleType]	spinner_style = `"progress.spinner"`,
		float	speed = `1.0`
	)

Set a new spinner.

Args:
    spinner_name (str): Spinner name, see python -m rich.spinner.
    spinner_style (Optional[StyleType], optional): Spinner style. Defaults to "progress.spinner".
    speed (float, optional): Speed factor of spinner. Defaults to 1.0.

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