pydocspec.Class

class documentation

class Class(_model.Class, ApiObject): (source)

Represents a class definition.

Method	`__init__`	Undocumented
Method	`ancestors`	Reccursively returns `resolved_bases` for all bases.
Method	`find`	Look up a name in this class and its base classes.
Class Variable	`decorations`	A list of decorations used in the class definition.
Class Variable	`members`	The members of the API object.
Class Variable	`parent`	The parent of the API object.
Instance Variable	`constructor_method`	The constructor method of this class.
Instance Variable	`inherited_members`	Members inherited from superclasses.
Instance Variable	`is_abstractclass`	Whether this class is abstract.
Instance Variable	`is_exception`	Whether this class extends one of the standard library exceptions.
Instance Variable	`mro`	The method resoltion order of this class.
Instance Variable	`resolved_bases`	For each bases, try to resolve the name to an `ApiObject` or fallback to the expanded name.
Instance Variable	`subclasses`	The direct subclasses of this class.
Method	`_init_attribs`	A method to define extra attributes that will be set after initialization.

Inherited from Class:

Instance Variable	`bases_ast`	Undocumented
Instance Variable	`is_type_guarged`	Undocumented
Class Variable	`_spec_fields`	Undocumented
Instance Variable	`_ast`	Undocumented

Inherited from Class (via Class):

Instance Variable	`bases`	The list of base classes as code strings.
Instance Variable	`metaclass`	The metaclass used in the class definition as a code string.
Instance Variable	`modifiers`	A list of language-specific modifiers that were used to declare this #Variable object.
Instance Variable	`semantic_hints`	A list of hints that describe the object.

Inherited from HasMembers (via Class, Class):

Method sync_hierarchy Synchronize the hierarchy of this API object and all of it's children. This should be called when the #HasMembers.members are updated to ensure that all child objects reference the right #parent. Loaders are expected to return #ApiObject#s in a fully synchronized state such that the user does not have to call this method unless they are doing modifications to the tree.

Inherited from ApiObject (via Class, Class, HasMembers):

Instance Variable	`docstring`	The documentation string of the API object.
Instance Variable	`location`	The location of the API object, i.e. where it is sourced from/defined in the code.
Instance Variable	`name`	The name of the entity. This is usually relative to the respective parent of the entity, as opposed to it's fully qualified name/absolute name. However, that is more of a recommendation than rule. For example the #docspec_python loader by default returns #Module objects with their full module name (and does not create a module hierarchy).
Property	`path`	Returns a list of all of this API object's parents, from top to bottom. The list includes self as the last item.

Inherited from ApiObject (via Class):

Method	`__repr__`	Undocumented
Method	`__str__`	Undocumented
Method	`add_siblings`	A new nodes to the tree, siblings to this node.
Method	`get_member`	Retrieve a member from the API object. This will always return `None` for objects that don't support members (eg. `Function` and `Variable`).
Method	`get_members`	Like `get_member` but can return several items with the same name.
Method	`remove`	Undocumented
Method	`replace`	Replace this object by one or more objects.
Method	`walk`	Traverse a tree of objects, calling the `genericvisitor.Visitor.visit` method of `visitor` when entering each node.
Method	`walkabout`	Perform a tree traversal similarly to `walk()`, except also call the `genericvisitor.Visitor.depart` method before exiting each node.
Instance Variable	`root`	`TreeRoot` instance holding references to all objects in the tree.
Property	`dotted_name`	The fully qualified dotted name of this object, as `DottedName` instance.
Property	`full_name`	The fully qualified dotted name of this object, as string. This value is used as the key in the `ApiObject.root.all_objects` dictionnary.
Property	`module`	Undocumented
Property	`scope`	Undocumented
Method	`_members`	Undocumented
Method	`_remove_self`	Undocumented
Method	`_repr`	Undocumented

Inherited from ApiObject (via Class, ApiObject):

Method	`sync_hierarchy`	Synchronize the hierarchy of this API object and all of it's children. This should be called when the #HasMembers.members are updated to ensure that all child objects reference the right #parent. Loaders are expected to return #ApiObject#s in a fully synchronized state such that the user does not have to call this method unless they are doing modifications to the tree.
Instance Variable	`docstring`	The documentation string of the API object.
Instance Variable	`location`	The location of the API object, i.e. where it is sourced from/defined in the code.
Instance Variable	`name`	The name of the entity. This is usually relative to the respective parent of the entity, as opposed to it's fully qualified name/absolute name. However, that is more of a recommendation than rule. For example the #docspec_python loader by default returns #Module objects with their full module name (and does not create a module hierarchy).
Property	`path`	Returns a list of all of this API object's parents, from top to bottom. The list includes self as the last item.

Inherited from CanTriggerWarnings (via Class, ApiObject):

Method warn Undocumented

Inherited from GetMembersMixin (via Class, ApiObject):

Method __getitem__ Undocumented

