alihan/textual
1
0
Fork 0
mirror of https://github.com/Textualize/textual.git synced 2025-10-17 02:38:12 +03:00
Code Issues Packages Projects Releases Wiki Activity

docstrings

Browse Source
This commit is contained in:
Will McGugan
2022-11-11 09:38:17 +00:00
parent d93e300d95
commit 44e44da784
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/textual/walk.py
View File

@@ -38,7 +38,8 @@ def walk_depth_first(
!!! note:
Do not mutate the DOM while iterating. If you certain you need this, consider `Widget.walk_children`.
Avoid changing the DOM (mounting, removing etc.) while iterating with this function.
Consider [Widget.walk_children] which doesn't have this limitation.
Args:
root (DOMNode): The root note (starting point).
@@ -47,7 +48,7 @@ def walk_depth_first(
with_root (bool, optional): Include the root in the walk. Defaults to True.
Returns:
Iterable[DOMNode] | Iterable[WalkType]: An iterable of DOMNodes, or the type specified in `filter_type`.
Iterable[DOMNode] | Iterable[WalkType]: An iterable of DOMNodes, or the type specified in ``filter_type``.
"""
stack: list[Iterator[DOMNode]] = [iter(root.children)]
@@ -97,7 +98,8 @@ def walk_breadth_first(
!!! note:
Do not mutate the DOM while iterating. If you certain you need this, consider `Widget.walk_children`.
Avoid changing the DOM (mounting, removing etc.) while iterating with this function.
Consider [Widget.walk_children] which doesn't have this limitation.
Args:
root (DOMNode): The root note (starting point).
@@ -106,7 +108,7 @@ def walk_breadth_first(
with_root (bool, optional): Include the root in the walk. Defaults to True.
Returns:
Iterable[DOMNode] | Iterable[WalkType]: An iterable of DOMNodes, or the type specified in `filter_type`.
Iterable[DOMNode] | Iterable[WalkType]: An iterable of DOMNodes, or the type specified in ``filter_type``.
"""
queue: deque[DOMNode] = deque()