pip._vendor.rich.tree.Tree Class Reference

Inheritance diagram for pip._vendor.rich.tree.Tree:

Collaboration diagram for pip._vendor.rich.tree.Tree:

Public Member Functions
None	__init__ (self, RenderableType label, *StyleType style="tree", StyleType guide_style="tree.line", bool expanded=True, bool highlight=False, bool hide_root=False)
"Tree"	add (self, RenderableType label, *Optional[StyleType] style=None, Optional[StyleType] guide_style=None, bool expanded=True, Optional[bool] highlight=False)
"RenderResult"	__rich_console__ (self, "Console" console, "ConsoleOptions" options)
"Measurement"	__rich_measure__ (self, "Console" console, "ConsoleOptions" options)

Public Attributes
	label
	style
	guide_style
	expanded
	highlight
	hide_root

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

A renderable for a tree structure.

Args:
    label (RenderableType): The renderable or str for the tree label.
    style (StyleType, optional): Style of this tree. Defaults to "tree".
    guide_style (StyleType, optional): Style of the guide lines. Defaults to "tree.line".
    expanded (bool, optional): Also display children. Defaults to True.
    highlight (bool, optional): Highlight renderable (if str). Defaults to False.

Member Function Documentation

add()

"Tree" pip._vendor.rich.tree.Tree.add	(		self,
		RenderableType	label,
		*Optional[StyleType]	style = None,
		Optional[StyleType]	guide_style = None,
		bool	expanded = True,
		Optional[bool]	highlight = False
	)

Add a child tree.

Args:
    label (RenderableType): The renderable or str for the tree label.
    style (StyleType, optional): Style of this tree. Defaults to "tree".
    guide_style (StyleType, optional): Style of the guide lines. Defaults to "tree.line".
    expanded (bool, optional): Also display children. Defaults to True.
    highlight (Optional[bool], optional): Highlight renderable (if str). Defaults to False.

Returns:
    Tree: A new child Tree, which may be further modified.

---

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

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