pydoctor.extensions.zopeinterface

module documentation
(source)

Support for Zope interfaces.

Class ZopeInterfaceAttribute Undocumented
Class ZopeInterfaceClass No class docstring; 1/1 property, 0/2 instance variable, 1/6 class variable, 0/1 method documented
Class ZopeInterfaceFunction Undocumented
Class ZopeInterfaceModule No class docstring; 1/1 property, 0/1 instance variable, 0/1 method documented
Class ZopeInterfaceModuleVisitor Undocumented
Function addInterfaceInfoToClass Undocumented
Function addInterfaceInfoToModule Undocumented
Function addInterfaceInfoToScope Mark the given class or module as implementing the given interfaces.
Function namesInterface Undocumented
Function postProcess Undocumented
Function setup_pydoctor_extension Undocumented
Variable interface_prog Undocumented
Variable schema_prog Undocumented
Function _handle_implemented This is the counterpart to addInterfaceInfoToScope(), which is called during post-processing.
Function _inheritedDocsources Undocumented
def addInterfaceInfoToClass(cls: ZopeInterfaceClass, interfaceargs: Iterable[ast.expr], ctx: model.Documentable, implementsOnly: bool): (source)

Undocumented

def addInterfaceInfoToModule(module: ZopeInterfaceModule, interfaceargs: Iterable[ast.expr]): (source)

Undocumented

def addInterfaceInfoToScope(scope: ZopeInterfaceClass | ZopeInterfaceModule, interfaceargs: Iterable[ast.expr], ctx: model.Documentable): (source)

Mark the given class or module as implementing the given interfaces.

Parameters
scope:ZopeInterfaceClass | ZopeInterfaceModuleclass or module to modify
interfaceargs:Iterable[ast.expr]AST expressions of interface objects
ctx:model.Documentablecontext in which interfaceargs are looked up
def namesInterface(system: model.System, name: str) -> bool: (source)

Undocumented

def postProcess(self: model.System): (source)

Undocumented

def setup_pydoctor_extension(r: extensions.ExtRegistrar): (source)

Undocumented

interface_prog = (source)

Undocumented

schema_prog = (source)

Undocumented

def _handle_implemented(implementer: ZopeInterfaceClass | ZopeInterfaceModule): (source)

This is the counterpart to addInterfaceInfoToScope(), which is called during post-processing.

def _inheritedDocsources(obj: model.Documentable) -> Iterator[model.Documentable]: (source)

Undocumented