class documentation

Undocumented

Method allbases Iterate on all base objects of this class and it's super classes. Doesn't comply with MRO.
Method find Look up a name in this class and its base classes.
Method mro Get the method resution order of this class.
Method setup Undocumented
Class Variable decorators Undocumented
Instance Variable parent Undocumented
Instance Variable raw_decorators Undocumented
Instance Variable rawbases Undocumented
Instance Variable subclasses Undocumented
Property baseobjects Base objects, None value is inserted when the base class could not be found in the system.
Property bases Fully qualified names of the bases of this class.
Property constructor_params A mapping of constructor parameter names to their type annotation. If a parameter is not annotated, its value is None.
Property public_constructors The public constructors of this class. A public constructor must not be hidden and have arguments or have a docstring.
Method _init_mro Compute the correct value of the method resolution order returned by mro().
Method _localNameToFullName Undocumented
Class Variable _finalbaseobjects Undocumented
Class Variable _finalbases Undocumented
Instance Variable _initialbaseobjects Undocumented
Instance Variable _initialbases Undocumented
Instance Variable _mro Undocumented

Inherited from CanContainImportsDocumentable:

Method isNameDefined Is the given name defined in the globals/locals of self-context? Only the first name of a dotted name is checked.
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 expandAnnotationName Like expandName but gives precedence to the module scope when a name is defined both in the current scope and the module scope.
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 Save the linenumber of this object.
Class Variable kind Page location where we are documented.
Class Variable parsed_docstring Undocumented
Class Variable parsed_summary 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 extra_info A list to store extra informations about this documentable, as ParsedDocstring.
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 docstring_linker Returns an instance of DocstringLinker suitable for resolving names in the context of the object.
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 _linker Undocumented
def allbases(self, include_self: bool = False) -> Iterator[Class]: (source)

Iterate on all base objects of this class and it's super classes. Doesn't comply with MRO.

def find(self, name: str) -> Documentable | None: (source)

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

Returns
Documentable | Nonethe object with the given name, or None if there isn't one
@overload
def mro(self, include_external: Literal[True], include_self: bool = True) -> Sequence[Class | str]:
@overload
def mro(self, include_external: Literal[False] = False, include_self: bool = True) -> Sequence[Class]:
(source)

Get the method resution order of this class.

Note
The actual correct value is only set in post-processing, if mro() is called in the AST visitors, it will return the same as list(self.allbases(include_self)).
decorators: Sequence[tuple[str, Sequence[ast.expr] | None]] = (source)

Undocumented

raw_decorators: Sequence[ast.expr] = (source)

Undocumented

rawbases: Sequence[tuple[str, ast.expr]] = (source)

Undocumented

Base objects, None value is inserted when the base class could not be found in the system.

Note

This property is currently computed two times, a first time when we're visiting the ClassDef and initially creating the object. It's computed another time in post-processing to try to resolve the names that could not be resolved the first time. This is needed when there are import cycles.

Meaning depending on the state of the system, this property can return either the initial objects or the final objects

Fully qualified names of the bases of this class.

@property
constructor_params: Mapping[str, ast.expr | None] = (source)

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

@property
public_constructors: Sequence[Function] = (source)

The public constructors of this class. A public constructor must not be hidden and have arguments or have a docstring.

def _init_mro(self): (source)

Compute the correct value of the method resolution order returned by mro().

def _localNameToFullName(self, name: str) -> str: (source)
_finalbaseobjects: list[Class | None] | None = (source)

Undocumented

_finalbases: list[str] | None = (source)

Undocumented

_initialbaseobjects: list[Class | None] = (source)

Undocumented

_initialbases: list[str] = (source)

Undocumented

Undocumented