Walk

Functions for walking the DOM.

Note

For most purposes you would be better off using query, which uses these functions internally.

walk_breadth_first `function` ¶

def walk_breadth_first(
    root, filter_type=None, *, with_root=True
):

Walk the tree breadth first (children first).

Note

Avoid changing the DOM (mounting, removing etc.) while iterating with this function. Consider walk_children which doesn't have this limitation.

Parameter	Default	Description
`root` `DOMNode`	required	The root note (starting point).
`filter_type` `type[WalkType] \| None`	`None`	Optional DOMNode subclass to filter by, or `None` for no filter.
`with_root` `bool`	`True`	Include the root in the walk.

Type	Description
`Iterable[DOMNode] \| Iterable[WalkType]`	An iterable of DOMNodes, or the type specified in `filter_type`.

def walk_depth_first(root, filter_type=None, *, with_root=True):

Walk the tree depth first (parents first).

Note

Avoid changing the DOM (mounting, removing etc.) while iterating with this function. Consider walk_children which doesn't have this limitation.

Parameter	Default	Description
`root` `DOMNode`	required	The root note (starting point).
`filter_type` `type[WalkType] \| None`	`None`	Optional DOMNode subclass to filter by, or `None` for no filter.
`with_root` `bool`	`True`	Include the root in the walk.

Type	Description
`Iterable[DOMNode] \| Iterable[WalkType]`	An iterable of DOMNodes, or the type specified in `filter_type`.