textual.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 ¶
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
|
with_root |
bool
|
Include the root in the walk. |
True
|
Returns:
Type | Description |
---|---|
Iterable[DOMNode] | Iterable[WalkType]
|
An iterable of DOMNodes, or the type specified in |
walk_depth_first ¶
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
|
with_root |
bool
|
Include the root in the walk. |
True
|
Returns:
Type | Description |
---|---|
Iterable[DOMNode] | Iterable[WalkType]
|
An iterable of DOMNodes, or the type specified in |