pydocspec._model.ApiObject

class documentation

class ApiObject(_docspec.ApiObject, CanTriggerWarnings, GetMembersMixin): (source)

Known subclasses: pydocspec._model.Class, pydocspec._model.Function, pydocspec._model.Indirection, pydocspec._model.Module, pydocspec._model.Variable, pydocspec.ApiObject

View In Hierarchy

Undocumented

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.
Class Variable	`parent`	The parent of the API object.
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	`_init_attribs`	A method to define extra attributes that will be set after initialization.
Method	`_members`	Undocumented
Method	`_remove_self`	Undocumented
Method	`_repr`	Undocumented
Class Variable	`_spec_fields`	Undocumented

Inherited from ApiObject:

Method	`__init__`	Undocumented
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:

Method warn Undocumented

Inherited from GetMembersMixin:

Method __getitem__ Undocumented

def __repr__(self): (source)

overridden in pydocspec._model.Module

Undocumented

Returns
`str`	Undocumented

def __str__(self): (source)

Undocumented

Returns
`str`	Undocumented

def add_siblings(self, obs, allow_dup=True): (source)

A new nodes to the tree, siblings to this node.

Parameters
obs:`Union[Iterable[ApiObject], ApiObject]`	Undocumented
allow_dup:`bool`	Undocumented

def get_member(self, name): (source)

Retrieve a member from the API object. This will always return None for objects that don't support members (eg. Function and Variable).

Parameters
name:`str`	Undocumented
Returns
`Optional[pydocspec.ApiObject]`	Undocumented
Note
Implementation relies on `ApiObject.root.all_objects` such that it will return the last added object in case of duplicate names.

def get_members(self, name): (source)

Like get_member but can return several items with the same name.

Parameters
name:`str`	Undocumented
Returns
`Iterator[pydocspec.ApiObject]`	Undocumented

def remove(self): (source)

Undocumented

def replace(self, obs, allow_dup=True): (source)

Replace this object by one or more objects.

The node will first be removed, then new object will be added to the tree.

Parameters
obs:`Union[Iterable[ApiObject], ApiObject]`	Undocumented
allow_dup:`bool`	Undocumented

def walk(self, visitor): (source)

Traverse a tree of objects, calling the genericvisitor.Visitor.visit method of visitor when entering each node.

Parameters
visitor:`visitors.ApiObjectVisitor`	Undocumented
See Also
`genericvisitor.Visitor.walk` for more details.

def walkabout(self, visitor): (source)

Perform a tree traversal similarly to walk(), except also call the genericvisitor.Visitor.depart method before exiting each node.

Parameters
visitor:`visitors.ApiObjectVisitor`	Undocumented
See Also
`genericvisitor.Visitor.walkabout` for more details.

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

overrides pydocspec._docspec.ApiObject.parent

overridden in pydocspec._model.Class, pydocspec._model.Function, pydocspec._model.Module, pydocspec.ApiObject, pydocspec.Indirection, pydocspec.Variable

The parent of the API object.

root: TreeRoot = (source)

overridden in pydocspec.ApiObject

TreeRoot instance holding references to all objects in the tree.

@property
dotted_name: DottedName = (source)

The fully qualified dotted name of this object, as DottedName instance.

@property
full_name: str = (source)

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: pydocspec.Module = (source)

overridden in pydocspec.ApiObject

Undocumented

@property
scope: Union[pydocspec.Module, pydocspec.Class] = (source)

Undocumented

def _init_attribs(self): (source)

overrides pydocspec._docspec._HasInitAttribsMethod._init_attribs

overridden in pydocspec._model.Module, pydocspec.ApiObject, pydocspec.Class, pydocspec.Function, pydocspec.Variable

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.

def _members(self): (source)

Undocumented

Returns
`Iterable[pydocspec.ApiObject]`	Undocumented

def _remove_self(self): (source)

Undocumented

def _repr(self, full_name=False, fields=None): (source)

Undocumented

Parameters
full_name:`bool`	Undocumented
fields:`Optional[Sequence[str]]`	Undocumented
Returns
`str`	Undocumented

_spec_fields: Tuple[str, ...] = (source)

overridden in pydocspec._model.Class, pydocspec._model.Function, pydocspec._model.Indirection, pydocspec._model.Module, pydocspec._model.Variable

Undocumented