pip._vendor.rich.panel.Panel Class Reference

Inheritance diagram for pip._vendor.rich.panel.Panel:

Collaboration diagram for pip._vendor.rich.panel.Panel:

Public Member Functions
None	__init__ (self, "RenderableType" renderable, Box box=ROUNDED, *Optional[TextType] title=None, AlignMethod title_align="center", Optional[TextType] subtitle=None, AlignMethod subtitle_align="center", Optional[bool] safe_box=None, bool expand=True, StyleType style="none", StyleType border_style="none", Optional[int] width=None, Optional[int] height=None, PaddingDimensions padding=(0, 1), bool highlight=False)
"Panel"	fit (cls, "RenderableType" renderable, Box box=ROUNDED, *Optional[TextType] title=None, AlignMethod title_align="center", Optional[TextType] subtitle=None, AlignMethod subtitle_align="center", Optional[bool] safe_box=None, StyleType style="none", StyleType border_style="none", Optional[int] width=None, PaddingDimensions padding=(0, 1))
"RenderResult"	__rich_console__ (self, "Console" console, "ConsoleOptions" options)
"Measurement"	__rich_measure__ (self, "Console" console, "ConsoleOptions" options)

Public Attributes
	renderable
	box
	title
	subtitle
	subtitle_align
	safe_box
	expand
	style
	border_style
	width
	height
	padding
	highlight
	title_align

Protected Member Functions
Optional[Text]	_title (self)
Optional[Text]	_subtitle (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)

Detailed Description

A console renderable that draws a border around its contents.

Example:
    >>> console.print(Panel("Hello, World!"))

Args:
    renderable (RenderableType): A console renderable object.
    box (Box, optional): A Box instance that defines the look of the border (see :ref:`appendix_box`.
        Defaults to box.ROUNDED.
    safe_box (bool, optional): Disable box characters that don't display on windows legacy terminal with *raster* fonts. Defaults to True.
    expand (bool, optional): If True the panel will stretch to fill the console
        width, otherwise it will be sized to fit the contents. Defaults to True.
    style (str, optional): The style of the panel (border and contents). Defaults to "none".
    border_style (str, optional): The style of the border. Defaults to "none".
    width (Optional[int], optional): Optional width of panel. Defaults to None to auto-detect.
    height (Optional[int], optional): Optional height of panel. Defaults to None to auto-detect.
    padding (Optional[PaddingDimensions]): Optional padding around renderable. Defaults to 0.
    highlight (bool, optional): Enable automatic highlighting of panel title (if str). Defaults to False.

Member Function Documentation

fit()

"Panel" pip._vendor.rich.panel.Panel.fit	(		cls,
		"RenderableType"	renderable,
		Box	box = ROUNDED,
		*Optional[TextType]	title = None,
		AlignMethod	title_align = "center",
		Optional[TextType]	subtitle = None,
		AlignMethod	subtitle_align = "center",
		Optional[bool]	safe_box = None,
		StyleType	style = "none",
		StyleType	border_style = "none",
		Optional[int]	width = None,
		PaddingDimensions	padding = (0, 1)
	)

An alternative constructor that sets expand=False.

---

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

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