Bigtree

1.4.0 · active · verified Tue Apr 14

Bigtree is a Python library that provides a performant, flexible, and intuitive implementation for tree data structures. It supports various tree types (Tree, Binary Tree, Directed Acyclic Graph) and offers a rich API for traversal, search, modification, and export. It integrates seamlessly with Python lists, dictionaries, pandas, and polars DataFrames, making it suitable for a wide range of hierarchical data workflows. The library is actively maintained with frequent releases, currently at version 1.4.0.

Warnings

gotcha Node names cannot contain the separator symbol (default '/'). While it won't immediately raise an error, it can lead to issues with certain functions like tree export/import or path-based operations.
Fix: Ensure node names do not contain path separator characters (e.g., '/', '\\', or custom separators if configured).
gotcha The `get_attr` method, especially for `BaseNode`/`DAGNode`, was enhanced in v1.3.0 to support chained and nested attributes and to return a default value instead of raising an error if the attribute is not found. Code relying on an `AttributeError` for missing attributes or expecting simple attribute access might need adjustments.
Fix: Review existing `get_attr` calls. If you previously handled `AttributeError` for missing attributes, consider using the `default` parameter of `get_attr` (e.g., `node.get_attr('missing_attr', None)`). Be aware of new nested attribute access capabilities.
breaking Version 1.0.0 and subsequent releases (e.g., 1.0.2) introduced significant API improvements and a plugin architecture. While core usage remains largely compatible, users with highly customized node types or those directly interacting with internal components might need to refactor their code to align with the new plugin-based structure.
Fix: Consult the official `bigtree` documentation and changelog, particularly for versions 1.0.0 and 1.0.2, if you experience unexpected behavior or `AttributeError` when upgrading from pre-1.0.0 versions, especially for advanced use cases or custom node extensions.

Install

pip install bigtree Core library
pip install 'bigtree[pandas,polars,rich]' With common optional dependencies

Imports

Node
```
from bigtree import Node
```
print_tree
```
from bigtree import print_tree
```
DAGNode
```
from bigtree import DAGNode
```
Used for Directed Acyclic Graph structures where nodes can have multiple parents.
BinaryNode
```
from bigtree import BinaryNode
```
Used for binary tree structures.

Quickstart

This example demonstrates how to create a basic tree using `Node` objects and print its structure to the console using `print_tree`. It also shows how to access built-in node attributes like `is_leaf` and `node_name`.

from bigtree import Node, print_tree

# Create nodes
root = Node("a")
b = Node("b", parent=root)
c = Node("c", parent=root)
d = Node("d", parent=b)
e = Node("e", parent=b)
f = Node("f", parent=c)

# Print the tree
print_tree(root)

# Access node attributes
print(f"Node 'd' is a leaf: {d.is_leaf}")
print(f"Root node name: {root.node_name}")

view raw JSON →