pydocspec.astbuilder.BuilderVisitor

class documentation

class BuilderVisitor(basebuilder.Collector, visitors.AstVisitor): (source)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method depart_classdef Undocumented
Method depart_FunctionDef Undocumented
Method depart_module Undocumented
Method visit_annassign Undocumented
Method visit_assign Undocumented
Method visit_AsyncFunctionDef Undocumented
Method visit_classdef Visit a class.
Method visit_Expr Handles the inline attribute docstrings.
Method visit_FunctionDef Undocumented
Method visit_import Process an import statement.
Method visit_importfrom Undocumented
Method visit_module Visit an {astroid.nodes.Module}.
Class Variable module Undocumented
Instance Variable builder Undocumented
Method _handleAssignment Undocumented
Method _handleAssignmentInClass Undocumented
Method _handleAssignmentInModule Undocumented
Method _handleClassVar Undocumented
Method _handleFunctionDef Undocumented
Method _handleInstanceVar Undocumented
Method _handleModuleVar Undocumented
Method _maybe_set_docstring Undocumented
Method _newData Create a new Variable object.
Method _newIndirections Handle a C{from <modname> import <names>} statement.
Method _newIndirectionsFromWildcardImport Handle a from <modname> import * statement.
Method _parse_decorations Undocumented
Method _set_docstring Set the docstring of a object from a L{astroid.nodes.Const} node.

Inherited from Collector:

Method add_object See TreeRoot.add_object.
Instance Variable root The root of the tree.
def __init__(self, builder, module): (source)
overrides pydocspec.basebuilder.Collector.__init__

Undocumented

Parameters
builder:BuilderUndocumented
module:_model.ModuleUndocumented
def depart_classdef(self, node): (source)

Undocumented

Parameters
node:astroid.nodes.ClassDefUndocumented
def depart_FunctionDef(self, node): (source)

Undocumented

Parameters
node:astroid.nodes.FunctionDefUndocumented
def depart_module(self, node): (source)

Undocumented

Parameters
node:astroid.nodes.ModuleUndocumented
def visit_annassign(self, node): (source)

Undocumented

Parameters
node:astroid.nodes.AnnAssignUndocumented
def visit_assign(self, node): (source)

Undocumented

Parameters
node:astroid.nodes.AssignUndocumented
def visit_AsyncFunctionDef(self, node): (source)

Undocumented

Parameters
node:astroid.nodes.AsyncFunctionDefUndocumented
def visit_classdef(self, node): (source)

Visit a class.

Parameters
node:astroid.nodes.ClassDefUndocumented
def visit_Expr(self, node): (source)

Handles the inline attribute docstrings.

Parameters
node:astroid.nodes.ExprUndocumented
def visit_FunctionDef(self, node): (source)

Undocumented

Parameters
node:astroid.nodes.FunctionDefUndocumented
def visit_import(self, node): (source)

Process an import statement.

The grammar for the statement is roughly:

mod_as := DOTTEDNAME ['as' NAME] import_stmt := 'import' mod_as (',' mod_as)*

and this is translated into a node which is an instance of Import wih an attribute 'names', which is in turn a list of 2-tuples (dotted_name, as_name) where as_name is None if there was no 'as foo' part of the statement.

Parameters
node:astroid.nodes.ImportUndocumented
def visit_importfrom(self, node): (source)

Undocumented

Parameters
node:astroid.nodes.ImportFromUndocumented
def visit_module(self, node): (source)

Visit an {astroid.nodes.Module}.

Parameters
node:astroid.nodes.ModuleUndocumented
module: pydocspec.Module = (source)
overrides pydocspec.basebuilder.Collector.module

Undocumented

builder = (source)

Undocumented

def _handleAssignment(self, target_node, annotation, expr, lineno): (source)

Undocumented

Parameters
target_node:astroid.nodes.NodeNGUndocumented
annotation:Optional[astroid.nodes.NodeNG]Undocumented
expr:Optional[astroid.nodes.NodeNG]Undocumented
lineno:intUndocumented
def _handleAssignmentInClass(self, target, annotation, expr, lineno): (source)

Undocumented

Parameters
target:strUndocumented
annotation:Optional[astroid.nodes.NodeNG]Undocumented
expr:Optional[astroid.nodes.NodeNG]Undocumented
lineno:intUndocumented
def _handleAssignmentInModule(self, target, annotation, expr, lineno): (source)

Undocumented

Parameters
target:strUndocumented
annotation:Optional[astroid.nodes.NodeNG]Undocumented
expr:Optional[astroid.nodes.NodeNG]Undocumented
lineno:intUndocumented
def _handleClassVar(self, name, annotation, expr, lineno): (source)

Undocumented

Parameters
name:strUndocumented
annotation:Optional[astroid.nodes.NodeNG]Undocumented
expr:Optional[astroid.nodes.NodeNG]Undocumented
lineno:intUndocumented
def _handleFunctionDef(self, node, is_async): (source)

Undocumented

Parameters
node:Union[astroid.nodes.AsyncFunctionDef, astroid.nodes.FunctionDef]Undocumented
is_async:boolUndocumented
def _handleInstanceVar(self, name, annotation, expr, lineno): (source)

Undocumented

Parameters
name:strUndocumented
annotation:Optional[astroid.nodes.NodeNG]Undocumented
expr:Optional[astroid.nodes.NodeNG]Undocumented
lineno:intUndocumented
def _handleModuleVar(self, name, annotation, expr, lineno): (source)

Undocumented

Parameters
name:strUndocumented
annotation:Optional[astroid.nodes.NodeNG]Undocumented
expr:Optional[astroid.nodes.NodeNG]Undocumented
lineno:intUndocumented
def _maybe_set_docstring(self, obj, node): (source)

Undocumented

Parameters
obj:_model.ApiObjectUndocumented
node:Union[astroid.nodes.Module, astroid.nodes.ClassDef, astroid.nodes.FunctionDef, astroid.nodes.AsyncFunctionDef]Undocumented
def _newData(self, name, annotation, expr, lineno, semantics): (source)

Create a new Variable object.

Parameters
name:strUndocumented
annotation:Optional[astroid.nodes.NodeNG]Undocumented
expr:Optional[astroid.nodes.NodeNG]Undocumented
lineno:intUndocumented
semantics:List[pydocspec.Variable.Semantic]Undocumented
Returns
pydocspec.VariableUndocumented
def _newIndirections(self, modname, names, lineno, is_type_guarged): (source)

Handle a C{from <modname> import <names>} statement.

Parameters
modname:strUndocumented
names:Iterable[Tuple[str, Optional[str]]]Undocumented
lineno:intUndocumented
is_type_guarged:boolUndocumented
Returns
Iterator[_model.Indirection]Undocumented
def _newIndirectionsFromWildcardImport(self, modname, lineno, is_type_guarged): (source)

Handle a from <modname> import * statement.

This method may be called in a latter stage of the processing to resolve unresolve imports in the first analysis pass.

Parameters
modname:strUndocumented
lineno:intUndocumented
is_type_guarged:boolUndocumented
Returns
Iterator[_model.Indirection]Undocumented
def _parse_decorations(self, decorators_nodes): (source)

Undocumented

Parameters
decorators_nodes:Iterable[astroid.nodes.NodeNG]Undocumented
Returns
Iterator[_model.Decoration]Undocumented
def _set_docstring(self, ob, node): (source)

Set the docstring of a object from a L{astroid.nodes.Const} node.

Parameters
ob:_model.ApiObjectUndocumented
node:astroid.nodes.ConstUndocumented