docutils.nodes.SparseNodeVisitor

class documentation

class SparseNodeVisitor(NodeVisitor):

Known subclasses: docutils.transforms.peps.PEPZeroSpecial, docutils.transforms.references.DanglingReferencesVisitor

View In Hierarchy

Base class for sparse traversals, where only certain node types are of interest. When visit_... & depart_... methods should be implemented for all node types (such as for docutils.writers.Writer subclasses), subclass NodeVisitor instead.

Inherited from NodeVisitor:

Method __init__ Undocumented
Method dispatch​_departure Call self."depart_ + node class name" with node as parameter. If the depart_... method does not exist, call self.unknown_departure.
Method dispatch​_visit Call self."visit_ + node class name" with node as parameter. If the visit_... method does not exist, call self.unknown_visit.
Method unknown​_departure Called before exiting unknown Node types.
Method unknown​_visit Called when entering unknown Node types.
Class Variable optional Tuple containing node class names (as strings).
Instance Variable document Undocumented