Construct tree from rich tree using Tree.from_rich

CHANGELOG.md

@@ -5,14 +5,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
-### Added:
-- Docs: More examples for listing directories.
-### Fixed:
-- Docs: Some grammar improvements in docstring.
-- Setup: Test with different Python environments.
 
 ## [1.3.1] - 2026-02-13
 ### Added:
+- Tree Construct: Construct tree from rich tree using `rich_to_tree` or `Tree.from_rich`.
 - Docs: More examples for listing directories.
 ### Fixed:
 - Tree Export: Fix attr square brackets being confused as rich formatting.
@@ -905,7 +901,8 @@ ignore null attribute columns.
 - Utility Iterator: Tree traversal methods.
 - Workflow To Do App: Tree use case with to-do list implementation.
 
-[Unreleased]: https://github.com/kayjan/bigtree/compare/1.3.0...HEAD
+[Unreleased]: https://github.com/kayjan/bigtree/compare/1.3.1...HEAD
+[1.3.1]: https://github.com/kayjan/bigtree/compare/1.3.0...1.3.1
 [1.3.0]: https://github.com/kayjan/bigtree/compare/1.2.0...1.3.0
 [1.2.0]: https://github.com/kayjan/bigtree/compare/1.1.0...1.2.0
 [1.1.0]: https://github.com/kayjan/bigtree/compare/1.0.4...1.1.0

bigtree/__init__.py

@@ -30,6 +30,7 @@
     polars_to_tree,
     polars_to_tree_by_relation,
     render_tree,
+    rich_to_tree,
     str_to_tree,
 )
 from bigtree.tree.export import (

bigtree/_plugins.py

@@ -81,6 +81,7 @@ def register_tree_plugins() -> None:
             "from_list_relation": construct.list_to_tree_by_relation,
             "from_str": construct.str_to_tree,
             "from_newick": construct.newick_to_tree,
+            "from_rich": construct.rich_to_tree,
         },
         method="class",
     )

bigtree/tree/construct/__init__.py

@@ -17,7 +17,7 @@
 )
 from .lists import list_to_tree, list_to_tree_by_relation
 from .render import render_tree
-from .strings import add_path_to_tree, newick_to_tree, str_to_tree
+from .strings import add_path_to_tree, newick_to_tree, rich_to_tree, str_to_tree
 
 __all__ = [
     "add_dataframe_to_tree_by_name",
@@ -38,5 +38,6 @@
     "render_tree",
     "add_path_to_tree",
     "newick_to_tree",
+    "rich_to_tree",
     "str_to_tree",
 ]

bigtree/tree/construct/strings.py

@@ -8,10 +8,19 @@
 from bigtree.tree import search
 from bigtree.utils import assertions, constants, exceptions
 
+try:
+    import rich
+except ImportError:  # pragma: no cover
+    from unittest.mock import MagicMock
+
+    rich = MagicMock()
+
+
 __all__ = [
     "add_path_to_tree",
     "str_to_tree",
     "newick_to_tree",
+    "rich_to_tree",
 ]
 
 T = TypeVar("T", bound=node.Node)
@@ -469,3 +478,60 @@ def _raise_value_error(tree_idx: int) -> None:
         current_depth,
     )
     return current_node
+
+
+def rich_to_tree(
+    rich_tree: rich.tree.Tree, node_format_attr: str = "style"
+) -> node.Node:
+    """Construct tree from rich tree to allow more tree operations, return root of tree.
+
+    If the rich node label is of type rich.text.Text, it will save the style, if any, as
+    a node attribute. This does not support inferring rich node label string using
+    square brackets.
+
+    Examples:
+        >>> from bigtree import Tree
+        >>> from rich.tree import Tree as RichTree
+        >>> from rich.text import Text
+        >>> rich_root = RichTree(Text("Grandparent", style="magenta"))
+        >>> child = rich_root.add("Child")
+        >>> _ = child.add(Text("Grandchild", style="red"))
+        >>> _ = rich_root.add("Child 2")
+        >>> tree = Tree.rich_to_tree(rich_root)
+        >>> tree.show(all_attrs=True)  # Try with rich=True, node_format_attr="style"
+        Grandparent [style=magenta]
+        ├── Child
+        │   └── Grandchild [style=red]
+        └── Child 2
+
+    Args:
+        rich_tree: rich Tree
+        node_format_attr: attribute name for the node format
+
+    Returns:
+        Node
+    """
+
+    def extract_label_and_style(label: rich.text.Text | str) -> tuple[str, str | None]:
+        """Extract label and list of styles spans from a rich label.
+
+        Returns:
+            label and style (if label is rich.text.Text and has style)
+        """
+        if isinstance(label, rich.text.Text):
+            return label.plain, label.style
+        else:
+            return str(label), None
+
+    def convert_node(
+        rich_node: rich.tree.Tree, parent: node.Node | None = None
+    ) -> node.Node:
+        node_name, node_format = extract_label_and_style(rich_node.label)
+        _node = node.Node(node_name, parent=parent)
+        if node_format:
+            _node.set_attrs({node_format_attr: node_format})
+        for child in rich_node.children:
+            convert_node(child, parent=_node)
+        return _node
+
+    return convert_node(rich_tree)

