Class Tree

rich/tree.py:14–201

A renderable for a tree structure. Attributes: ASCII_GUIDES (GuideType): Guide lines used when Console.ascii_only is True. TREE_GUIDES (List[GuideType, GuideType, GuideType]): Default guide lines. Args: label (RenderableType): The renderable or str for the tree labe

class Tree(JupyterMixin):
    class="st">"""A renderable for a tree structure.

    Attributes:
        ASCII_GUIDES (GuideType): Guide lines used when Console.ascii_only is True.
        TREE_GUIDES (List[GuideType, GuideType, GuideType]): Default guide lines.

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

    ASCII_GUIDES = (class="st">"    ", class="st">"|   ", class="st">"+-- ", class="st">"`-- ")
    TREE_GUIDES = [
        (class="st">"    ", class="st">"│   ", class="st">"├── ", class="st">"└── "),
        (class="st">"    ", class="st">"┃   ", class="st">"┣━━ ", class="st">"┗━━ "),
        (class="st">"    ", class="st">"║   ", class="st">"╠══ ", class="st">"╚══ "),
    ]

    def __init__(
        self,
        label: RenderableType,
        *,
        style: StyleType = class="st">"tree",
        guide_style: StyleType = class="st">"tree.line",
        expanded: bool = True,
        highlight: bool = False,
        hide_root: bool = False,
    ) -> None:
        self.label = label
        self.style = style
        self.guide_style = guide_style
        self.children: List[Tree] = []
        self.expanded = expanded
        self.highlight = highlight
        self.hide_root = hide_root

    def add(
        self,
        label: RenderableType,
        *,
        style: Optional[StyleType] = None,
        guide_style: Optional[StyleType] = None,
        expanded: bool = True,
        highlight: Optional[bool] = False,
    ) -> class="st">"Tree":
        class="st">"""Add a child tree.

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