pip._vendor.rich.columns.Columns Class Reference

Inheritance diagram for pip._vendor.rich.columns.Columns:

Collaboration diagram for pip._vendor.rich.columns.Columns:

Public Member Functions
None	__init__ (self, Optional[Iterable[RenderableType]] renderables=None, PaddingDimensions padding=(0, 1), *Optional[int] width=None, bool expand=False, bool equal=False, bool column_first=False, bool right_to_left=False, Optional[AlignMethod] align=None, Optional[TextType] title=None)
None	add_renderable (self, RenderableType renderable)
RenderResult	__rich_console__ (self, Console console, ConsoleOptions options)

Public Attributes
	renderables
	width
	padding
	expand
	equal
	column_first
	right_to_left
	title

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

Display renderables in neat columns.

Args:
    renderables (Iterable[RenderableType]): Any number of Rich renderables (including str).
    width (int, optional): The desired width of the columns, or None to auto detect. Defaults to None.
    padding (PaddingDimensions, optional): Optional padding around cells. Defaults to (0, 1).
    expand (bool, optional): Expand columns to full width. Defaults to False.
    equal (bool, optional): Arrange in to equal sized columns. Defaults to False.
    column_first (bool, optional): Align items from top to bottom (rather than left to right). Defaults to False.
    right_to_left (bool, optional): Start column from right hand side. Defaults to False.
    align (str, optional): Align value ("left", "right", or "center") or None for default. Defaults to None.
    title (TextType, optional): Optional title for Columns.

Member Function Documentation

add_renderable()

None pip._vendor.rich.columns.Columns.add_renderable	(		self,
		RenderableType	renderable
	)

Add a renderable to the columns.

Args:
    renderable (RenderableType): Any renderable object.

---

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

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