pydoctor.extensions.zopeinterface

module documentation
(source)

Support for Zope interfaces.

Class ZopeInterfaceAttribute Undocumented
Class ZopeInterfaceClass No class docstring; 1/1 property, 0/1 instance variable, 1/7 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, interfaceargs, ctx, implementsOnly): (source)

Undocumented

Parameters
cls:ZopeInterfaceClassUndocumented
interfaceargs:Iterable[ast.expr]Undocumented
ctx:model.DocumentableUndocumented
implementsOnly:boolUndocumented
def addInterfaceInfoToModule(module, interfaceargs): (source)

Undocumented

Parameters
module:ZopeInterfaceModuleUndocumented
interfaceargs:Iterable[ast.expr]Undocumented
def addInterfaceInfoToScope(scope, interfaceargs, ctx): (source)

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

Parameters
scope:Union[ZopeInterfaceClass, ZopeInterfaceModule]class 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, name): (source)

Undocumented

Parameters
system:model.SystemUndocumented
name:strUndocumented
Returns
boolUndocumented
def postProcess(self): (source)

Undocumented

Parameters
self:model.SystemUndocumented
def setup_pydoctor_extension(r): (source)

Undocumented

Parameters
r:extensions.ExtRegistrarUndocumented
interface_prog = (source)

Undocumented

schema_prog = (source)

Undocumented

def _handle_implemented(implementer): (source)

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

Parameters
implementer:Union[ZopeInterfaceClass, ZopeInterfaceModule]Undocumented
def _inheritedDocsources(obj): (source)

Undocumented

Parameters
obj:model.DocumentableUndocumented
Returns
Iterator[model.Documentable]Undocumented