Inherited from ApiObject:

Method	`expand_name`	Return a fully qualified name for the possibly-dotted `name`.
Method	`resolve_name`	Return the object named by "name" (using Python's lookup rules) in this context.
Class Variable	`docstring`	The documentation string of the API object.
Class Variable	`location`	The location of the API object, i.e. where it is sourced from/defined in the code.
Class Variable	`module`	Undocumented
Class Variable	`root`	`TreeRoot` instance holding references to all objects in the tree.
Instance Variable	`aliases`	Aliases to this object.
Instance Variable	`doc_sources`	Objects that can be considered as a source of documentation.
Method	`_local_to_full_name`	Undocumented
Method	`_resolve_indirection`	Follow an indirection and return the supposed full name of the origin object.

Inherited from ApiObject (via ApiObject):

Method	`__repr__`	Undocumented
Method	`__str__`	Undocumented
Method	`add_siblings`	A new nodes to the tree, siblings to this node.
Method	`get_member`	Retrieve a member from the API object. This will always return `None` for objects that don't support members (eg. `Function` and `Variable`).
Method	`get_members`	Like `get_member` but can return several items with the same name.
Method	`remove`	Undocumented
Method	`replace`	Replace this object by one or more objects.
Method	`walk`	Traverse a tree of objects, calling the `genericvisitor.Visitor.visit` method of `visitor` when entering each node.
Method	`walkabout`	Perform a tree traversal similarly to `walk()`, except also call the `genericvisitor.Visitor.depart` method before exiting each node.
Property	`dotted_name`	The fully qualified dotted name of this object, as `DottedName` instance.
Property	`full_name`	The fully qualified dotted name of this object, as string. This value is used as the key in the `ApiObject.root.all_objects` dictionnary.
Property	`scope`	Undocumented
Method	`_members`	Undocumented
Method	`_remove_self`	Undocumented
Method	`_repr`	Undocumented
Class Variable	`_spec_fields`	Undocumented

Inherited from ApiObject (via ApiObject, ApiObject):

Method	`sync_hierarchy`	Synchronize the hierarchy of this API object and all of it's children. This should be called when the #HasMembers.members are updated to ensure that all child objects reference the right #parent. Loaders are expected to return #ApiObject#s in a fully synchronized state such that the user does not have to call this method unless they are doing modifications to the tree.
Instance Variable	`name`	The name of the entity. This is usually relative to the respective parent of the entity, as opposed to it's fully qualified name/absolute name. However, that is more of a recommendation than rule. For example the #docspec_python loader by default returns #Module objects with their full module name (and does not create a module hierarchy).
Property	`path`	Returns a list of all of this API object's parents, from top to bottom. The list includes self as the last item.

Inherited from CanTriggerWarnings (via ApiObject, ApiObject):

Method warn Undocumented

Inherited from GetMembersMixin (via ApiObject, ApiObject):

Method __getitem__ Undocumented

def __init__(self, *args, **kwargs): (source)

overrides pydocspec._model.Class.__init__

Undocumented

Parameters
*args:`Any`	Undocumented
**kwargs:`Any`	Undocumented

def ancestors(self, include_self=False): (source)

Reccursively returns resolved_bases for all bases.

Parameters
include_self:`bool`	Undocumented
Returns
`Iterator[Union[Class, str]]`	Undocumented

def find(self, name, include_self=True): (source)

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

Parameters
name:`str`	Undocumented
include_self:`bool`	Undocumented
Returns
`Optional[ApiObject]`	The object with the given name, or `None` if there isn't one.

decorations: Optional[List[Decoration]] = (source)

overrides pydocspec._model.Class.decorations

A list of decorations used in the class definition.

members: List[ApiObject] = (source)

overrides pydocspec._model.Class.members

The members of the API object.

parent: Union[Class, Module] = (source)

overrides pydocspec._model.Class.parent

The parent of the API object.

constructor_method: Optional[Function] = (source)

The constructor method of this class.

inherited_members: List[ClassInheritedMember] = (source)

Members inherited from superclasses.

is_abstractclass: bool = (source)

Whether this class is abstract.

A class is abstract if it has abstract methods or if it's declared with metaclass=ABCMeta.

is_exception: bool = (source)

Whether this class extends one of the standard library exceptions.

mro: List[Class] = (source)

The method resoltion order of this class.

resolved_bases: List[Union[Class, str]] = (source)

For each bases, try to resolve the name to an ApiObject or fallback to the expanded name.

See Also
`resolve_name` and `expand_name`

subclasses: List[Class] = (source)

The direct subclasses of this class.

def _init_attribs(self): (source)

overrides pydocspec._docspec._HasInitAttribsMethod._init_attribs

A method to define extra attributes that will be set after initialization.

Note
Most attributes don't need a special value at initialization (if they use None as default for instance), in those cases, avoid overriding this method by declaring them as class variable. Override this method only if you have to initialize an attribute value to a mutable object.