pip._vendor.rich.align.Align Class Reference

Inheritance diagram for pip._vendor.rich.align.Align:

Collaboration diagram for pip._vendor.rich.align.Align:

Public Member Functions
None	__init__ (self, "RenderableType" renderable, AlignMethod align="left", Optional[StyleType] style=None, *Optional[VerticalAlignMethod] vertical=None, bool pad=True, Optional[int] width=None, Optional[int] height=None)
str	__repr__ (self)
"Align"	left (cls, "RenderableType" renderable, Optional[StyleType] style=None, *Optional[VerticalAlignMethod] vertical=None, bool pad=True, Optional[int] width=None, Optional[int] height=None)
"Align"	center (cls, "RenderableType" renderable, Optional[StyleType] style=None, *Optional[VerticalAlignMethod] vertical=None, bool pad=True, Optional[int] width=None, Optional[int] height=None)
"Align"	right (cls, "RenderableType" renderable, Optional[StyleType] style=None, *Optional[VerticalAlignMethod] vertical=None, bool pad=True, Optional[int] width=None, Optional[int] height=None)
"RenderResult"	__rich_console__ (self, "Console" console, "ConsoleOptions" options)
Measurement	__rich_measure__ (self, "Console" console, "ConsoleOptions" options)

Public Attributes
	renderable
	align
	style
	vertical
	pad
	width
	height

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

Align a renderable by adding spaces if necessary.

Args:
    renderable (RenderableType): A console renderable.
    align (AlignMethod): One of "left", "center", or "right""
    style (StyleType, optional): An optional style to apply to the background.
    vertical (Optional[VerticalAlginMethod], optional): Optional vertical align, one of "top", "middle", or "bottom". Defaults to None.
    pad (bool, optional): Pad the right with spaces. Defaults to True.
    width (int, optional): Restrict contents to given width, or None to use default width. Defaults to None.
    height (int, optional): Set height of align renderable, or None to fit to contents. Defaults to None.

Raises:
    ValueError: if ``align`` is not one of the expected values.

Member Function Documentation

center()

"Align" pip._vendor.rich.align.Align.center	(		cls,
		"RenderableType"	renderable,
		Optional[StyleType]	style = None,
		*Optional[VerticalAlignMethod]	vertical = None,
		bool	pad = True,
		Optional[int]	width = None,
		Optional[int]	height = None
	)

Align a renderable to the center.

left()

"Align" pip._vendor.rich.align.Align.left	(		cls,
		"RenderableType"	renderable,
		Optional[StyleType]	style = None,
		*Optional[VerticalAlignMethod]	vertical = None,
		bool	pad = True,
		Optional[int]	width = None,
		Optional[int]	height = None
	)

Align a renderable to the left.

right()

"Align" pip._vendor.rich.align.Align.right	(		cls,
		"RenderableType"	renderable,
		Optional[StyleType]	style = None,
		*Optional[VerticalAlignMethod]	vertical = None,
		bool	pad = True,
		Optional[int]	width = None,
		Optional[int]	height = None
	)

Align a renderable to the right.

---

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

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