pydocspec.Indirection

class documentation

Represents an imported name. It can be used to properly find the full name target of a link written with a local name.

Method	`__init__`	Undocumented
Class Variable	`parent`	The parent of the API object.

Inherited from Indirection:

Instance Variable	`is_type_guarged`	Undocumented
Class Variable	`_spec_fields`	Undocumented

Inherited from Indirection (via Indirection):

Instance Variable target 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.

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

Inherited from ApiObject (via Indirection):

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	`_init_attribs`	A method to define extra attributes that will be set after initialization.
Method	`_members`	Undocumented
Method	`_remove_self`	Undocumented
Method	`_repr`	Undocumented

Inherited from ApiObject (via Indirection, 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.

Method warn Undocumented

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	`_init_attribs`	A method to define extra attributes that will be set after initialization.
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.

Method warn Undocumented

Method __getitem__ Undocumented

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

overrides pydocspec._model.Indirection.__init__

Undocumented

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

overrides pydocspec._docspec.ApiObject.parent

The parent of the API object.