pydocspec._docspec.Argument

class documentation

class Argument(_HasInitAttribsMethod): (source)

Known subclasses: pydocspec._model.Argument

Represents a #Function argument.

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

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

def __init__(self, location, name, type, decorations=None, datatype=None, default_value=None): (source)

overridden in pydocspec._model.Argument

Undocumented

Parameters
location:`Location`	Undocumented
name:`str`	Undocumented
type:`ArgumentType`	Undocumented
decorations:`t.Optional[t.List[Decoration]]`	Undocumented
datatype:`t.Optional[str]`	Undocumented
default_value:`t.Optional[str]`	Undocumented

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

The datatype/type annotation of this argument as a code string.

decorations: t.Optional[t.List[Decoration]] = (source)

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.

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

The default value of the argument as a code string.

location: Location = (source)

The location of the argument in the source code.

name: str = (source)

The name of the argument.

type: ArgumentType = (source)

The argument type.