Inheritance diagram for pip._vendor.rich.live.Live:

Collaboration diagram for pip._vendor.rich.live.Live:

Public Member Functions
None	__init__ (self, Optional[RenderableType] renderable=None, *Optional[Console] console=None, bool screen=False, bool auto_refresh=True, float refresh_per_second=4, bool transient=False, bool redirect_stdout=True, bool redirect_stderr=True, VerticalOverflowMethod vertical_overflow="ellipsis", Optional[Callable[[], RenderableType]] get_renderable=None)

bool	is_started (self)

RenderableType	get_renderable (self)

None	start (self, bool refresh=False)

None	stop (self)

"Live"	__enter__ (self)

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

RenderableType	renderable (self)

None	update (self, RenderableType renderable, *bool refresh=False)

None	refresh (self)

List[ConsoleRenderable]	process_renderables (self, List[ConsoleRenderable] renderables)

Public Attributes
	console

	auto_refresh

	transient

	refresh_per_second

	vertical_overflow

	renderable

	ipy_widget

Protected Member Functions
None	_enable_redirect_io (self)

None	_disable_redirect_io (self)

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)

Protected Attributes
	_renderable

	_screen

	_alt_screen

	_redirect_stdout

	_redirect_stderr

	_lock

	_get_renderable

	_live_render

	_started

	_refresh_thread

	_restore_stdout

	_restore_stderr

Additional Inherited Members
Static Protected Attributes inherited from pip._vendor.rich.console.RenderHook
Optional	_windows_console_features = None

Detailed Description

Renders an auto-updating live display of any given renderable.

Args:
    renderable (RenderableType, optional): The renderable to live display. Defaults to displaying nothing.
    console (Console, optional): Optional Console instance. Default will an internal Console instance writing to stdout.
    screen (bool, optional): Enable alternate screen mode. Defaults to False.
    auto_refresh (bool, optional): Enable auto refresh. If disabled, you will need to call `refresh()` or `update()` with refresh flag. Defaults to True
    refresh_per_second (float, optional): Number of times per second to refresh the live display. Defaults to 4.
    transient (bool, optional): Clear the renderable on exit (has no effect when screen=True). Defaults to False.
    redirect_stdout (bool, optional): Enable redirection of stdout, so ``print`` may be used. Defaults to True.
    redirect_stderr (bool, optional): Enable redirection of stderr. Defaults to True.
    vertical_overflow (VerticalOverflowMethod, optional): How to handle renderable when it is too tall for the console. Defaults to "ellipsis".
    get_renderable (Callable[[], RenderableType], optional): Optional callable to get renderable. Defaults to None.

Member Function Documentation

◆ _disable_redirect_io()

None pip._vendor.rich.live.Live._disable_redirect_io ( self )

protected

Disable redirecting of stdout / stderr.

◆ _enable_redirect_io()

None pip._vendor.rich.live.Live._enable_redirect_io ( self )

protected

Enable redirecting of stdout / stderr.

◆ is_started()

bool pip._vendor.rich.live.Live.is_started ( self )

Check if live display has been started.

◆ process_renderables()

List[ConsoleRenderable] pip._vendor.rich.live.Live.process_renderables	(		self,
		List[ConsoleRenderable]	renderables
	)

Process renderables to restore cursor and display progress.

Reimplemented from pip._vendor.rich.console.RenderHook.

◆ refresh()

None pip._vendor.rich.live.Live.refresh ( self )

Update the display of the Live Render.

◆ renderable()

RenderableType pip._vendor.rich.live.Live.renderable ( self )

Get the renderable that is being displayed

Returns:
    RenderableType: Displayed renderable.

◆ start()

None pip._vendor.rich.live.Live.start	(		self,
		bool	refresh = `False`
	)

Start live rendering display.

Args:
    refresh (bool, optional): Also refresh. Defaults to False.

◆ stop()

None pip._vendor.rich.live.Live.stop ( self )

Stop live rendering display.

◆ update()

None pip._vendor.rich.live.Live.update	(		self,
		RenderableType	renderable,
		*bool	refresh = `False`
	)

Update the renderable that is being displayed

Args:
    renderable (RenderableType): New renderable to use.
    refresh (bool, optional): Refresh the display. Defaults to False.

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

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

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members