Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 69
Expand file tree
/
Copy pathgriffe_builder.py
More file actions
292 lines (246 loc) · 9.77 KB
/
Copy pathgriffe_builder.py
File metadata and controls
292 lines (246 loc) · 9.77 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
# (C) 2026 GoodData Corporation
"""Build data.json from Python source using griffe (static AST analysis).
Drop-in replacement for json_builder.py — produces an identical JSON schema
but does NOT require importing the target packages at runtime.
Usage:
python griffe_builder.py [--search-path PATH ...] [--output FILE] PACKAGE [PACKAGE ...]
Example:
python griffe_builder.py \
--search-path packages/gooddata-sdk/src \
--search-path packages/gooddata-pandas/src \
--output data.json \
gooddata_sdk gooddata_pandas
"""
from __future__ import annotations
import argparse
import json
import os
from typing import Any
import griffe
from griffe import (
Attribute,
Class,
Docstring,
DocstringParameter,
DocstringReturn,
DocstringSectionKind,
Function,
Module,
)
# ---------------------------------------------------------------------------
# Docstring helpers
# ---------------------------------------------------------------------------
def _parse_docstring_params(docstring: Docstring | None) -> list[dict[str, Any]]:
"""Extract parameter info from a parsed Google-style docstring."""
if docstring is None:
return []
params: list[dict[str, Any]] = []
for section in docstring.parsed:
if section.kind is DocstringSectionKind.parameters:
for p in section.value:
assert isinstance(p, DocstringParameter)
params.append(
{
"arg_name": p.name,
"default": str(p.default) if p.default else None,
"is_optional": None,
"type_name": str(p.annotation) if p.annotation else None,
"description": p.description or None,
}
)
return params
def _parse_docstring_returns(docstring: Docstring | None) -> dict[str, Any] | None:
"""Extract return info from a parsed Google-style docstring."""
if docstring is None:
return None
for section in docstring.parsed:
if section.kind is DocstringSectionKind.returns:
for r in section.value:
assert isinstance(r, DocstringReturn)
return {
"type_name": str(r.annotation) if r.annotation else None,
"description": r.description or None,
"return_name": r.name or None,
}
return None
def _short_description(docstring: Docstring | None) -> str | None:
if docstring is None:
return None
for section in docstring.parsed:
if section.kind is DocstringSectionKind.text:
text = section.value
# First paragraph = short description
idx = text.find("\n\n")
return text[:idx].strip() if idx != -1 else text.strip()
return None
def _long_description(docstring: Docstring | None) -> str | None:
if docstring is None:
return None
for section in docstring.parsed:
if section.kind is DocstringSectionKind.text:
text = section.value
idx = text.find("\n\n")
if idx != -1:
return text[idx:].strip()
return None
return None
def _examples_str(docstring: Docstring | None) -> str:
if docstring is None:
return "[]"
for section in docstring.parsed:
if section.kind is DocstringSectionKind.examples:
return str(section.value)
return "[]"
def _docstring_data(docstring: Docstring | None) -> dict[str, Any] | None:
"""Build the docstring_parsed dict matching json_builder output."""
if docstring is None:
return None
return {
"params": _parse_docstring_params(docstring),
"long_description": _long_description(docstring),
"short_description": _short_description(docstring),
"examples": _examples_str(docstring),
"returns": _parse_docstring_returns(docstring),
}
# ---------------------------------------------------------------------------
# Object converters
# ---------------------------------------------------------------------------
def _annotation_str(annotation: Any) -> str:
"""Convert a griffe annotation to the string form json_builder would produce."""
if annotation is None:
return "None"
return str(annotation)
def _function_data(func: Function) -> dict[str, Any]:
"""Build function dict matching json_builder.FunctionData."""
sig_params: list[list[str]] = []
for param in func.parameters:
if param.name == "self":
continue
param_str = str(param.name)
if param.annotation is not None:
param_str += f": {param.annotation}"
if param.default is not None:
param_str += f" = {param.default}"
ann_str = _annotation_str(param.annotation)
sig_params.append([param_str, ann_str])
is_property = "property" in func.labels
docstring = func.docstring
# Parse with Google style
if docstring is not None:
docstring.parse("google")
return {
"kind": "function",
"docstring": docstring.value if docstring else None,
"signature": {
"params": sig_params,
"return_annotation": _annotation_str(func.annotation),
},
"is_property": is_property,
"docstring_parsed": _docstring_data(docstring),
}
def _class_data(cls: Class, package_name: str) -> dict[str, Any]:
"""Build class dict matching json_builder.ClassData."""
docstring = cls.docstring
if docstring is not None:
docstring.parse("google")
functions: dict[str, Any] = {}
# Use all_members to include inherited methods (matches inspect.getmembers behavior)
for name, member in cls.all_members.items():
if member.is_alias:
try:
resolved = member.resolve_target()
if isinstance(resolved, Function):
functions[name] = _function_data(resolved)
except Exception:
pass
elif isinstance(member, Function):
functions[name] = _function_data(member)
elif (
isinstance(member, Attribute)
and "property" in member.labels
and hasattr(member, "getter")
and member.getter is not None
):
functions[name] = _function_data(member.getter)
return {
"kind": "class",
"docstring": docstring.value if docstring else None,
"docstring_parsed": _docstring_data(docstring),
"functions": functions,
}
def _module_data(module: Module, package_name: str) -> dict[str, Any]:
"""Build module dict matching json_builder.module_data."""
data: dict[str, Any] = {"kind": "module"}
for name, member in module.members.items():
if isinstance(member, Class):
# Filter: only classes defined in this package
if member.is_alias:
try:
target = member.resolve_target()
if package_name not in str(target.canonical_path):
continue
except Exception:
continue
data[name] = _class_data(member, package_name)
elif isinstance(member, Module):
if member.is_alias:
try:
target = member.resolve_target()
if package_name not in str(target.canonical_path):
continue
except Exception:
continue
data[name] = _module_data(member, package_name)
return data
def _parse_package(module: Module, package_name: str) -> dict[str, Any]:
"""Walk the package tree and build the data dict."""
data: dict[str, Any] = {"kind": "module"}
for name, member in module.members.items():
if isinstance(member, Module):
if member.is_alias:
try:
target = member.resolve_target()
if package_name not in str(target.canonical_path):
continue
except Exception:
continue
if member.is_subpackage:
data[name] = _parse_package(member, package_name)
else:
data[name] = _module_data(member, package_name)
return data
# ---------------------------------------------------------------------------
# Entry point
# ---------------------------------------------------------------------------
def build_data_json(packages: list[str], search_paths: list[str]) -> dict[str, Any]:
"""Load packages via griffe and produce the combined data dict."""
output: dict[str, Any] = {}
for pkg_name in packages:
pkg = griffe.load(
pkg_name,
search_paths=search_paths,
docstring_parser="google",
)
output.update(_parse_package(pkg, pkg_name))
# Remove the top-level "kind" keys that _parse_package adds
output.pop("kind", None)
return output
def main() -> None:
parser = argparse.ArgumentParser(description="Build data.json using griffe (static AST analysis)")
parser.add_argument("packages", nargs="+", help="Package names to analyze (e.g. gooddata_sdk)")
parser.add_argument(
"--search-path",
action="append",
default=[],
dest="search_paths",
help="Directories to search for packages (repeatable)",
)
parser.add_argument("--output", default="data.json", help="Output JSON file path")
args = parser.parse_args()
search_paths = args.search_paths or ["."]
output = build_data_json(args.packages, search_paths)
with open(args.output, "w") as f:
json.dump(output, f)
print(f"Saved data.json ({len(output)} top-level keys) to {os.path.abspath(args.output)}")
if __name__ == "__main__":
main()
You can’t perform that action at this time.