class documentation

class ExtRegistrar: (source)

View In Hierarchy

The extension registrar class provides utilites to register an extension's components.

Method register_astbuilder_visitor Register AST visitor(s). Typically visitor extensions inherits from ModuleVisitorExt.
Method register_mixin Register mixin for model objects. Mixins shoud extend one of the base mixin classes in pydoctor.extensions module, i.e. ClassMixin or DocumentableMixin, etc.
Method register_post_processor Register post processor(s).
Instance Variable system Undocumented
def register_astbuilder_visitor(self, *visitor: type[astutils.NodeVisitorExt]): (source)

Register AST visitor(s). Typically visitor extensions inherits from ModuleVisitorExt.

def register_mixin(self, *mixin: type[MixinT]): (source)

Register mixin for model objects. Mixins shoud extend one of the base mixin classes in pydoctor.extensions module, i.e. ClassMixin or DocumentableMixin, etc.

def register_post_processor(self, *post_processor: Callable[[model.System], None], priority: int | None = None): (source)

Register post processor(s).

A post-processor is simply a one-argument callable receiving the processed model.System and doing stuff on the model.Documentable tree.

Parameters
*post_processor:Callable[[model.System], None]Undocumented
priority:int | NoneSee PriorityProcessor.

Undocumented