docutils.nodes.SparseNodeVisitor

class documentation

class SparseNodeVisitor(NodeVisitor): (source)

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