pip._vendor.rich.pretty.Node Class Reference

Collaboration diagram for pip._vendor.rich.pretty.Node:

Public Member Functions
Iterable[str]	iter_tokens (self)
bool	check_length (self, int start_length, int max_length)
str	__str__ (self)
str	render (self, int max_width=80, int indent_size=4, bool expand_all=False)

Public Attributes
	children

Static Public Attributes
str	key_repr = ""
str	value_repr = ""
str	open_brace = ""
str	close_brace = ""
str	empty = ""
bool	last = False
bool	is_tuple = False
bool	is_namedtuple = False
Optional	children = None
str	key_separator = ": "
str	separator = ", "

Detailed Description

A node in a repr tree. May be atomic or a container.

Member Function Documentation

check_length()

bool pip._vendor.rich.pretty.Node.check_length	(		self,
		int	start_length,
		int	max_length
	)

Check the length fits within a limit.

Args:
    start_length (int): Starting length of the line (indent, prefix, suffix).
    max_length (int): Maximum length.

Returns:
    bool: True if the node can be rendered within max length, otherwise False.

iter_tokens()

Iterable[str] pip._vendor.rich.pretty.Node.iter_tokens

(

self

)

Generate tokens for this node.

render()

str pip._vendor.rich.pretty.Node.render	(		self,
		int	max_width = 80,
		int	indent_size = 4,
		bool	expand_all = False
	)

Render the node to a pretty repr.

Args:
    max_width (int, optional): Maximum width of the repr. Defaults to 80.
    indent_size (int, optional): Size of indents. Defaults to 4.
    expand_all (bool, optional): Expand all levels. Defaults to False.

Returns:
    str: A repr string of the original object.

---

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

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