Inheritance diagram for pip._vendor.rich.status.Status:

Collaboration diagram for pip._vendor.rich.status.Status:

Public Member Functions
	__init__ (self, RenderableType status, *Optional[Console] console=None, str spinner="dots", StyleType spinner_style="status.spinner", float speed=1.0, float refresh_per_second=12.5)

Spinner	renderable (self)

"Console"	console (self)

None	update (self, Optional[RenderableType] status=None, *Optional[str] spinner=None, Optional[StyleType] spinner_style=None, Optional[float] speed=None)

None	start (self)

None	stop (self)

RenderableType	__rich__ (self)

"Status"	__enter__ (self)

None	__exit__ (self, Optional[Type[BaseException]] exc_type, Optional[BaseException] exc_val, Optional[TracebackType] exc_tb)

Public Attributes
	status

	spinner_style

	speed

	renderable

Protected Attributes
	_spinner

	_live

Additional Inherited Members
Protected Member Functions inherited from pip._vendor.rich.jupyter.JupyterMixin
Dict[str, str]	_repr_mimebundle_ ("ConsoleRenderable" self, Sequence[str] include, Sequence[str] exclude, **Any kwargs)

Detailed Description

Displays a status indicator with a 'spinner' animation.

Args:
    status (RenderableType): A status renderable (str or Text typically).
    console (Console, optional): Console instance to use, or None for global console. Defaults to None.
    spinner (str, optional): Name of spinner animation (see python -m rich.spinner). Defaults to "dots".
    spinner_style (StyleType, optional): Style of spinner. Defaults to "status.spinner".
    speed (float, optional): Speed factor for spinner animation. Defaults to 1.0.
    refresh_per_second (float, optional): Number of refreshes per second. Defaults to 12.5.

Member Function Documentation

◆ console()

"Console" pip._vendor.rich.status.Status.console ( self )

Get the Console used by the Status objects.

◆ start()

None pip._vendor.rich.status.Status.start ( self )

Start the status animation.

◆ stop()

None pip._vendor.rich.status.Status.stop ( self )

Stop the spinner animation.

◆ update()

None pip._vendor.rich.status.Status.update	(		self,
		Optional[RenderableType]	status = `None`,
		*Optional[str]	spinner = `None`,
		Optional[StyleType]	spinner_style = `None`,
		Optional[float]	speed = `None`
	)

Update status.

Args:
    status (Optional[RenderableType], optional): New status renderable or None for no change. Defaults to None.
    spinner (Optional[str], optional): New spinner or None for no change. Defaults to None.
    spinner_style (Optional[StyleType], optional): New spinner style or None for no change. Defaults to None.
    speed (Optional[float], optional): Speed factor for spinner animation or None for no change. 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/status.py

Public Member Functions

Public Attributes