pip._vendor.rich.box.Box Class Reference

Collaboration diagram for pip._vendor.rich.box.Box:

Public Member Functions
None	__init__ (self, str box, *bool ascii=False)
str	__repr__ (self)
str	__str__ (self)
"Box"	substitute (self, "ConsoleOptions" options, bool safe=True)
"Box"	get_plain_headed_box (self)
str	get_top (self, Iterable[int] widths)
str	get_row (self, Iterable[int] widths, Literal["head", "row", "foot", "mid"] level="row", bool edge=True)
str	get_bottom (self, Iterable[int] widths)

Public Attributes
	ascii
	top_left
	top
	top_divider
	top_right
	head_left
	head_vertical
	head_right
	head_row_left
	head_row_horizontal
	head_row_cross
	head_row_right
	mid_left
	mid_vertical
	mid_right
	row_left
	row_horizontal
	row_cross
	row_right
	foot_row_left
	foot_row_horizontal
	foot_row_cross
	foot_row_right
	foot_left
	foot_vertical
	foot_right
	bottom_left
	bottom
	bottom_divider
	bottom_right

Static Public Attributes
Box	ASCII
Box	ASCII2
Box	ASCII_DOUBLE_HEAD
Box	SQUARE
Box	SQUARE_DOUBLE_HEAD
Box	MINIMAL
Box	MINIMAL_HEAVY_HEAD
Box	MINIMAL_DOUBLE_HEAD
Box	SIMPLE
Box	SIMPLE_HEAD
Box	SIMPLE_HEAVY
Box	HORIZONTALS
Box	ROUNDED
Box	HEAVY
Box	HEAVY_EDGE
Box	HEAVY_HEAD
Box	DOUBLE
Box	DOUBLE_EDGE
Box	MARKDOWN

Protected Attributes
	_box

Detailed Description

Defines characters to render boxes.

┌─┬┐ top
│ ││ head
├─┼┤ head_row
│ ││ mid
├─┼┤ row
├─┼┤ foot_row
│ ││ foot
└─┴┘ bottom

Args:
    box (str): Characters making up box.
    ascii (bool, optional): True if this box uses ascii characters only. Default is False.

Member Function Documentation

get_bottom()

str pip._vendor.rich.box.Box.get_bottom	(		self,
		Iterable[int]	widths
	)

Get the bottom of a simple box.

Args:
    widths (List[int]): Widths of columns.

Returns:
    str: A string of box characters.

get_plain_headed_box()

"Box" pip._vendor.rich.box.Box.get_plain_headed_box

(

self

)

If this box uses special characters for the borders of the header, then
return the equivalent box that does not.

Returns:
    Box: The most similar Box that doesn't use header-specific box characters.
        If the current Box already satisfies this criterion, then it's returned.

get_row()

str pip._vendor.rich.box.Box.get_row	(		self,
		Iterable[int]	widths,
		Literal["head", "row", "foot", "mid"]	level = "row",
		bool	edge = True
	)

Get the top of a simple box.

Args:
    width (List[int]): Widths of columns.

Returns:
    str: A string of box characters.

get_top()

str pip._vendor.rich.box.Box.get_top	(		self,
		Iterable[int]	widths
	)

Get the top of a simple box.

Args:
    widths (List[int]): Widths of columns.

Returns:
    str: A string of box characters.

substitute()

"Box" pip._vendor.rich.box.Box.substitute	(		self,
		"ConsoleOptions"	options,
		bool	safe = True
	)

Substitute this box for another if it won't render due to platform issues.

Args:
    options (ConsoleOptions): Console options used in rendering.
    safe (bool, optional): Substitute this for another Box if there are known problems
        displaying on the platform (currently only relevant on Windows). Default is True.

Returns:
    Box: A different Box or the same Box.

Member Data Documentation

ASCII

Box pip._vendor.rich.box.Box.ASCII

static

Initial value:

=  Box(
    ,
    ascii=True,
)

ASCII2

Box pip._vendor.rich.box.Box.ASCII2

static

Initial value:

=  Box(
    ,
    ascii=True,
)

ASCII_DOUBLE_HEAD

Box pip._vendor.rich.box.Box.ASCII_DOUBLE_HEAD

static

Initial value:

=  Box(
    ,
    ascii=True,
)

DOUBLE

Box pip._vendor.rich.box.Box.DOUBLE

static

Initial value:

=  Box(
    
)

DOUBLE_EDGE

Box pip._vendor.rich.box.Box.DOUBLE_EDGE

static

Initial value:

=  Box(
    
)

HEAVY

Box pip._vendor.rich.box.Box.HEAVY

static

Initial value:

=  Box(
    
)

HEAVY_EDGE

Box pip._vendor.rich.box.Box.HEAVY_EDGE

static

Initial value:

=  Box(
    
)

HEAVY_HEAD

Box pip._vendor.rich.box.Box.HEAVY_HEAD

static

Initial value:

=  Box(
    
)

HORIZONTALS

Box pip._vendor.rich.box.Box.HORIZONTALS

static

Initial value:

=  Box(
    
)

MARKDOWN

Box pip._vendor.rich.box.Box.MARKDOWN

static

Initial value:

=  Box(
    ,
    ascii=True,
)

MINIMAL

Box pip._vendor.rich.box.Box.MINIMAL

static

Initial value:

=  Box(
    
)

MINIMAL_DOUBLE_HEAD

Box pip._vendor.rich.box.Box.MINIMAL_DOUBLE_HEAD

static

Initial value:

=  Box(
    
)

MINIMAL_HEAVY_HEAD

Box pip._vendor.rich.box.Box.MINIMAL_HEAVY_HEAD

static

Initial value:

=  Box(
    
)

ROUNDED

Box pip._vendor.rich.box.Box.ROUNDED

static

Initial value:

=  Box(
    
)

SIMPLE

Box pip._vendor.rich.box.Box.SIMPLE

static

Initial value:

=  Box(
    
)

SIMPLE_HEAD

Box pip._vendor.rich.box.Box.SIMPLE_HEAD

static

Initial value:

=  Box(
    
)

SIMPLE_HEAVY

Box pip._vendor.rich.box.Box.SIMPLE_HEAVY

static

Initial value:

=  Box(
    
)

SQUARE

Box pip._vendor.rich.box.Box.SQUARE

static

Initial value:

=  Box(
    
)

SQUARE_DOUBLE_HEAD

Box pip._vendor.rich.box.Box.SQUARE_DOUBLE_HEAD

static

Initial value:

=  Box(
    
)

---

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

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