class documentation

class ZopeInterfaceClass(model.Class):

View In Hierarchy

Undocumented

Method setup Undocumented
Class Variable baseobjects Undocumented
Class Variable implementedby​_directly Only defined when isinterface == True.
Class Variable implements​Only Undocumented
Class Variable isinterface Undocumented
Class Variable isinterfaceclass Undocumented
Class Variable isschemafield Undocumented
Class Variable subclasses Undocumented
Instance Variable implements​_directly Undocumented
Property all​Implemented​Interfaces Return all the interfaces implemented by this class.

Inherited from Class:

Method allbases Undocumented
Method find Look up a name in this class and its base classes.
Class Variable auto​_attribs True iff this class uses the auto_attribs feature of the attrs library to automatically convert annotated fields into attributes.
Class Variable bases Undocumented
Class Variable decorators Undocumented
Class Variable parent Undocumented
Class Variable raw​_decorators Undocumented
Instance Variable rawbases Undocumented
Property constructor​_params A mapping of constructor parameter names to their type annotation. If a parameter is not annotated, its value is None.
Method _local​Name​To​Full​Name Undocumented

Inherited from CanContainImportsDocumentable (via Class):

Instance Variable _local​Name​To​Full​Name_map Undocumented

Inherited from Documentable (via Class, CanContainImportsDocumentable):

Method __init__ Undocumented
Method __repr__ Undocumented
Method docsources Objects that can be considered as a source of documentation.
Method expand​Name Return a fully qualified name for the possibly-dotted `name`.
Method full​Name Undocumented
Method reparent Undocumented
Method report Log an error or warning about this documentable object.
Method resolve​Name Return the object named by "name" (using Python's lookup rules) in this context, if any is known to pydoctor.
Method set​Docstring Undocumented
Method set​Line​Number Undocumented
Class Variable kind Undocumented
Class Variable parsed​_docstring Undocumented
Class Variable parsed​_type Undocumented
Instance Variable contents Undocumented
Instance Variable docstring The object's docstring. But also see docsources.
Instance Variable docstring​_lineno Undocumented
Instance Variable linenumber Undocumented
Instance Variable name Undocumented
Instance Variable parent​Mod Undocumented
Instance Variable source​_path Undocumented
Instance Variable source​Href Undocumented
Instance Variable system The system the object is part of.
Property description A string describing our source location to the user.
Property doctarget Undocumented
Property is​Private Is this object considered private API?
Property is​Visible Is this object so private as to be not shown at all?
Property module This object's Module.
Property page​_object The documentable to which the page we're documented on belongs. For example methods are documented on the page of their class, functions are documented in their module's page etc.
Property privacy​Class How visible this object should be.
Property url Relative URL at which the documentation for this Documentable can be found.
Method ​_handle​_reparenting​_post Undocumented
Method ​_handle​_reparenting​_pre Undocumented
Instance Variable ​_deprecated​_info Undocumented
def setup(self):

Undocumented

baseobjects: List[Optional[ZopeInterfaceClass]] =

Undocumented

implementedby_directly: List[Union[ZopeInterfaceClass, ZopeInterfaceModule]] =
Only defined when isinterface == True.
implementsOnly: bool =

Undocumented

isinterface: bool =

Undocumented

isinterfaceclass: bool =

Undocumented

isschemafield: bool =

Undocumented

subclasses: List[ZopeInterfaceClass] =

Undocumented

implements_directly: List[str] =

Undocumented

@property
allImplementedInterfaces: Iterable[str] =

Return all the interfaces implemented by this class.

This returns them in something like the classic class MRO.