Skip to content

🌸 BinaryNode

bigtree.node.binarynode

BinaryNode 

BinaryNode(
    name="",
    left=None,
    right=None,
    parent=None,
    children=None,
    **kwargs
)

Bases: Node

BinaryNode is an extension of Node, and is able to extend to any Python class for Binary Tree implementation. Nodes can have attributes if they are initialized from BinaryNode, dictionary, or pandas DataFrame.

BinaryNode can be linked to each other with children, left, or right setter methods. If initialized with children, it must be length 2, denoting left and right child.

Examples:

>>> from bigtree import BinaryNode, print_tree
>>> a = BinaryNode(1)
>>> b = BinaryNode(2)
>>> c = BinaryNode(3)
>>> d = BinaryNode(4)
>>> a.children = [b, c]
>>> b.right = d
>>> print_tree(a)
1
├── 2
│   └── 4
└── 3

Directly passing left, right, or children argument.

>>> from bigtree import BinaryNode
>>> d = BinaryNode(4)
>>> c = BinaryNode(3)
>>> b = BinaryNode(2, right=d)
>>> a = BinaryNode(1, children=[b, c])

BinaryNode Creation

Node can be created by instantiating a BinaryNode class or by using a dictionary. If node is created with dictionary, all keys of dictionary will be stored as class attributes.

>>> from bigtree import BinaryNode
>>> a = BinaryNode.from_dict({"name": "1"})
>>> a
BinaryNode(name=1, val=1)

BinaryNode Attributes

These are node attributes that have getter and/or setter methods.

Get BinaryNode configuration

  1. left: Get left children
  2. right: Get right children

left property writable 

left

Get left children.

Returns:

Type Description
T

Left child

right property writable 

right

Get right children.

Returns:

Type Description
T

Right child

parent property writable 

parent

Get parent node.

Returns:

Type Description
Optional[T]

Parent node, none if the node is root

children deletable property writable 

children

Get child nodes.

Returns:

Type Description
Tuple[T, ...]

Child nodes

is_leaf property 

is_leaf

Get indicator if self is leaf node.

Returns:

Type Description
bool

Indicator if node is leaf node

parents property writable 

parents

Do not allow parents attribute to be accessed.

Raises:

Type Description
AttributeError

No such attribute

ancestors property 

ancestors

Get iterator to yield all ancestors of self, does not include self.

Returns:

Type Description
Iterable[T]

Ancestor(s) of node excluding itself

descendants property 

descendants

Get iterator to yield all descendants of self, does not include self.

Returns:

Type Description
Iterable[T]

Descendant(s) of node excluding itself

leaves property 

leaves

Get iterator to yield all leaf nodes from self.

Returns:

Type Description
Iterable[T]

Leaf node(s) of node

siblings property 

siblings

Get siblings of self.

Returns:

Type Description
Iterable[T]

Sibling(s) of node

left_sibling property 

left_sibling

Get sibling left of self.

Returns:

Type Description
Optional[T]

Left sibling of node

right_sibling property 

right_sibling

Get sibling right of self.

Returns:

Type Description
Optional[T]

Right sibling of node

node_path property 

node_path

Get tuple of nodes starting from root.

Returns:

Type Description
Iterable[T]

Node path from root to itself

is_root property 

is_root

Get indicator if self is root node.

Returns:

Type Description
bool

Indicator if node is root node

root property 

root

Get root node of tree.

Returns:

Type Description
T

Root node

diameter property 

diameter

Get diameter of tree or subtree, the length of longest path between any two nodes.

Returns:

Type Description
int

Diameter of node

depth property 

depth

Get depth of self, indexing starts from 1.

Returns:

Type Description
int

Depth of node

max_depth property 

max_depth

Get maximum depth from root to leaf node.

Returns:

Type Description
int

Maximum depth of tree

sep property writable 

sep

Get separator, gets from root node.

Returns:

Type Description
str

Seperator

node_name property 

node_name

Get node name.

Returns:

Type Description
str

Node name

path_name property 

path_name

Get path name, separated by self.sep.

Returns:

Type Description
str

Path name

sort 

sort(**kwargs)

Sort children, possible keyword arguments include key=lambda node: node.val, reverse=True.

Examples:

