Skip to content

Inspect text

inspect_text

render_batch_text(symbols)

Join individual renders with blank-line separator, handle errors.

Source code in packages/axm-ast/src/axm_ast/tools/inspect_text.py
Python
162
163
164
165
166
167
168
169
170
171
172
173
174
def render_batch_text(symbols: list[dict[str, Any]]) -> str:
    """Join individual renders with blank-line separator, handle errors."""
    if not symbols:
        return ""

    parts: list[str] = []
    for entry in symbols:
        if "error" in entry:
            parts.append(f"{entry.get('name', '?')}  \u26a0 {entry['error']}")
        else:
            parts.append(render_symbol_text(entry))

    return "\n\n".join(parts)

render_class_text(detail)

Render a class detail dict as compact text.

Source code in packages/axm-ast/src/axm_ast/tools/inspect_text.py
Python
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
def render_class_text(detail: dict[str, Any]) -> str:
    """Render a class detail dict as compact text."""
    name = detail["name"]
    file = detail["file"]
    start = detail.get("start_line", 0)
    end = detail.get("end_line", start)
    bases = detail.get("bases", [])

    suffix = f"({', '.join(bases)})" if bases else ""
    lines = [_header(name, file, start, end, suffix)]

    doc = detail.get("docstring")
    if doc:
        lines.append(_truncate_docstring(doc))

    methods = detail.get("methods", [])
    if methods:
        lines.append(f"Methods: {', '.join(methods)}")

    _append_source(lines, detail)
    return "\n".join(lines)

render_function_text(detail)

Render a function detail dict as compact text.

Source code in packages/axm-ast/src/axm_ast/tools/inspect_text.py
Python
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
def render_function_text(detail: dict[str, Any]) -> str:
    """Render a function detail dict as compact text."""
    name = detail["name"]
    file = detail["file"]
    start = detail.get("start_line", 0)
    end = detail.get("end_line", start)

    lines = [_header(name, file, start, end)]

    sig = detail.get("signature")
    if sig:
        lines.append(sig)

    doc = detail.get("docstring")
    if doc:
        lines.append(_truncate_docstring(doc))

    params = detail.get("parameters")
    if params:
        parts = []
        for p in params:
            s = p["name"]
            ann = p.get("annotation")
            if ann:
                s += f": {ann}"
            default = p.get("default")
            if default is not None:
                s += f" ={default}"
            parts.append(s)
        lines.append(f"Params: {', '.join(parts)}")

    ret = detail.get("return_type")
    if ret:
        lines.append(f"Returns: {ret}")

    _append_source(lines, detail)
    return "\n".join(lines)

render_module_text(detail)

Render a module detail dict as compact text.

Source code in packages/axm-ast/src/axm_ast/tools/inspect_text.py
Python
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
def render_module_text(detail: dict[str, Any]) -> str:
    """Render a module detail dict as compact text."""
    name = detail["name"]
    file = detail.get("file", "")
    count = detail.get("symbol_count", 0)

    lines = [f"{name}  {file}  module \u00b7 {count} symbols"]

    doc = detail.get("docstring")
    if doc:
        lines.append(_truncate_docstring(doc))

    funcs = detail.get("functions", [])
    if funcs:
        lines.append(f"Functions: {', '.join(funcs)}")

    classes = detail.get("classes", [])
    if classes:
        lines.append(f"Classes: {', '.join(classes)}")

    return "\n".join(lines)

render_symbol_text(detail)

Dispatch to the correct renderer based on detail kind.

Source code in packages/axm-ast/src/axm_ast/tools/inspect_text.py
Python
146
147
148
149
150
151
152
153
154
155
156
157
158
159
def render_symbol_text(detail: dict[str, Any]) -> str:
    """Dispatch to the correct renderer based on detail kind."""
    kind = detail.get("kind", "")
    match kind:
        case "function" | "method":
            return render_function_text(detail)
        case "class":
            return render_class_text(detail)
        case "variable":
            return render_variable_text(detail)
        case "module":
            return render_module_text(detail)
        case _:
            return render_function_text(detail)

render_variable_text(detail)

Render a variable detail dict as compact text.

Source code in packages/axm-ast/src/axm_ast/tools/inspect_text.py
Python
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
def render_variable_text(detail: dict[str, Any]) -> str:
    """Render a variable detail dict as compact text."""
    name = detail["name"]
    file = detail["file"]
    start = detail.get("start_line", 0)
    end = detail.get("end_line", start)

    lines = [_header(name, file, start, end, "variable")]

    ann = detail.get("annotation")
    if ann:
        lines.append(f": {ann}")

    val = detail.get("value_repr")
    if val:
        lines.append(f"= {val}")

    return "\n".join(lines)