pydocspec._docspec.Variable

class documentation

class Variable(Inheritable): (source)

Represents a variable assignment (e.g. for global variables (often used as constants) or class members).

Method	`__init__`	Undocumented
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 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).
Instance Variable	`parent`	The parent of the API object.
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.

def __init__(self, *args, datatype, value, modifiers=None, semantic_hints=None, **kwargs): (source)

overrides pydocspec._docspec.ApiObject.__init__

overridden in pydocspec._model.Variable

Undocumented

Parameters
*args:`t.Any`	Undocumented
datatype:`t.Optional[str]`	Undocumented
value:`t.Optional[str]`	Undocumented
modifiers:`t.Optional[t.List[str]]`	Undocumented
semantic_hints:`t.Optional[t.List[VariableSemantic]]`	Undocumented
**kwargs:`t.Any`	Undocumented

datatype: t.Optional[str] = (source)

The datatype associated with the assignment as code.

modifiers: t.List[str] = (source)

A list of language-specific modifiers that were used to declare this #Variable object.

semantic_hints: t.List[VariableSemantic] = (source)

A list of hints that express semantics of this #Variable object which are not otherwise derivable from the context.

value: t.Optional[str] = (source)

The value of the variable as code.