pydoctor.astbuilder.ModuleVistor

class documentation

class ModuleVistor(NodeVisitor): (source)

Constructor: ModuleVistor(builder, module)

Undocumented

Method	`__init__`	Undocumented
Method	`depart_AsyncFunctionDef`	Undocumented
Method	`depart_ClassDef`	Undocumented
Method	`depart_FunctionDef`	Undocumented
Method	`depart_If`	Undocumented
Method	`depart_Module`	Undocumented
Method	`depart_Try`	Undocumented
Method	`override_guard`	Returns a context manager that will make the builder ignore any new assigments to existing names within the same context. Currently used to visit `If.orelse` and `Try.handlers`.
Method	`visit_AnnAssign`	Undocumented
Method	`visit_Assign`	Undocumented
Method	`visit_AsyncFunctionDef`	Undocumented
Method	`visit_AugAssign`	Undocumented
Method	`visit_ClassDef`	Undocumented
Method	`visit_Expr`	Undocumented
Method	`visit_FunctionDef`	Undocumented
Method	`visit_If`	Undocumented
Method	`visit_Import`	Process an import statement.
Method	`visit_ImportFrom`	Undocumented
Method	`visit_Module`	Undocumented
Instance Variable	`builder`	Undocumented
Instance Variable	`module`	Undocumented
Instance Variable	`system`	Undocumented
Class Method	`_handleConstant`	Undocumented
Static Method	`_setAttributeAnnotation`	Undocumented
Static Method	`_storeAttrValue`	Undocumented
Static Method	`_tweak_constant_annotation`	Undocumented
Method	`_annotations_from_function`	Get annotations from a function definition.
Method	`_contextualizeTarget`	Find out the documentatble wich is the parent of the assignment's target as well as it's name.
Method	`_getClassFromMethodContext`	Undocumented
Method	`_getCurrentModuleExports`	Undocumented
Method	`_handleAssignment`	No summary
Method	`_handleAssignmentDoc`	Process doc-comments and inline docstrings of the given assignment.
Method	`_handleAssignmentInClass`	Undocumented
Method	`_handleAssignmentInModule`	Undocumented
Method	`_handleClassVar`	Undocumented
Method	`_handleDocComment`	Process the doc-comments, this is very similar to the inline docstrings.
Method	`_handleDocstringUpdate`	Undocumented
Method	`_handleFunctionDef`	Undocumented
Method	`_handleInlineDocstrings`	Process the inline docstrings
Method	`_handleInstanceVar`	Undocumented
Method	`_handleModuleVar`	Undocumented
Method	`_handleOldSchoolMethodDecoration`	Undocumented
Method	`_handlePropertyDef`	Undocumented
Method	`_handleReExport`	Move re-exported objects into current module.
Method	`_ignore_name`	Should this `name` be ignored because it matches the override guard in the context of `ob`?
Method	`_importAll`	Handle a `from <modname> import *` statement.
Method	`_importNames`	Handle a `from <modname> import <names>` statement.
Method	`_infer_attr_annotations`	Undocumented
Method	`_tweak_constants_annotations`	Undocumented
Instance Variable	`_override_guard_state`	Undocumented

Inherited from NodeVisitor:

Class Method	`get_children`	Returns the nested nodes in the body of a node.
Method	`generic_visit`	Helper method to visit a node by calling `visit()` on each child of the node. This is useful because this vistitor only visits statements inside `.body` attribute.

Inherited from PartialVisitor (via NodeVisitor):

Method	`unknown_departure`	Called before exiting unknown object types.
Method	`unknown_visit`	Called when entering unknown object types.

Inherited from Visitor (via NodeVisitor, PartialVisitor):

Exception	`IgnoreNode`	Comletely stop visiting the current node, extensions will not be run on that node.
Exception	`SkipChildren`	Do not visit any children of the current node. The current node's siblings and `depart_...` method are not affected.
Exception	`SkipNode`	Do not visit the current node's children, and do not call the current node's `depart_...` method. The extensions will still be called.
Method	`depart`	Extend the base depart with extensions.
Method	`visit`	Extend the base visit with extensions.
Method	`walkabout`	Perform a tree traversal, calling `visit()` method when entering a node and the `depart()` method before exiting each node.
Instance Variable	`extensions`	Undocumented
Exception	`_TreePruningException`	Base class for `Visitor`-related tree pruning exceptions.
Instance Variable	`_skipped_nodes`	Undocumented

def __init__(self, builder: ASTBuilder, module: model.Module): (source) ¶

overrides pydoctor.visitor.Visitor.__init__

Undocumented

def depart_AsyncFunctionDef(self, node: ast.AsyncFunctionDef): (source) ¶

Undocumented

def depart_ClassDef(self, node: ast.ClassDef): (source) ¶

Undocumented

def depart_FunctionDef(self, node: ast.FunctionDef): (source) ¶

Undocumented

def depart_If(self, node: ast.If): (source) ¶

Undocumented

def depart_Module(self, node: ast.Module): (source) ¶

Undocumented

def depart_Try(self, node: ast.Try): (source) ¶

Undocumented

@contextlib.contextmanager

def override_guard(self) -> Iterator[None]: (source) ¶

Returns a context manager that will make the builder ignore any new assigments to existing names within the same context. Currently used to visit If.orelse and Try.handlers.

Note
The list of existing names is generated at the moment of calling the function, such that new names defined inside these blocks follows the usual override rules.

def visit_AnnAssign(self, node: ast.AnnAssign): (source) ¶

Undocumented

def visit_Assign(self, node: ast.Assign): (source) ¶

Undocumented