>>> from bigtree import BinaryNode, print_tree
>>> a = BinaryNode(1)
>>> c = BinaryNode(3, parent=a)
>>> b = BinaryNode(2, parent=a)
>>> print_tree(a)
1
├── 3
└── 2
>>> a.sort(key=lambda node: node.val)
>>> print_tree(a)
1
├── 2
└── 3

from_dict classmethod 

from_dict(input_dict)

Construct node from dictionary, all keys of dictionary will be stored as class attributes. Input dictionary must have key name if not Node will not have any name.

Examples:

>>> from bigtree import Node
>>> a = Node.from_dict({"name": "a", "age": 90})

Parameters:

Name Type Description Default
input_dict Mapping[str, Any]

node information, key: attribute name, value: attribute value

 required

Returns:

Type Description
BaseNode

Base node

describe 

describe(exclude_attributes=(), exclude_prefix='')

Get node information sorted by attribute name, returns list of tuples.

Examples:

>>> from bigtree.node.node import Node
>>> a = Node('a', age=90)
>>> a.describe()
[('_BaseNode__children', []), ('_BaseNode__parent', None), ('_sep', '/'), ('age', 90), ('name', 'a')]
>>> a.describe(exclude_prefix="_")
[('age', 90), ('name', 'a')]
>>> a.describe(exclude_prefix="_", exclude_attributes=["name"])
[('age', 90)]

Parameters:

Name Type Description Default
exclude_attributes Iterable[str]

attributes to exclude

 ()
exclude_prefix str

prefix of attributes to exclude

 ''

Returns:

Type Description
List[Tuple[str, Any]]

List of attribute name and attribute value pairs

get_attr 

get_attr(attr_name, default_value=None)

Get value of node attribute. Returns default value if attribute name does not exist.

Examples:

>>> from bigtree.node.node import Node
>>> a = Node('a', age=90)
>>> a.get_attr("age")
90

Parameters:

Name Type Description Default
attr_name str

attribute name

 required
default_value Any

default value if attribute does not exist

 None

Returns:

Type Description
Any

Attribute value of node

set_attrs 

set_attrs(attrs)

Set node attributes.

Examples:

>>> from bigtree.node.node import Node
>>> a = Node('a')
>>> a.set_attrs({"age": 90})
>>> a
Node(/a, age=90)

Parameters:

Name Type Description Default
attrs Mapping[str, Any]

attribute information, key: attribute name, value: attribute value

 required

go_to 

go_to(node)

Get path from current node to specified node from same tree, uses get_path function.

Parameters:

Name Type Description Default
node T

node to travel to from current node, inclusive of start and end node

 required

Returns:

Type Description
Iterable[T]

Path from current node to destination node

append 

append(other)

Add other as child of self. Can be chained.

Parameters:

Name Type Description Default
other T

other node, child to be added

 required

extend 

extend(others)

Add others as children of self. Can be chained.

Parameters:

Name Type Description Default
others List[T]

other nodes, children to be added

 required

copy 

copy()

Deep copy self; clone BaseNode.

Examples:

>>> from bigtree.node.node import Node
>>> a = Node('a')
>>> a_copy = a.copy()

Returns:

Type Description
T

Cloned copy of node

plot 

plot(*args, **kwargs)

Plot tree in line form. Accepts args and kwargs for matplotlib.pyplot.plot() function.

Examples:

>>> from bigtree import list_to_tree
>>> path_list = ["a/b/d", "a/b/e/g", "a/b/e/h", "a/c/f"]
>>> root = list_to_tree(path_list)
>>> root.plot("-ok")
<Figure size 1280x960 with 1 Axes>

query 

query(query, debug=False)

Query tree using Tree Definition Language.

Examples:

>>> from bigtree import list_to_tree
>>> path_list = ["a/b/d", "a/b/e/g", "a/b/e/h", "a/c/f"]
>>> root = list_to_tree(path_list)
>>> root.query("depth == 2")
[Node(/a/b, ), Node(/a/c, )]

Parameters:

Name Type Description Default
query str

query

 required
debug bool

if True, will print out the parsed query

 False

Returns:

Type Description
List[T]

List of nodes that fulfil the condition of query

show 

show(**kwargs)

Print tree to console, takes in same keyword arguments as print_tree function.

hshow 

hshow(**kwargs)

Print tree in horizontal orientation to console, takes in same keyword arguments as hprint_tree function.

vshow 

vshow(**kwargs)

Print tree in vertical orientation to console, takes in same keyword arguments as vprint_tree function.