class documentation

class TreePruningException(Exception): (source)

Known subclasses: docutils.nodes.NodeFound, docutils.nodes.SkipChildren, docutils.nodes.SkipDeparture, docutils.nodes.SkipNode, docutils.nodes.SkipSiblings, docutils.nodes.StopTraversal

View In Hierarchy

Base class for NodeVisitor-related tree pruning exceptions.

Raise subclasses from within visit_... or depart_... methods called from Node.walk() and Node.walkabout() tree traversals to prune the tree traversed.