-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathbenchmark_generate.py
More file actions
244 lines (198 loc) · 7.7 KB
/
Copy pathbenchmark_generate.py
File metadata and controls
244 lines (198 loc) · 7.7 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
from __future__ import annotations
import argparse
import gzip
import json
import shutil
import statistics
import sys
import tempfile
import time
from pathlib import Path
from typing import Any
def _load_spec(path: Path) -> str:
if path.suffix == ".gz":
return gzip.decompress(path.read_bytes()).decode("utf-8")
return path.read_text(encoding="utf-8")
def _load_generator(package_path: Path) -> tuple[Any, Any]:
sys.path.insert(0, str(package_path.resolve()))
from openapi_python.generator import GenerationRequest, generate_client
return GenerationRequest, generate_client
def _run_once(
*,
generate_client: Any,
generation_request: Any,
spec_json: str,
package_name: str,
) -> tuple[float, Any]:
output_dir = Path(tempfile.mkdtemp(prefix="openapi-python-benchmark-"))
try:
start = time.perf_counter()
result = generate_client(
generation_request(
output_dir=output_dir,
spec_json=spec_json,
package_name=package_name,
overwrite=True,
)
)
elapsed = time.perf_counter() - start
return elapsed, result
finally:
shutil.rmtree(output_dir, ignore_errors=True)
def _run_size_once(
*,
generate_client: Any,
generation_request: Any,
spec_json: str,
package_name: str,
) -> tuple[dict[str, int], Any]:
output_dir = Path(tempfile.mkdtemp(prefix="openapi-python-size-"))
try:
result = generate_client(
generation_request(
output_dir=output_dir,
spec_json=spec_json,
package_name=package_name,
overwrite=True,
)
)
file_sizes = {
path.relative_to(output_dir).as_posix(): path.stat().st_size
for path in result.written_files
}
return file_sizes, result
finally:
shutil.rmtree(output_dir, ignore_errors=True)
def run_benchmark(args: argparse.Namespace) -> int:
spec_json = _load_spec(args.spec)
generation_request, generate_client = _load_generator(args.package_path)
result = None
for _ in range(args.warmup):
_, result = _run_once(
generate_client=generate_client,
generation_request=generation_request,
spec_json=spec_json,
package_name=args.package,
)
samples = []
for _ in range(args.repeat):
elapsed, result = _run_once(
generate_client=generate_client,
generation_request=generation_request,
spec_json=spec_json,
package_name=args.package,
)
samples.append(elapsed)
if result is None:
raise RuntimeError("benchmark did not run")
payload = {
"best_seconds": min(samples),
"median_seconds": statistics.median(samples),
"samples_seconds": samples,
"operations": result.operations,
"type_definitions": result.type_definitions,
"repeat": args.repeat,
"warmup": args.warmup,
}
encoded = json.dumps(payload, indent=2, sort_keys=True)
if args.output:
args.output.write_text(encoded + "\n", encoding="utf-8")
print(encoded)
return 0
def run_size_benchmark(args: argparse.Namespace) -> int:
spec_json = _load_spec(args.spec)
generation_request, generate_client = _load_generator(args.package_path)
file_sizes, result = _run_size_once(
generate_client=generate_client,
generation_request=generation_request,
spec_json=spec_json,
package_name=args.package,
)
payload = {
"files_bytes": file_sizes,
"operations": result.operations,
"total_bytes": sum(file_sizes.values()),
"type_definitions": result.type_definitions,
}
encoded = json.dumps(payload, indent=2, sort_keys=True)
if args.output:
args.output.write_text(encoded + "\n", encoding="utf-8")
print(encoded)
return 0
def _format_bytes(value: float) -> str:
return f"{value:,.0f} bytes"
def compare_benchmarks(args: argparse.Namespace) -> int:
baseline = json.loads(args.baseline.read_text(encoding="utf-8"))
candidate = json.loads(args.candidate.read_text(encoding="utf-8"))
baseline_seconds = float(baseline["best_seconds"])
candidate_seconds = float(candidate["best_seconds"])
allowed_seconds = baseline_seconds * (1 + args.max_regression)
change = (candidate_seconds - baseline_seconds) / baseline_seconds
print(f"baseline best: {baseline_seconds:.6f}s")
print(f"candidate best: {candidate_seconds:.6f}s")
print(f"change: {change:+.2%}")
print(f"limit: +{args.max_regression:.2%}")
if candidate_seconds > allowed_seconds:
print(
"generation benchmark regressed beyond the configured limit",
file=sys.stderr,
)
return 1
return 0
def compare_size_benchmarks(args: argparse.Namespace) -> int:
baseline = json.loads(args.baseline.read_text(encoding="utf-8"))
candidate = json.loads(args.candidate.read_text(encoding="utf-8"))
baseline_bytes = float(baseline["total_bytes"])
candidate_bytes = float(candidate["total_bytes"])
allowed_bytes = baseline_bytes * (1 + args.max_regression)
change = (candidate_bytes - baseline_bytes) / baseline_bytes
print(f"baseline total: {_format_bytes(baseline_bytes)}")
print(f"candidate total: {_format_bytes(candidate_bytes)}")
print(f"change: {change:+.2%}")
print(f"limit: +{args.max_regression:.2%}")
if candidate_bytes > allowed_bytes:
print(
"generated file size regressed beyond the configured limit",
file=sys.stderr,
)
return 1
return 0
def _build_parser() -> argparse.ArgumentParser:
parser = argparse.ArgumentParser(
prog="benchmark_generate.py",
description="Benchmark OpenAPI client generation for a large spec.",
)
subcommands = parser.add_subparsers(dest="command", required=True)
run = subcommands.add_parser("run", help="Run the generation benchmark")
run.add_argument("--spec", type=Path, required=True)
run.add_argument("--package-path", type=Path, default=Path.cwd())
run.add_argument("--package", default="my_client")
run.add_argument("--repeat", type=int, default=5)
run.add_argument("--warmup", type=int, default=1)
run.add_argument("--output", type=Path)
run.set_defaults(func=run_benchmark)
size = subcommands.add_parser("size", help="Measure generated file sizes")
size.add_argument("--spec", type=Path, required=True)
size.add_argument("--package-path", type=Path, default=Path.cwd())
size.add_argument("--package", default="my_client")
size.add_argument("--output", type=Path)
size.set_defaults(func=run_size_benchmark)
compare = subcommands.add_parser("compare", help="Compare two benchmark results")
compare.add_argument("--baseline", type=Path, required=True)
compare.add_argument("--candidate", type=Path, required=True)
compare.add_argument("--max-regression", type=float, default=0.02)
compare.set_defaults(func=compare_benchmarks)
compare_size = subcommands.add_parser(
"compare-size", help="Compare two generated file size results"
)
compare_size.add_argument("--baseline", type=Path, required=True)
compare_size.add_argument("--candidate", type=Path, required=True)
compare_size.add_argument("--max-regression", type=float, default=0.02)
compare_size.set_defaults(func=compare_size_benchmarks)
return parser
def main(argv: list[str] | None = None) -> int:
parser = _build_parser()
args = parser.parse_args(argv)
return args.func(args)
if __name__ == "__main__":
raise SystemExit(main())