|
| 1 | +import ast |
| 2 | +import io |
| 3 | +import re |
| 4 | +import tokenize |
| 5 | +from dataclasses import dataclass, field |
| 6 | +from typing import Set |
| 7 | + |
| 8 | +from pyall import constants as C |
| 9 | +from pyall.relate import relate |
| 10 | +from pyall.rule import Rule |
| 11 | + |
| 12 | +__all__ = ["Analyzer"] |
| 13 | + |
| 14 | + |
| 15 | +@dataclass |
| 16 | +class _AllItemAnalyzer(ast.NodeVisitor): |
| 17 | + actual_all: Set[str] = field(default_factory=set) |
| 18 | + classes: Set[str] = field(default_factory=set) |
| 19 | + functions: Set[str] = field(default_factory=set) |
| 20 | + variables: Set[str] = field(default_factory=set) |
| 21 | + |
| 22 | + @Rule.apply |
| 23 | + def visit_ClassDef(self, node: ast.ClassDef) -> None: |
| 24 | + self.classes.add(node.name) |
| 25 | + self.generic_visit(node) |
| 26 | + |
| 27 | + @Rule.apply |
| 28 | + def visit_FunctionDef(self, node: C.ASTFunctionT) -> None: |
| 29 | + self.functions.add(node.name) |
| 30 | + self.generic_visit(node) |
| 31 | + |
| 32 | + visit_AsyncFunctionDef = visit_FunctionDef |
| 33 | + |
| 34 | + @Rule.apply |
| 35 | + def visit_Name(self, node: ast.Name) -> None: |
| 36 | + self.variables.add(node.id) |
| 37 | + self.generic_visit(node) |
| 38 | + |
| 39 | + @Rule.apply |
| 40 | + def visit_Assign(self, node: ast.Assign) -> None: |
| 41 | + assert isinstance(node.value, ast.List) |
| 42 | + for item in node.value.elts: |
| 43 | + if isinstance(item, ast.Constant): |
| 44 | + self.actual_all.add(str(item.value)) |
| 45 | + elif isinstance(item, ast.Str): |
| 46 | + self.actual_all.add(item.s) |
| 47 | + self.generic_visit(node) |
| 48 | + |
| 49 | + @Rule.apply |
| 50 | + def visit_Expr(self, node: ast.Expr) -> None: |
| 51 | + assert isinstance(node.value, ast.Call) |
| 52 | + assert isinstance(node.value.func, ast.Attribute) |
| 53 | + if node.value.func.attr == "append": |
| 54 | + for arg in node.value.args: |
| 55 | + if isinstance(arg, ast.Constant): |
| 56 | + self.actual_all.add(str(arg.value)) |
| 57 | + elif isinstance(arg, ast.Str): |
| 58 | + self.actual_all.add(arg.s) |
| 59 | + elif node.value.func.attr == "extend": |
| 60 | + for arg in node.value.args: |
| 61 | + if isinstance(arg, ast.List): |
| 62 | + for item in arg.elts: |
| 63 | + if isinstance(item, ast.Constant): |
| 64 | + self.actual_all.add(str(item.value)) |
| 65 | + elif isinstance(item, ast.Str): |
| 66 | + self.actual_all.add(item.s) |
| 67 | + self.generic_visit(node) |
| 68 | + |
| 69 | + |
| 70 | +@dataclass |
| 71 | +class Analyzer: |
| 72 | + source: str |
| 73 | + all_item_analyzer: _AllItemAnalyzer = field( |
| 74 | + init=False, default_factory=_AllItemAnalyzer |
| 75 | + ) |
| 76 | + |
| 77 | + def traverse(self) -> None: |
| 78 | + tree = ast.parse(self.source) |
| 79 | + relate(tree) |
| 80 | + self.set_extra_attr(tree) |
| 81 | + self.all_item_analyzer.visit(tree) |
| 82 | + |
| 83 | + def set_extra_attr(self, tree: ast.AST) -> None: |
| 84 | + skip, add = set(), set() |
| 85 | + readline = io.StringIO(self.source).readline |
| 86 | + for _, _, start, _, line in tokenize.generate_tokens(readline): |
| 87 | + if re.search(C.SKIP_COMMENTS_REGEX_PATTERN, line, re.IGNORECASE): |
| 88 | + lineno = start[0] |
| 89 | + skip.add(lineno) |
| 90 | + if re.search(C.ADD_COMMENTS_REGEX_PATTERN, line, re.IGNORECASE): |
| 91 | + lineno = start[0] |
| 92 | + add.add(lineno) |
| 93 | + for node in ast.walk(tree): |
| 94 | + if isinstance(node, C.ALL_NODE) and node.lineno in skip: |
| 95 | + node.skip = True # type: ignore |
| 96 | + else: |
| 97 | + node.skip = False # type: ignore |
| 98 | + |
| 99 | + if isinstance(node, C.ALL_NODE) and node.lineno in add: |
| 100 | + node.add = True # type: ignore |
| 101 | + |
| 102 | + @property |
| 103 | + def actual_all(self): |
| 104 | + return sorted(self.all_item_analyzer.actual_all) |
| 105 | + |
| 106 | + @property |
| 107 | + def classes(self): |
| 108 | + return sorted(self.all_item_analyzer.classes) |
| 109 | + |
| 110 | + @property |
| 111 | + def functions(self): |
| 112 | + return sorted(self.all_item_analyzer.functions) |
| 113 | + |
| 114 | + @property |
| 115 | + def variables(self): |
| 116 | + return sorted(self.all_item_analyzer.variables) |
| 117 | + |
| 118 | + @property |
| 119 | + def expected_all(self): |
| 120 | + return sorted(self.classes + self.functions + self.variables) |
0 commit comments