Welcome to pynodes’s documentation!

pynodes is a Python library to manage Nodes classes. A node is an object which is related to other nodes given a tree chart.

(venv) $ pip install pynodes

Basic Usage

import pynodes
node = pynodes.Node()

class pynodes.Node(name: str, parent: Node | None = None)

Should be subclassed only

add_child(child: Node) → None

add new child node to current instance

static check_lineage(nodes: list[Node]) → bool

check if the list of nodes is a straight lineage:

node 1 (ancestor) -> node 2 -> node 3 -> … -> node n (grand children)

classmethod create_random_nodes(type_: str = 'cmd', depth: int = 0) → Node

Creates random tree of nodes for testing purpose

property level: int

returns the level of the Node object

property parents: list[Node]

returns all the ancestors of the Node object

property path: str

returns a representation of the ancestor lineage of self

pretty_print() → None

print children tree from current instance

classmethod reset_stats() → None

reset all the ClassVar members

property siblings: list[Node]

returns all the siblings of the Node object

Indices and tables

• Index

• Module Index

• Search Page