-
Notifications
You must be signed in to change notification settings - Fork 63
Expand file tree
/
Copy pathgenerate_api.py
More file actions
454 lines (366 loc) · 13.2 KB
/
generate_api.py
File metadata and controls
454 lines (366 loc) · 13.2 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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
from collections import defaultdict
import inspect
from io import StringIO
import os
from pathlib import Path
from typing import *
import fastplotlib
from fastplotlib.layouts import Subplot
from fastplotlib import graphics
from fastplotlib.graphics import features, selectors
from fastplotlib import widgets
from fastplotlib import utils
from fastplotlib import ui
current_dir = Path(__file__).parent.resolve()
API_DIR = current_dir.joinpath("api")
LAYOUTS_DIR = API_DIR.joinpath("layouts")
GRAPHICS_DIR = API_DIR.joinpath("graphics")
GRAPHIC_FEATURES_DIR = API_DIR.joinpath("graphic_features")
SELECTORS_DIR = API_DIR.joinpath("selectors")
WIDGETS_DIR = API_DIR.joinpath("widgets")
UI_DIR = API_DIR.joinpath("ui")
GUIDE_DIR = current_dir.joinpath("user_guide")
doc_sources = [
API_DIR,
LAYOUTS_DIR,
GRAPHICS_DIR,
GRAPHIC_FEATURES_DIR,
SELECTORS_DIR,
WIDGETS_DIR,
UI_DIR,
]
for source_dir in doc_sources:
os.makedirs(source_dir, exist_ok=True)
# this way we can just add the entire api dir to gitignore and generate before pushing
with open(API_DIR.joinpath("fastplotlib.rst"), "w") as f:
f.write(
"fastplotlib\n"
"***********\n\n"
".. currentmodule:: fastplotlib\n\n"
".. autofunction:: fastplotlib.pause_events\n\n"
".. autofunction:: fastplotlib.enumerate_adapters\n\n"
".. autofunction:: fastplotlib.select_adapter\n\n"
".. autofunction:: fastplotlib.print_wgpu_report\n\n"
"fastplotlib.loop\n"
"------------------\n"
"See the rendercanvas docs: https://rendercanvas.readthedocs.io/stable/api.html#rendercanvas.BaseLoop "
)
def get_public_members(cls) -> Tuple[List[str], List[str]]:
"""
Returns (public_methods, public_properties)
Parameters
----------
cls
Returns
-------
"""
methods = list()
properties = list()
for member in inspect.getmembers(cls):
# only document public methods
if member[0].startswith("_"):
continue
if callable(member[1]):
methods.append(member[0])
elif isinstance(member[1], property):
properties.append(member[0])
return methods, properties
def generate_class(
cls: type,
module: str,
):
name = cls.__name__
methods, properties = get_public_members(cls)
methods = [f"{name}.{m}" for m in methods]
properties = [f"{name}.{p}" for p in properties]
underline = "=" * len(name)
methods_str = "\n ".join([""] + methods)
properties_str = "\n ".join([""] + properties)
out = (
f"{underline}\n"
f"{name}\n"
f"{underline}\n"
f".. currentmodule:: {module}\n"
f"\n"
f"Constructor\n"
f"~~~~~~~~~~~\n"
f".. autosummary::\n"
f" :toctree: {name}_api\n"
f"\n"
f" {name}\n"
f"\n"
f"Properties\n"
f"~~~~~~~~~~\n"
f".. autosummary::\n"
f" :toctree: {name}_api\n"
f"{properties_str}\n"
f"\n"
f"Methods\n"
f"~~~~~~~\n"
f".. autosummary::\n"
f" :toctree: {name}_api\n"
f"{methods_str}\n"
f"\n"
)
return out
def generate_functions_module(module, name: str, generate_header: bool = True):
underline = "*" * len(name)
if generate_header:
header = (
f"{name}\n"
f"{underline}\n"
f"\n"
)
else:
header = "\n"
out = (
f"{header}"
f".. currentmodule:: {name}\n"
f".. automodule:: {module.__name__}\n"
f" :members:\n"
)
return out
def generate_page(
page_name: str,
modules: List[str],
classes: List[type],
source_path: Path,
):
page_name_underline = "*" * len(page_name)
with open(source_path, "w") as f:
f.write(
f".. _api.{page_name}:\n"
f"\n"
f"{page_name}\n"
f"{page_name_underline}\n"
f"\n"
)
for cls, module in zip(classes, modules):
to_write = generate_class(cls, module)
f.write(to_write)
#######################################################
# Used for GraphicFeature class event table
# copy-pasted from https://pablofernandez.tech/2019/03/21/turning-a-list-of-dicts-into-a-restructured-text-table/
def _generate_header(field_names, column_widths):
with StringIO() as output:
for field_name in field_names:
output.write(f"+-{'-' * column_widths[field_name]}-")
output.write("+\n")
for field_name in field_names:
output.write(f"| {field_name} {' ' * (column_widths[field_name] - len(field_name))}")
output.write("|\n")
for field_name in field_names:
output.write(f"+={'=' * column_widths[field_name]}=")
output.write("+\n")
return output.getvalue()
def _generate_row(row, field_names, column_widths):
with StringIO() as output:
for field_name in field_names:
output.write(f"| {row[field_name]}{' ' * (column_widths[field_name] - len(str(row[field_name])))} ")
output.write("|\n")
for field_name in field_names:
output.write(f"+-{'-' * column_widths[field_name]}-")
output.write("+\n")
return output.getvalue()
def _get_fields(data):
field_names = []
column_widths = defaultdict(lambda: 0)
for row in data:
for field_name in row:
if field_name not in field_names:
field_names.append(field_name)
column_widths[field_name] = max(column_widths[field_name], len(field_name), len(str(row[field_name])))
return field_names, column_widths
def dict_to_rst_table(data):
"""convert a list of dicts to an RST table"""
field_names, column_widths = _get_fields(data)
with StringIO() as output:
output.write(_generate_header(field_names, column_widths))
for row in data:
output.write(_generate_row(row, field_names, column_widths))
output.write("\n")
return output.getvalue()
#######################################################
def main():
generate_page(
page_name="Figure",
classes=[fastplotlib.layouts._figure.Figure],
modules=["fastplotlib.layouts"],
source_path=LAYOUTS_DIR.joinpath("figure.rst"),
)
generate_page(
page_name="ImguiFigure",
classes=[fastplotlib.layouts.ImguiFigure],
modules=["fastplotlib.layouts"],
source_path=LAYOUTS_DIR.joinpath("imgui_figure.rst"),
)
generate_page(
page_name="Subplot",
classes=[Subplot],
modules=["fastplotlib.layouts._subplot"],
source_path=LAYOUTS_DIR.joinpath("subplot.rst"),
)
# layouts classes index file
with open(LAYOUTS_DIR.joinpath("index.rst"), "w") as f:
f.write(
f"Layouts\n"
f"********\n"
f"\n"
f".. toctree::\n"
f" :maxdepth: 1\n"
f"\n"
f" imgui_figure\n"
f" figure\n"
f" subplot\n"
)
# the rest of this is a mess and can be refactored later
graphic_classes = [getattr(graphics, g) for g in graphics.__all__]
graphic_class_names = [g.__name__ for g in graphic_classes]
graphic_class_names_str = "\n ".join([""] + graphic_class_names)
# graphic classes index file
with open(GRAPHICS_DIR.joinpath("index.rst"), "w") as f:
f.write(
f"Graphics\n"
f"********\n"
f"\n"
f".. toctree::\n"
f" :maxdepth: 1\n"
f"{graphic_class_names_str}\n"
)
for graphic_cls in graphic_classes:
generate_page(
page_name=graphic_cls.__name__,
classes=[graphic_cls],
modules=["fastplotlib"],
source_path=GRAPHICS_DIR.joinpath(f"{graphic_cls.__name__}.rst"),
)
##############################################################################
feature_classes = [getattr(features, f) for f in features.__all__]
feature_class_names = [f.__name__ for f in feature_classes]
feature_class_names_str = "\n ".join([""] + feature_class_names)
with open(GRAPHIC_FEATURES_DIR.joinpath("index.rst"), "w") as f:
f.write(
f"Graphic Features\n"
f"****************\n"
f"\n"
f".. toctree::\n"
f" :maxdepth: 1\n"
f"{feature_class_names_str}\n"
)
for feature_cls in feature_classes:
generate_page(
page_name=feature_cls.__name__,
classes=[feature_cls],
modules=["fastplotlib.graphics.features"],
source_path=GRAPHIC_FEATURES_DIR.joinpath(f"{feature_cls.__name__}.rst"),
)
##############################################################################
selector_classes = [getattr(selectors, s) for s in selectors.__all__]
selector_class_names = [s.__name__ for s in selector_classes]
selector_class_names_str = "\n ".join([""] + selector_class_names)
with open(SELECTORS_DIR.joinpath("index.rst"), "w") as f:
f.write(
f"Selectors\n"
f"*********\n"
f"\n"
f".. toctree::\n"
f" :maxdepth: 1\n"
f"{selector_class_names_str}\n"
)
for selector_cls in selector_classes:
generate_page(
page_name=selector_cls.__name__,
classes=[selector_cls],
modules=["fastplotlib"],
source_path=SELECTORS_DIR.joinpath(f"{selector_cls.__name__}.rst"),
)
##############################################################################
widget_classes = [getattr(widgets, w) for w in widgets.__all__]
widget_class_names = [w.__name__ for w in widget_classes]
widget_class_names_str = "\n ".join([""] + widget_class_names)
with open(WIDGETS_DIR.joinpath("index.rst"), "w") as f:
f.write(
f"Widgets\n"
f"*******\n"
f"\n"
f".. toctree::\n"
f" :maxdepth: 1\n"
f"{widget_class_names_str}\n"
)
for widget_cls in widget_classes:
generate_page(
page_name=widget_cls.__name__,
classes=[widget_cls],
modules=["fastplotlib"],
source_path=WIDGETS_DIR.joinpath(f"{widget_cls.__name__}.rst"),
)
##############################################################################
ui_classes = [ui.BaseGUI, ui.Window, ui.EdgeWindow, ui.Popup]
ui_class_names = [cls.__name__ for cls in ui_classes]
ui_class_names_str = "\n ".join([""] + ui_class_names)
with open(UI_DIR.joinpath("index.rst"), "w") as f:
f.write(
f"UI Bases\n"
f"********\n"
f"\n"
f".. toctree::\n"
f" :maxdepth: 1\n"
f"{ui_class_names_str}\n"
)
for ui_cls in ui_classes:
generate_page(
page_name=ui_cls.__name__,
classes=[ui_cls],
modules=["fastplotlib.ui"],
source_path=UI_DIR.joinpath(f"{ui_cls.__name__}.rst"),
)
##############################################################################
utils_str = generate_functions_module(utils.functions, "fastplotlib.utils")
utils_str += generate_functions_module(utils._plot_helpers, "fastplotlib.utils", generate_header=False)
with open(API_DIR.joinpath("utils.rst"), "w") as f:
f.write(utils_str)
# make API index file
with open(API_DIR.joinpath("index.rst"), "w") as f:
f.write(
"API Reference\n"
"*************\n\n"
".. toctree::\n"
" :caption: API Reference\n"
" :maxdepth: 2\n\n"
" layouts/index\n"
" graphics/index\n"
" graphic_features/index\n"
" selectors/index\n"
" ui/index\n"
" widgets/index\n"
" fastplotlib\n"
" utils\n"
)
##############################################################################
# graphic feature event tables
def write_table(name, feature_cls):
s = f"{name}\n"
s += "^" * len(name) + "\n\n"
if hasattr(feature_cls, "event_extra_attrs"):
s += "**extra attributes**\n\n"
s += dict_to_rst_table(feature_cls.event_extra_attrs)
s += "**event info dict**\n\n"
s += dict_to_rst_table(feature_cls.event_info_spec)
return s
with open(GUIDE_DIR.joinpath("event_tables.rst"), "w") as f:
f.write(".. _event_tables:\n\n")
f.write("Event Tables\n")
f.write("============\n\n")
for graphic_cls in [*graphic_classes, *selector_classes]:
f.write(f"{graphic_cls.__name__}\n")
f.write("-" * len(graphic_cls.__name__) + "\n\n")
for name, type_ in graphic_cls._features.items():
if isinstance(type_, tuple):
for t in type_:
if t is None:
continue
f.write(write_table(name, t))
else:
f.write(write_table(name, type_))
if __name__ == "__main__":
main()