Function tree

binarytree/__init__.py:2307–2389

Generate a random binary tree and return its root node. :param height: Height of the tree (default: 3, range: 0 - 9 inclusive). :type height: int :param is_perfect: If set to True (default: False), a perfect binary tree with all levels filled is returned. If set to False, a perf

(
    height: int = 3,
    is_perfect: bool = False,
    letters: bool = False,
)

def tree(
    height: int = 3,
    is_perfect: bool = False,
    letters: bool = False,
) -> Optional[Node]:
    """Generate a random binary tree and return its root node.

    :param height: Height of the tree (default: 3, range: 0 - 9 inclusive).
    :type height: int
    :param is_perfect: If set to True (default: False), a perfect binary tree
        with all levels filled is returned. If set to False, a perfect binary
        tree may still be generated by chance.
    :type is_perfect: bool
    :param letters: If set to True (default: False), uppercase alphabet letters are
        used for node values instead of numbers.
    :type letters: bool
    :return: Root node of the binary tree.
    :rtype: binarytree.Node
    :raise binarytree.exceptions.TreeHeightError: If height is invalid.

    **Example**:

    .. doctest::

        >>> from binarytree import tree
        >>>
        >>> root = tree()
        >>>
        >>> root.height
        3

    .. doctest::

        >>> from binarytree import tree
        >>>
        >>> root = tree(height=5, is_perfect=True)
        >>>
        >>> root.height
        5
        >>> root.is_perfect
        True

    .. doctest::

        >>> from binarytree import tree
        >>>
        >>> root = tree(height=20)  # doctest: +IGNORE_EXCEPTION_DETAIL
        Traceback (most recent call last):
         ...
        binarytree.exceptions.TreeHeightError: height must be an int between 0 - 9
    """
    _validate_tree_height(height)
    numbers = _generate_random_numbers(height)
    values: NodeValueList = (
        list(map(number_to_letters, numbers)) if letters else numbers
    )

    if is_perfect: