pydocspec.ext.ExtRegistrar

class documentation

class ExtRegistrar: (source)

View In Hierarchy

The extension registrar interface class.

Method register_astbuild_visitors Register AST visitor extensions.
Method register_astroid_transforms Register an astroid extensions.
Method register_mixins Register mixin classes for model objects. Mixins shoud extend one of the base mixin classes in pydocspec.ext module, i.e. ClassMixin or ApiObjectMixin, etc.
Method register_postbuild_visitors Register post-build visitor extensions.
Instance Variable extname Undocumented
Static Method _setattr_extname_on_objs Undocumented
Instance Variable _builder Undocumented
def register_astbuild_visitors(self, *visitors): (source)

Register AST visitor extensions.

Parameters
*visitors:Union[AstVisitorExt, Type[AstVisitorExt]]Undocumented
def register_astroid_transforms(self, *transforms): (source)

Register an astroid extensions.

Parameters
*transforms:Type[Union[AstroidInferenceTip, AstroidTransform]]Undocumented
def register_mixins(self, *mixins): (source)

Register mixin classes for model objects. Mixins shoud extend one of the base mixin classes in pydocspec.ext module, i.e. ClassMixin or ApiObjectMixin, etc.

Parameters
*mixins:Type[Any]Undocumented
def register_postbuild_visitors(self, *visitors): (source)

Register post-build visitor extensions.

Parameters
*visitors:Union[ApiObjectVisitorExt, Type[ApiObjectVisitorExt]]Undocumented
extname: str = (source)

Undocumented

@staticmethod
def _setattr_extname_on_objs(obs, name): (source)

Undocumented

Parameters
obs:Iterable[Any]Undocumented
name:strUndocumented
_builder: astbuilder.Builder = (source)

Undocumented