Function extract_node

tests/utils.py:143–169

Walk down a docutils node tree by repeatedly indexing children. Returns a Node (could be Element, Text, etc.) Example:: extract_node(doc, 0, 2, 1) == doc[0][2][1]

(node: Node, /, *indices: int)

def extract_node(node: Node, /, *indices: int) -> Node:
    """Walk down a docutils node tree by repeatedly indexing children.

    Returns a Node (could be Element, Text, etc.)

    Example::

        extract_node(doc, 0, 2, 1) == doc[0][2][1]
    """
    current: Node = node

    for depth, i in enumerate(indices):
        path = ''.join(f'[{i}]' for i in indices[:depth])
        assert isinstance(current, nodes.Element), (
            f'Expected node{path} (at depth {depth}) to be an Element '
            f'before indexing with [{i}], got {type(current).__name__!r}'
        )
        try:
            current = current[i]
        except IndexError as exc:
            msg = (
                f'Index {i} out of range for node{path} (at depth {depth}) '
                f'for {type(current).__name__!r}'
            )
            raise AssertionError(msg) from exc

    return current


def extract_element(node: Node, /, *indices: int) -> Element: