pip._vendor.rich.spinner.Spinner Class Reference

Public Member Functions
None	__init__ (self, str name, "RenderableType" text="", *Optional["StyleType"] style=None, float speed=1.0)
"RenderResult"	__rich_console__ (self, "Console" console, "ConsoleOptions" options)
Measurement	__rich_measure__ (self, "Console" console, "ConsoleOptions" options)
"RenderableType"	render (self, float time)
None	update (self, *"RenderableType" text="", Optional["StyleType"] style=None, Optional[float] speed=None)

Public Attributes
	frames
	interval
	style
	speed
	start_time
	frame_no_offset
	text

Protected Attributes
	_update_speed

Detailed Description

A spinner animation.

Args:
    name (str): Name of spinner (run python -m rich.spinner).
    text (RenderableType, optional): A renderable to display at the right of the spinner (str or Text typically). Defaults to "".
    style (StyleType, optional): Style for spinner animation. Defaults to None.
    speed (float, optional): Speed factor for animation. Defaults to 1.0.

Raises:
    KeyError: If name isn't one of the supported spinner animations.

Member Function Documentation

render()

"RenderableType" pip._vendor.rich.spinner.Spinner.render	(		self,
		float	time
	)

Render the spinner for a given time.

Args:
    time (float): Time in seconds.

Returns:
    RenderableType: A renderable containing animation frame.

update()

None pip._vendor.rich.spinner.Spinner.update	(		self,
		*"RenderableType"	text = "",
		Optional["StyleType"]	style = None,
		Optional[float]	speed = None
	)

Updates attributes of a spinner after it has been started.

Args:
    text (RenderableType, optional): A renderable to display at the right of the spinner (str or Text typically). Defaults to "".
    style (StyleType, optional): Style for spinner animation. Defaults to None.
    speed (float, optional): Speed factor for animation. Defaults to None.

---

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

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