Fix printing tree with rich and attribute square brackets (#437)

* test: rename variables

* test: rename variables + ensure tree helper methods return Tree type

* docs: enhance docstring

* feat: add get_subtree as plugin

* docs: enhance docstring

* docs: update CHANGELOG

* test: rename variables

* feat: get_attr to support nested attr

* bump: v1.3.0

* test: handle warning from polar tests

* test: handle warning from polar tests

* fix: handle pandas v3

* fix: handle pandas v3

* fix: handle pandas v3

* fix: handle pandas v3

* docs: more examples for listing directories

* docs: more examples for listing directories

* docs: more examples for listing directories

* docs: Fix CHANGELOG

* bump: update CHANGELOG

* fix: Fix attr square brackets being confused as rich formatting

* bump: v1.3.1

Author: kayjan

CHANGELOG.md

@@ -11,6 +11,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Docs: Some grammar improvements in docstring.
 - Setup: Test with different Python environments.
 
+## [1.3.1] - 2026-02-13
+### Added:
+- Docs: More examples for listing directories.
+### Fixed:
+- Tree Export: Fix attr square brackets being confused as rich formatting.
+- Docs: Some grammar improvements in docstring.
+- Setup: Test with different Python environments.
+
 ## [1.3.0] - 2026-01-25
 ### Added:
 - Tree: Added modify methods as plugins.

bigtree/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.3.0"
+__version__ = "1.3.1"
 
 from bigtree._globals import Globals
 from bigtree.binarytree.binarytree import BinaryTree

bigtree/tree/export/stdout.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Any, Callable, Collection, Iterable, TypeVar
+from typing import Any, Callable, Iterable, TypeVar
 
 from bigtree.node import node
 from bigtree.utils import common, constants, exceptions
@@ -62,7 +62,6 @@ def print_rich(
             (e.g., `\U0001f600`), or anything rich supports. If string type, it refers to ``Node`` attribute for icon.
             If callable type, it takes in the node itself and returns the icon
     """
-    # Add rich formatting
     if icon_prefix_attr:
         node_str_prefix = common.get_attr(_node, icon_prefix_attr, "")
         node_str = f"{node_str_prefix} {node_str}" if node_str_prefix else node_str
@@ -73,8 +72,8 @@ def print_rich(
         _node_format = common.get_attr(_node, node_format_attr, node_format)
         node_str = f"[{_node_format}]{node_str}[/]" if _node_format else node_str
     if edge_format:
-        pre_str = f"[{edge_format}]{pre_str}[/{edge_format}]"
-        fill_str = f"[{edge_format}]{fill_str}[/{edge_format}]"
+        pre_str = f"[{edge_format}]{pre_str}[/]"
+        fill_str = f"[{edge_format}]{fill_str}[/]"
     console.print(f"{pre_str}{fill_str}{node_str}", **kwargs)
 
 
@@ -88,7 +87,7 @@ def print_tree(
     attr_format: str = "{k}={v}",
     attr_sep: str = ", ",
     attr_omit_null: bool = False,
-    attr_bracket: Collection[str] = ("[", "]"),
+    attr_bracket: tuple[str, str] = ("[", "]"),
     style: str | Iterable[str] | constants.BasePrintStyle = "const",
     **kwargs: Any,
 ) -> None:
@@ -274,6 +273,9 @@ def print_tree(
         from rich.console import Console
 
         kwargs["console"] = kwargs.get("console") or Console(force_terminal=True)
+        if attr_bracket[0] == "[":
+            # Handle specific case where [ will be mistaken as rich formatting
+            attr_bracket = ("\\" + attr_bracket[0], attr_bracket[1])
 
     for pre_str, fill_str, _node in yield_tree(
         tree=tree,

tests/tree/conftest.py

@@ -319,3 +319,15 @@ def tree_node_diff(tree_node):
     )
     node.Node("i", parent=other_tree_node, children=[node.Node("j")])
     return other_tree_node
+
+
+@pytest.fixture
+def rich_console():
+    from rich.console import Console
+
+    return Console(
+        # no_color=True,
+        record=False,
+        color_system=None,
+        force_terminal=False,
+    )

tests/tree/export/conftest.py

@@ -1,11 +1,28 @@
 import pytest
-from rich.console import Console
+
+from bigtree.node import node
+
+
+@pytest.fixture
+def tree_node_rich():
+    """
+    Root
+    ├── Child 1
+    │   └── Grandchild 1
+    └── Child 2
+    """
+    tree_node = node.Node("[magenta]Root[/]")
+    child_node = node.Node("Child [red]1[/red]", parent=tree_node)
+    _ = node.Node("Grand[blue]child[/] 1", parent=child_node)
+    _ = node.Node("[blue]Child[/] [red]2[/]", parent=tree_node)
+    return tree_node
 
 
 @pytest.fixture
-def rich_console():
-    return Console(
-        record=False,
-        color_system=None,
-        force_terminal=False,
+def tree_node_rich_str():
+    return (
+        """Root\n"""
+        """├── Child 1\n"""
+        """│   └── Grandchild 1\n"""
+        """└── Child 2\n"""
     )

tests/tree/export/test_stdout.py

@@ -603,6 +603,18 @@ def get_node_format(_node):
             console=rich_console,
         )
 
+    @staticmethod
+    def test_print_tree_rich_node_format_all_attrs(tree_node, rich_console):
+        assert_print_statement(
+            export.print_tree,
+            tree_node_str,
+            tree=tree_node,
+            all_attrs=True,
+            rich=True,
+            node_format="magenta",
+            console=rich_console,
+        )
+
     @staticmethod
     def test_print_tree_rich_edge_format(tree_node, rich_console):
         assert_print_statement(
@@ -638,6 +650,20 @@ def test_print_tree_rich_icon_attr(tree_node, rich_console):
             console=rich_console,
         )
 
+    @staticmethod
+    def test_print_tree_rich_substring(
+        tree_node_rich, tree_node_rich_str, rich_console
+    ):
+        assert_print_statement(
+            export.print_tree,
+            tree_node_rich_str,
+            tree=tree_node_rich,
+            rich=True,
+            icon_prefix_attr="icon",
+            icon_suffix_attr="icon_suffix",
+            console=rich_console,
+        )
+
 
 class TestHPrintTree:
     @staticmethod