Tree Reference

Bases: Gradient

A Rich tree convenience constructor with gradient rendering.

Parameters:

Name	Type	Description	Default
label	RenderableType	Root label for the tree.	required
style	StyleType	Base tree style.	'tree'
guide_style	StyleType	Style for guide lines.	'tree.line'
expanded	bool	Whether child nodes are expanded.	True
highlight	bool	Whether Rich should highlight labels.	False
hide_root	bool	Whether to hide the root label.	False
colors	Optional[Sequence[ColorType]]	Foreground gradient color stops.	None
bg_colors	Optional[Sequence[ColorType]]	Background gradient color stops.	None
rainbow	bool	Whether to generate a rainbow palette.	False
hues	int	Number of auto-generated hues.	5
repeat_scale	float	Scale factor controlling gradient repeats.	2.0
expand	bool	Whether the gradient frame expands.	True
justify	AlignMethod	Horizontal alignment.	'left'
vertical_justify	VerticalAlignMethod	Vertical alignment.	'middle'
console	Optional[Console]	Optional Rich console.	None
highlight_words	Optional[HighlightWordsType]	Word highlight configuration.	None
highlight_regex	Optional[HighlightRegexType]	Regex highlight configuration.	None

Source code in src/rich_gradient/tree.py

class Tree(Gradient):
    """A Rich tree convenience constructor with gradient rendering.

    Args:
        label: Root label for the tree.
        style: Base tree style.
        guide_style: Style for guide lines.
        expanded: Whether child nodes are expanded.
        highlight: Whether Rich should highlight labels.
        hide_root: Whether to hide the root label.
        colors: Foreground gradient color stops.
        bg_colors: Background gradient color stops.
        rainbow: Whether to generate a rainbow palette.
        hues: Number of auto-generated hues.
        repeat_scale: Scale factor controlling gradient repeats.
        expand: Whether the gradient frame expands.
        justify: Horizontal alignment.
        vertical_justify: Vertical alignment.
        console: Optional Rich console.
        highlight_words: Word highlight configuration.
        highlight_regex: Regex highlight configuration.
    """

    def __init__(
        self,
        label: RenderableType,
        *,
        style: StyleType = "tree",
        guide_style: StyleType = "tree.line",
        expanded: bool = True,
        highlight: bool = False,
        hide_root: bool = False,
        colors: Optional[Sequence[ColorType]] = None,
        bg_colors: Optional[Sequence[ColorType]] = None,
        rainbow: bool = False,
        hues: int = 5,
        repeat_scale: float = 2.0,
        expand: bool = True,
        justify: AlignMethod = "left",
        vertical_justify: VerticalAlignMethod = "middle",
        console: Optional[Console] = None,
        highlight_words: Optional[HighlightWordsType] = None,
        highlight_regex: Optional[HighlightRegexType] = None,
    ) -> None:
        """Initialize a gradient-enabled Rich tree."""
        tree = RichTree(
            label,
            style=style,
            guide_style=guide_style,
            expanded=expanded,
            highlight=highlight,
            hide_root=hide_root,
        )
        self._tree = tree
        super().__init__(
            tree,
            colors=list(colors) if colors is not None else None,
            bg_colors=list(bg_colors) if bg_colors is not None else None,
            console=console,
            hues=hues,
            rainbow=rainbow,
            expand=expand,
            justify=justify,
            vertical_justify=vertical_justify,
            repeat_scale=repeat_scale,
            highlight_words=highlight_words,
            highlight_regex=highlight_regex,
        )

    @property
    def tree(self) -> RichTree:
        """Return the underlying Rich tree."""
        return self._tree

    def add(
        self,
        label: RenderableType,
        *,
        style: StyleType | None = None,
        guide_style: StyleType | None = None,
        expanded: bool = True,
        highlight: Optional[bool] = False,
    ) -> RichTree:
        """Forward `add` to the underlying Rich tree.

        Args:
            label: Label for the child tree node.
            style: Optional style for the child label.
            guide_style: Optional style for the child guide lines.
            expanded: Whether the child node is expanded.
            highlight: Whether Rich should highlight the child label.

        Returns:
            The newly-created Rich tree node.
        """
        return self._tree.add(
            label,
            style=style,
            guide_style=guide_style,
            expanded=expanded,
            highlight=highlight,
        )

tree property

Return the underlying Rich tree.

__init__(label, *, style='tree', guide_style='tree.line', expanded=True, highlight=False, hide_root=False, colors=None, bg_colors=None, rainbow=False, hues=5, repeat_scale=2.0, expand=True, justify='left', vertical_justify='middle', console=None, highlight_words=None, highlight_regex=None)

Initialize a gradient-enabled Rich tree.

Source code in src/rich_gradient/tree.py

def __init__(
    self,
    label: RenderableType,
    *,
    style: StyleType = "tree",
    guide_style: StyleType = "tree.line",
    expanded: bool = True,
    highlight: bool = False,
    hide_root: bool = False,
    colors: Optional[Sequence[ColorType]] = None,
    bg_colors: Optional[Sequence[ColorType]] = None,
    rainbow: bool = False,
    hues: int = 5,
    repeat_scale: float = 2.0,
    expand: bool = True,
    justify: AlignMethod = "left",
    vertical_justify: VerticalAlignMethod = "middle",
    console: Optional[Console] = None,
    highlight_words: Optional[HighlightWordsType] = None,
    highlight_regex: Optional[HighlightRegexType] = None,
) -> None:
    """Initialize a gradient-enabled Rich tree."""
    tree = RichTree(
        label,
        style=style,
        guide_style=guide_style,
        expanded=expanded,
        highlight=highlight,
        hide_root=hide_root,
    )
    self._tree = tree
    super().__init__(
        tree,
        colors=list(colors) if colors is not None else None,
        bg_colors=list(bg_colors) if bg_colors is not None else None,
        console=console,
        hues=hues,
        rainbow=rainbow,
        expand=expand,
        justify=justify,
        vertical_justify=vertical_justify,
        repeat_scale=repeat_scale,
        highlight_words=highlight_words,
        highlight_regex=highlight_regex,
    )

add(label, *, style=None, guide_style=None, expanded=True, highlight=False)

Forward add to the underlying Rich tree.

Parameters:

Name	Type	Description	Default
label	RenderableType	Label for the child tree node.	required
style	StyleType | None	Optional style for the child label.	None
guide_style	StyleType | None	Optional style for the child guide lines.	None
expanded	bool	Whether the child node is expanded.	True
highlight	Optional[bool]	Whether Rich should highlight the child label.	False

Returns:

Type	Description
Tree	The newly-created Rich tree node.

Source code in src/rich_gradient/tree.py

def add(
    self,
    label: RenderableType,
    *,
    style: StyleType | None = None,
    guide_style: StyleType | None = None,
    expanded: bool = True,
    highlight: Optional[bool] = False,
) -> RichTree:
    """Forward `add` to the underlying Rich tree.

    Args:
        label: Label for the child tree node.
        style: Optional style for the child label.
        guide_style: Optional style for the child guide lines.
        expanded: Whether the child node is expanded.
        highlight: Whether Rich should highlight the child label.

    Returns:
        The newly-created Rich tree node.
    """
    return self._tree.add(
        label,
        style=style,
        guide_style=guide_style,
        expanded=expanded,
        highlight=highlight,
    )