Skip to content

Walk

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.

Parameters:

Name Type Description Default
root DOMNode

The root note (starting point).

required
filter_type type[WalkType] | None

Optional DOMNode subclass to filter by, or None for no filter. Defaults to None.

None
with_root bool

Include the root in the walk. Defaults to True.

True

Returns:

Type Description
Iterable[DOMNode] | Iterable[WalkType]

Iterable[DOMNode] | Iterable[WalkType]: An iterable of DOMNodes, or the type specified in filter_type.

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.

Parameters:

Name Type Description Default
root DOMNode

The root note (starting point).

required
filter_type type[WalkType] | None

Optional DOMNode subclass to filter by, or None for no filter. Defaults to None.

None
with_root bool

Include the root in the walk. Defaults to True.

True

Returns:

Type Description
Iterable[DOMNode] | Iterable[WalkType]

Iterable[DOMNode] | Iterable[WalkType]: An iterable of DOMNodes, or the type specified in filter_type.