bigtree/tree/export/stdout.py

@@ -277,6 +277,13 @@ def print_tree(
             # Handle specific case where [ will be mistaken as rich formatting
             attr_bracket = ("\\" + attr_bracket[0], attr_bracket[1])
 
+        # Handle specific case where [ will be mistaken as rich formatting
+        attr_bracket = (
+            ("\\" + attr_bracket[0], attr_bracket[1])
+            if attr_bracket[0] == "["
+            else attr_bracket
+        )
+
     for pre_str, fill_str, _node in yield_tree(
         tree=tree,
         node_name_or_path=node_name_or_path,

tests/tree/conftest.py

@@ -326,7 +326,6 @@ def rich_console():
     from rich.console import Console
 
     return Console(
-        # no_color=True,
         record=False,
         color_system=None,
         force_terminal=False,

tests/tree/construct/conftest.py

@@ -1,3 +1,5 @@
+import pytest
+
 from bigtree.node import node
 
 
@@ -10,3 +12,15 @@ def __init__(self, name: str, custom_field: int, custom_field_str: str, **kwargs
         super().__init__(name, **kwargs)
         self.custom_field = custom_field
         self.custom_field_str = custom_field_str
+
+
+@pytest.fixture
+def rich_root():
+    from rich.text import Text
+    from rich.tree import Tree as RichTree
+
+    rich_root = RichTree(Text("Grandparent", style="magenta"))
+    child = rich_root.add("Child")
+    _ = child.add(Text("Grandchild", style="red"))
+    _ = rich_root.add("Child 2")
+    return rich_root

tests/tree/construct/test_strings.py

@@ -531,3 +531,56 @@ def assert_tree_structure_phylogenetic_attr(root, attrs=["B", "D", "E", "S", "le
         assert (
             expected == actual
         ), f"Expected length to be {expected}, received {actual}"
+
+
+class TestRichtoTree:
+    @staticmethod
+    def test_rich_to_tree(rich_root, rich_console):
+        from bigtree.tree import export
+        from tests.conftest import assert_print_statement
+
+        root = construct.rich_to_tree(rich_root)
+        root_str = "Grandparent\n" "├── Child\n" "│   └── Grandchild\n" "└── Child 2\n"
+        assert_print_statement(
+            export.print_tree,
+            root_str,
+            tree=root,
+            rich=True,
+            console=rich_console,
+        )
+
+    @staticmethod
+    def test_rich_to_tree_attr(rich_root, rich_console):
+        from bigtree.tree import export
+        from tests.conftest import assert_print_statement
+
+        root = construct.rich_to_tree(rich_root)
+        root_str_attr = (
+            "Grandparent [style=magenta]\n"
+            "├── Child\n"
+            "│   └── Grandchild [style=red]\n"
+            "└── Child 2\n"
+        )
+        assert_print_statement(
+            export.print_tree,
+            root_str_attr,
+            tree=root,
+            all_attrs=True,
+        )
+        assert_print_statement(
+            export.print_tree,
+            root_str_attr,
+            tree=root,
+            all_attrs=True,
+            rich=True,
+            console=rich_console,
+        )
+        assert_print_statement(
+            export.print_tree,
+            root_str_attr,
+            tree=root,
+            all_attrs=True,
+            rich=True,
+            node_format_attr="style",
+            console=rich_console,
+        )

tests/tree/test_tree.py

@@ -244,6 +244,23 @@ def test_from_newick():
         assert_tree_structure_basenode_tree(tree)
         assert_tree_structure_basenode_root(tree.node)
 
+    @staticmethod
+    def test_from_rich():
+        from rich.text import Text
+        from rich.tree import Tree as RichTree
+
+        rich_root = RichTree(Text("a", style="magenta"))
+        b = rich_root.add("b", style="red")
+        _ = b.add("d")
+        e = b.add("e")
+        _ = e.add("g", style="yellow")
+        _ = e.add("h", style="yellow")
+        c = rich_root.add("c", style="red")
+        _ = c.add("f")
+        tree = Tree.from_rich(rich_root)
+        assert_tree_structure_basenode_tree(tree)
+        assert_tree_structure_basenode_root(tree.node)
+
 
 class TestTreeAdd(unittest.TestCase):