pydoctor.visitor.VisitorExt

class documentation

class VisitorExt(_BaseVisitor[T]): (source)

Known subclasses: pydoctor.astutils.NodeVisitorExt

Constructor: VisitorExt()

View In Hierarchy

The node visitor extension base class, to inherit from.

Subclasses must define the when class variable, and any custom visit_* methods.

See: When

Method __init__ Initialize the visitor extension.
Method attach Attach the parent visitor to this extension.
Method unknown_departure Called before exiting unknown object types.
Method unknown_visit Called when entering unknown object types.
Instance Variable visitor The parent visitor

Inherited from _BaseVisitor:

Method depart Depart an object.
Method visit Visit an object.
def __init__(self): (source)

Initialize the visitor extension.

def attach(self, visitor: Visitor[T]): (source)

Attach the parent visitor to this extension.

Parameters:
visitor: The parent visitor.
def unknown_departure(self, ob: T): (source)
overrides pydoctor.visitor._BaseVisitor.unknown_departure

Called before exiting unknown object types.

Raise exception unless overridden.

def unknown_visit(self, ob: T): (source)
overrides pydoctor.visitor._BaseVisitor.unknown_visit

Called when entering unknown object types.

Raise an exception unless overridden.

visitor: Visitor[T] = (source)
overridden in pydoctor.extensions.ModuleVisitorExt

The parent visitor