✨ NEW: Add SyntaxTreeNode.walk (#148)

Author: hukkinj1

markdown_it/tree.py

@@ -4,6 +4,7 @@
 """
 import textwrap
 from typing import (
+    Generator,
     NamedTuple,
     Sequence,
     Tuple,
@@ -248,6 +249,19 @@ def pretty(
             )
         return text
 
+    def walk(
+        self: _NodeType, *, include_self: bool = True
+    ) -> Generator[_NodeType, None, None]:
+        """Recursively yield all descendant nodes in the tree starting at self.
+
+        The order mimics the order of the underlying linear token
+        stream (i.e. depth first).
+        """
+        if include_self:
+            yield self
+        for child in self.children:
+            yield from child.walk(include_self=True)
+
     # NOTE:
     # The values of the properties defined below directly map to properties
     # of the underlying `Token`s. A root node does not translate to a `Token`

tests/test_tree.py

@@ -72,3 +72,22 @@ def test_pretty(file_regression):
     )
     node = SyntaxTreeNode(tokens)
     file_regression.check(node.pretty(indent=2, show_text=True), extension=".xml")
+
+
+def test_walk():
+    tokens = MarkdownIt().parse(EXAMPLE_MARKDOWN)
+    tree = SyntaxTreeNode(tokens)
+    expected_node_types = (
+        "root",
+        "heading",
+        "inline",
+        "text",
+        "paragraph",
+        "inline",
+        "text",
+        "strong",
+        "text",
+        "text",
+    )
+    for node, expected_type in zip(tree.walk(), expected_node_types):
+        assert node.type == expected_type