Skip to content

ModuleAnalyzer

AST analyzer for ast.Module records.

Handsdown API Index / Handsdown / AST Parser / Analyzers / ModuleAnalyzer

Auto-generated documentation for handsdown.ast_parser.analyzers.module_analyzer module.

ModuleAnalyzer

Show source in module_analyzer.py:11

AST analyzer for ast.Module records.

Signature

class ModuleAnalyzer(BaseAnalyzer):
    def __init__(self) -> None:
        ...

See also

ModuleAnalyzer().visit_AnnAssign

Show source in module_analyzer.py:180

Parse info about module attribute statements.

Adds new ast.AnnAssign entry to attribute_nodes. Skips assignments with names starting with _.

Examples

MY_MODULE_INT: int
MY_MODULE_ATTR: str = 'value'

Arguments

  • node - AST node.

Signature

def visit_AnnAssign(self, node: ast.AnnAssign) -> None:
    ...

ModuleAnalyzer().visit_Assign

Show source in module_analyzer.py:130

Parse info about module attribute statements.

Adds new ast.Assign entry to attribute_nodes. Skips assignments to anything other than a new variable. Skips multiple assignments. Skips assignments with names starting with _. Parses __all__ and add all values to all_names

Examples

MY_MODULE_ATTR = 'value'
    my_attr = "value"
__all__ = ['MyClass', 'my_func']

# these entries are skipped
_MY_MODULE_ATTR = "value"
multi_attr_1, multi_attr_2 = [1, 2]
my_object.name = "value"
__all__ = all_list

Arguments

  • node - AST node.

Signature

def visit_Assign(self, node: ast.Assign) -> None:
    ...

ModuleAnalyzer().visit_AsyncFunctionDef

Show source in module_analyzer.py:112

Parse info about module def ... statements.

Adds node entry to function_nodes. Skips nodes with names starting with _.

Examples

async def my_func(arg1):
    return await arg1

Arguments

  • node - AST node.

Signature

def visit_AsyncFunctionDef(self, node: ast.AsyncFunctionDef) -> None:
    ...

ModuleAnalyzer().visit_ClassDef

Show source in module_analyzer.py:58

Parse info about module class ... statements.

Adds node entry to class_nodes. Skips nodes with names starting with _.

Examples

class MyClass():
    pass

Arguments

  • node - AST node.

Signature

def visit_ClassDef(self, node: ast.ClassDef) -> None:
    ...

ModuleAnalyzer().visit_FunctionDef

Show source in module_analyzer.py:94

Parse info about module def ... statements.

Adds node entry to function_nodes. Skips nodes with names starting with _.

Examples

def my_func(arg1):
    return arg1

Arguments

  • node - AST node.

Signature

def visit_FunctionDef(self, node: ast.FunctionDef) -> None:
    ...

ModuleAnalyzer().visit_Import

Show source in module_analyzer.py:24

Parse info about module import ... statements.

Adds node to import_nodes.

Examples

import my_module
import my_module as my
import my_module.my_class
import my_module.my_class as my_class

Arguments

  • node - AST node.

Signature

def visit_Import(self, node: ast.Import) -> None:
    ...

ModuleAnalyzer().visit_ImportFrom

Show source in module_analyzer.py:42

Parse info about module import ... from ... statements.

Adds node to import_nodes.

Examples

from my_module import my_class
from my_module import my_class as new_class

Arguments

  • node - AST node.

Signature

def visit_ImportFrom(self, node: ast.ImportFrom) -> None:
    ...