pydocspec._model.Argument

class documentation

class Argument(_docspec.Argument, CanTriggerWarnings): (source)

View In Hierarchy

Represents a Function argument.

Method __init__ Undocumented
Instance Variable datatype_ast Undocumented
Instance Variable default_value_ast Undocumented

Inherited from Argument:

Instance Variable datatype The datatype/type annotation of this argument as a code string.
Instance Variable decorations A list of argument decorations. Python does not actually support decorators on function arguments like for example Java does. This is probably premature to add into the API, but hey, here it is.
Instance Variable default_value The default value of the argument as a code string.
Instance Variable location The location of the argument in the source code.
Instance Variable name The name of the argument.
Instance Variable type The argument type.

Inherited from _HasInitAttribsMethod (via Argument):

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

Inherited from CanTriggerWarnings:

Method warn Undocumented
def __init__(self, *args, datatype_ast, default_value_ast, **kwargs): (source)
overrides pydocspec._docspec.Argument.__init__

Undocumented

Parameters
*args:AnyUndocumented
datatype_ast:Optional[astroid.nodes.NodeNG]Undocumented
default_value_ast:Optional[astroid.nodes.NodeNG]Undocumented
**kwargs:AnyUndocumented
datatype_ast: Optional[astroid.nodes.NodeNG] = (source)

Undocumented

default_value_ast: Optional[astroid.nodes.NodeNG] = (source)

Undocumented