def visit_AsyncFunctionDef(self, node: ast.AsyncFunctionDef): (source) ¶

Undocumented

def visit_AugAssign(self, node: ast.AugAssign): (source) ¶

Undocumented

def visit_ClassDef(self, node: ast.ClassDef): (source) ¶

Undocumented

def visit_Expr(self, node: ast.Expr): (source) ¶

Undocumented

def visit_FunctionDef(self, node: ast.FunctionDef): (source) ¶

Undocumented

def visit_If(self, node: ast.If): (source) ¶

Undocumented

def visit_Import(self, node: ast.Import): (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.

def visit_ImportFrom(self, node: ast.ImportFrom): (source) ¶

Undocumented

def visit_Module(self, node: ast.Module): (source) ¶

Undocumented

builder = (source) ¶

Undocumented

module = (source) ¶

Undocumented

system = (source) ¶

Undocumented

@classmethod

def _handleConstant(cls, obj: model.Attribute, annotation: ast.expr | None, value: ast.expr | None, lineno: int, defaultKind: model.DocumentableKind): (source) ¶

Undocumented

@staticmethod

def _setAttributeAnnotation(obj: model.Attribute, annotation: ast.expr | None): (source) ¶

Undocumented

@staticmethod

def _storeAttrValue(obj: model.Attribute, new_value: ast.expr | None, augassign: ast.operator | None = None): (source) ¶

Undocumented

@staticmethod

def _tweak_constant_annotation(obj: model.Attribute): (source) ¶

Undocumented

def _annotations_from_function(self, func: ast.AsyncFunctionDef | ast.FunctionDef) -> Mapping[str, ast.expr | None]: (source) ¶

Get annotations from a function definition.

Parameters
func:`ast.AsyncFunctionDef \| ast.FunctionDef`	The function definition's AST.

Returns
`Mapping[str, ast.expr \| None]`	Mapping from argument name to annotation. The name `return` is used for the return type. Unannotated arguments are still included with a None value.

def _contextualizeTarget(self, target: ast.expr) -> tuple[model.Documentable, str]: (source) ¶

Find out the documentatble wich is the parent of the assignment's target as well as it's name.

Returns
`tuple[model.Documentable, str]`	Tuple `parent, name`.

Raises
`ValueError`	if the target does not bind a new variable.

def _getClassFromMethodContext(self) -> model.Class | None: (source) ¶

Undocumented

def _getCurrentModuleExports(self) -> Collection[str]: (source) ¶

Undocumented

def _handleAssignment(self, targetNode: ast.expr, annotation: ast.expr | None, expr: ast.expr | None, lineno: int, augassign: ast.operator | None = None): (source) ¶

Raises
`IgnoreAssignment`	If the assignemnt should not be further processed.

def _handleAssignmentDoc(self, node: ast.Assign | ast.AnnAssign, target: ast.expr): (source) ¶

Process doc-comments and inline docstrings of the given assignment.

def _handleAssignmentInClass(self, target: str, annotation: ast.expr | None, expr: ast.expr | None, lineno: int, augassign: ast.operator | None): (source) ¶

Undocumented

def _handleAssignmentInModule(self, target: str, annotation: ast.expr | None, expr: ast.expr | None, lineno: int, augassign: ast.operator | None): (source) ¶

Undocumented

def _handleClassVar(self, name: str, annotation: ast.expr | None, expr: ast.expr | None, lineno: int, augassign: ast.operator | None): (source) ¶

Undocumented

def _handleDocComment(self, node: ast.Assign | ast.AnnAssign, target: ast.expr): (source) ¶

Process the doc-comments, this is very similar to the inline docstrings.

def _handleDocstringUpdate(self, targetNode: ast.expr, expr: ast.expr | None, lineno: int): (source) ¶

Undocumented

def _handleFunctionDef(self, node: ast.AsyncFunctionDef | ast.FunctionDef, is_async: bool): (source) ¶

Undocumented

def _handleInlineDocstrings(self, assign: ast.Assign | ast.AnnAssign, target: ast.expr): (source) ¶

Process the inline docstrings

def _handleInstanceVar(self, name: str, annotation: ast.expr | None, expr: ast.expr | None, lineno: int): (source) ¶

Undocumented

def _handleModuleVar(self, target: str, annotation: ast.expr | None, expr: ast.expr | None, lineno: int, augassign: ast.operator | None): (source) ¶

Undocumented

def _handleOldSchoolMethodDecoration(self, target: str, expr: ast.expr | None) -> bool: (source) ¶

Undocumented

def _handlePropertyDef(self, node: ast.AsyncFunctionDef | ast.FunctionDef, doc_node: Str | None, lineno: int) -> model.Attribute: (source) ¶

Undocumented

def _handleReExport(self, curr_mod_exports: Collection[str], origin_name: str, as_name: str, origin_module: model.Module) -> bool: (source) ¶

Move re-exported objects into current module.

Returns
`bool`	True if the imported name has been sucessfully re-exported.

def _ignore_name(self, ob: model.Documentable, name: str) -> bool: (source) ¶

Should this name be ignored because it matches the override guard in the context of ob?

def _importAll(self, modname: str): (source) ¶

Handle a from <modname> import * statement.

def _importNames(self, modname: str, names: Iterable[ast.alias]): (source) ¶

Handle a from <modname> import <names> statement.

def _infer_attr_annotations(self, scope: model.Documentable): (source) ¶

Undocumented

def _tweak_constants_annotations(self, scope: model.Documentable): (source) ¶

Undocumented

_override_guard_state: tuple[model.Documentable | None, set[str]] = (source) ¶

Undocumented