pydoctor.model.Class

class documentation

class Class(CanContainImportsDocumentable):

Known subclasses: pydoctor.zopeinterface.ZopeInterfaceClass

Undocumented

Method	`allbases`	Undocumented
Method	`find`	Look up a name in this class and its base classes.
Method	`setup`	Undocumented
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	`baseobjects`	Undocumented
Class Variable	`bases`	Undocumented
Class Variable	`decorators`	Undocumented
Class Variable	`parent`	Undocumented
Class Variable	`raw_decorators`	Undocumented
Instance Variable	`rawbases`	Undocumented
Instance Variable	`subclasses`	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	`_localNameToFullName`	Undocumented

Inherited from CanContainImportsDocumentable:

Instance Variable _localNameToFullName_map Undocumented

Inherited from Documentable (via CanContainImportsDocumentable):

Method	`__init__`	Undocumented
Method	`__repr__`	Undocumented
Method	`docsources`	Objects that can be considered as a source of documentation.
Method	`expandName`	Return a fully qualified name for the possibly-dotted `name`.
Method	`fullName`	Undocumented
Method	`reparent`	Undocumented
Method	`report`	Log an error or warning about this documentable object.
Method	`resolveName`	Return the object named by "name" (using Python's lookup rules) in this context, if any is known to pydoctor.
Method	`setDocstring`	Undocumented
Method	`setLineNumber`	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	`parentMod`	Undocumented
Instance Variable	`source_path`	Undocumented
Instance Variable	`sourceHref`	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	`isPrivate`	Is this object considered private API?
Property	`isVisible`	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	`privacyClass`	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 allbases(self, include_self=False):

Undocumented

Parameters
include_self:`bool`	Undocumented
Returns
`Iterator[Class]`	Undocumented

def find(self, name):

Look up a name in this class and its base classes.

Parameters
name:`str`	Undocumented
Returns
`Optional[Documentable]`	the object with the given name, or `None` if there isn't one

def setup(self):

overrides pydoctor.model.CanContainImportsDocumentable.setup

overridden in pydoctor.zopeinterface.ZopeInterfaceClass

Undocumented

auto_attribs: bool =

True iff this class uses the auto_attribs feature of the attrs library to automatically convert annotated fields into attributes.

baseobjects: List[Optional[Class]] =

overridden in pydoctor.zopeinterface.ZopeInterfaceClass

Undocumented

bases: List[str] =

Undocumented

decorators: Sequence[Tuple[str, Optional[Sequence[ast.expr]]]] =

Undocumented

parent: CanContainImportsDocumentable =

overrides pydoctor.model.Documentable.parent

Undocumented

raw_decorators: Sequence[ast.expr] =

Undocumented

rawbases: List[str] =

Undocumented

subclasses: List[Class] =

overridden in pydoctor.zopeinterface.ZopeInterfaceClass

Undocumented

@property
constructor_params: Mapping[str, Optional[ast.expr]] =

A mapping of constructor parameter names to their type annotation. If a parameter is not annotated, its value is None.

def _localNameToFullName(self, name):

overrides pydoctor.model.Documentable._localNameToFullName

Undocumented

Parameters
name:`str`	Undocumented
Returns
`str`	Undocumented