Method: rich.console.Console.status
Calls: 3, Exceptions: 0, Paths: 1Back
Path 1: 3 calls (1.0)
'foo' (2) 'bar' (1)
'dots' (3)
'status.spinner' (3)
1.0 (3)
12.5 (3)
Status (3)
1def status(
2 self,
3 status: RenderableType,
4 *,
5 spinner: str = "dots",
6 spinner_style: str = "status.spinner",
7 speed: float = 1.0,
8 refresh_per_second: float = 12.5,
9 ) -> "Status":
10 """Display a status and spinner.
11
12 Args:
13 status (RenderableType): A status renderable (str or Text typically).
14 spinner (str, optional): Name of spinner animation (see python -m rich.spinner). Defaults to "dots".
15 spinner_style (StyleType, optional): Style of spinner. Defaults to "status.spinner".
16 speed (float, optional): Speed factor for spinner animation. Defaults to 1.0.
17 refresh_per_second (float, optional): Number of refreshes per second. Defaults to 12.5.
18
19 Returns:
20 Status: A Status object that may be used as a context manager.
21 """
22 from .status import Status
23
24 status_renderable = Status(
25 status,
26 console=self,
27 spinner=spinner,
28 spinner_style=spinner_style,
29 speed=speed,
30 refresh_per_second=refresh_per_second,
31 )
32 return status_renderable