pip._vendor.rich.live_render.LiveRender Class Reference

Public Member Functions
None	__init__ (self, RenderableType renderable, StyleType style="", VerticalOverflowMethod vertical_overflow="ellipsis")
None	set_renderable (self, RenderableType renderable)
Control	position_cursor (self)
Control	restore_cursor (self)
RenderResult	__rich_console__ (self, Console console, ConsoleOptions options)

Public Attributes
	renderable
	style
	vertical_overflow

Protected Attributes
	_shape

Detailed Description

Creates a renderable that may be updated.

Args:
    renderable (RenderableType): Any renderable object.
    style (StyleType, optional): An optional style to apply to the renderable. Defaults to "".

Member Function Documentation

position_cursor()

Control pip._vendor.rich.live_render.LiveRender.position_cursor

(

self

)

Get control codes to move cursor to beginning of live render.

Returns:
    Control: A control instance that may be printed.

restore_cursor()

Control pip._vendor.rich.live_render.LiveRender.restore_cursor

(

self

)

Get control codes to clear the render and restore the cursor to its previous position.

Returns:
    Control: A Control instance that may be printed.

set_renderable()

None pip._vendor.rich.live_render.LiveRender.set_renderable	(		self,
		RenderableType	renderable
	)

Set a new renderable.

Args:
    renderable (RenderableType): Any renderable object, including str.

---

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

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