pydocspec._model.Decoration

class documentation

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

View In Hierarchy

Represents a decorator on a Class or Function.

Method __init__ Undocumented
Instance Variable expr_ast The full decoration AST's
Instance Variable name_ast The name of the deocration as AST, this can be any kind of expression.

Inherited from Decoration:

Instance Variable arglist Decorator arguments, one item per argument. For keyword arguments, the keyword name and equals sign preceed the argument value expression code.
Instance Variable location The location of the decoration in the source code.
Instance Variable name The name of the decorator (i.e. the text between the @ and (). In languages that support it, this may be a piece of code.

Inherited from _HasInitAttribsMethod (via Decoration):

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, name_ast, expr_ast, **kwargs): (source)
overrides pydocspec._docspec.Decoration.__init__

Undocumented

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

The full decoration AST's

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

The name of the deocration as AST, this can be any kind of expression.