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
|
"""Render docs for our program structure."""
import os
import subprocess
from io import StringIO
from pathlib import Path
from textwrap import dedent
from unittest.mock import MagicMock
from code2flow import code2flow, engine, model
engine.logging = MagicMock()
model.TRUNK_COLOR = "#fca311"
model.LEAF_COLOR = "#98c1d9"
model.EDGE_COLORS = ["#b8b8ff"] * 8
model.NODE_COLOR = "#e5e5e5"
def _render_call_graph(module: Path) -> None:
buffer = StringIO()
code2flow(str(module), buffer)
try:
svg = subprocess.check_output(["dot", "-Tsvg"], input=buffer.getvalue(), text=True) # noqa: S607
except subprocess.CalledProcessError:
# The subprocess dies with SIGSEGV in GHA...
return
if 'class="node"' not in svg:
print()
else:
print(f'<div class="interactiveSVG code2flow">{svg}</div>')
def _comment_block(module: Path) -> str:
lines = []
with module.open() as file:
for line in file:
if line.startswith("#"):
lines.append(line[1:])
else:
break
return dedent("".join(lines))
def _render_api(path: Path, root: Path, heading_level: int = 4) -> None:
for module in sorted(path.iterdir()):
if module.name in ("__main__.py", "__init__.py"):
continue
rel_path = str(module.relative_to(root).with_suffix("")).replace("/", "-")
if module.suffix == ".py":
print(f"{'#' * heading_level} `{module.name}` {{#{rel_path}}}\n")
print(_comment_block(module))
_render_call_graph(module)
elif module.is_dir() and module.joinpath("__init__.py").exists():
print(f"{'#' * heading_level} `{module.name}` {{#{rel_path}}}\n")
print(_comment_block(module / "__init__.py"))
_render_api(module, root, heading_level + 1)
def render_internal_api(heading_level: int = 4) -> None:
"""Render Griffe's internal API's structure docs.
This function prints Markdown headings, and the contents of the first comment block of a module,
for all modules in our internal API.
Parameters:
heading_level: The initial level of Markdown headings.
"""
root = Path(os.environ["MKDOCS_CONFIG_DIR"])
src = root / "src"
internal_api = src / "griffe" / "_internal"
print(_comment_block(internal_api / "__init__.py"))
_render_api(internal_api, internal_api, heading_level)
def render_public_api(heading_level: int = 4) -> None:
"""Render Griffe's main module's docs.
Parameters:
heading_level: The initial level of Markdown headings.
"""
root = Path(os.environ["MKDOCS_CONFIG_DIR"])
src = root / "src"
public_api = src / "griffe"
print(f"{'#' * heading_level} `griffe`\n")
print(_comment_block(public_api / "__init__.py"))
def render_entrypoint(heading_level: int = 4) -> None:
"""Render Griffe's main entrypoint's docs.
Parameters:
heading_level: The initial level of Markdown headings.
"""
root = Path(os.environ["MKDOCS_CONFIG_DIR"])
src = root / "src"
public_api = src / "griffe"
print(f"{'#' * heading_level} `griffe.__main__`\n")
print(_comment_block(public_api / "__main__.py"))
|
