pydocspec.Variable

class documentation

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

Represents a variable assignment.

Method	`__init__`	Undocumented
Class Variable	`parent`	The parent of the API object.
Instance Variable	`is_alias`	Whether this Variable is an alias. Aliases are folowed by default when using `ApiObject.expand_name`.
Instance Variable	`is_class_variable`	Whether this Variable is a class variable.
Instance Variable	`is_constant`	Whether this Variable is a constant.
Instance Variable	`is_instance_variable`	Whether this Variable is an instance variable.
Instance Variable	`is_module_variable`	Whether this Variable is a module variable.
Instance Variable	`is_type_alias`	Whether this Variable is a type alias.
Method	`_init_attribs`	A method to define extra attributes that will be set after initialization.
Property	`_alias_indirection`	Undocumented

Inherited from Variable:

Instance Variable	`datatype_ast`	Undocumented
Instance Variable	`is_type_guarged`	Undocumented
Instance Variable	`value_ast`	Undocumented
Class Variable	`_spec_fields`	Undocumented

Inherited from Variable (via Variable):

Instance Variable	`datatype`	The datatype associated with the assignment as code.
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 express semantics of this #Variable object which are not otherwise derivable from the context.
Instance Variable	`value`	The value of the variable as code.

Inherited from ApiObject (via Variable, Variable, Inheritable):

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 ApiObject (via Variable):

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 Variable, 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 Variable, ApiObject):

Method warn Undocumented

Inherited from GetMembersMixin (via Variable, 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.Variable.__init__

Undocumented

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

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

overrides pydocspec._docspec.ApiObject.parent

The parent of the API object.

is_alias: bool = (source)

Whether this Variable is an alias. Aliases are folowed by default when using ApiObject.expand_name.

is_class_variable: bool = (source)

Whether this Variable is a class variable.

is_constant: bool = (source)

Whether this Variable is a constant.

is_instance_variable: bool = (source)

Whether this Variable is an instance variable.

is_module_variable: bool = (source)

Whether this Variable is a module variable.

is_type_alias: bool = (source)

Whether this Variable is a type alias.

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.

@cached_property
_alias_indirection: Indirection = (source)

Undocumented