Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathcodegen.py
More file actions
Latest commit
454 lines (398 loc) · 17.2 KB
/
Copy pathcodegen.py
File metadata and controls
454 lines (398 loc) · 17.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
#!/usr/bin/env python3
"""
Generate factory.py from OpenAPI spec.
Reads specs/openapi.json and auto-generates src/roxy_sdk/factory.py with all
domain namespace classes, Roxy aggregate, and create_roxy() factory.
The OpenAPI spec is the only source of truth for *which* tags exist and what
endpoints belong to each. This file only configures how tag names map to
public SDK namespaces:
1. Most tags derive their snake_case attribute and PascalCase class name
automatically — e.g. "Vedic Astrology" -> vedic_astrology / VedicAstrologyDomain,
"Numerology" -> numerology / NumerologyDomain, "Languages" -> languages /
LanguagesDomain. New tags need NO change here.
2. A handful of tags use a curated short-form for branding — the public SDK
exposes ``roxy.astrology``, not ``roxy.western_astrology``. Those overrides
live in NAMESPACE_ALIASES below.
Adding a brand-new tag with a non-default short-form (e.g. "Crystals and Healing
Stones" -> ``crystals``) is the only reason to touch this file. Otherwise
codegen handles it.
Run: python codegen.py
"""
from __future__ importannotations
importjson
importre
frompathlibimportPath
fromtypingimportAny
SPEC_PATH=Path("specs/openapi.json")
OUTPUT_PATH=Path("src/roxy_sdk/factory.py")
# Curated short-form namespaces for product branding. Keys are exact tag names
# from the OpenAPI spec; values are the desired snake_case attribute name on
# the Roxy aggregate. The class name is derived from the attribute name (see
# tag_to_class). Any tag not listed here uses snake_case(tag_name) automatically.
NAMESPACE_ALIASES: dict[str, str] = {
"Western Astrology": "astrology",
"Crystals and Healing Stones": "crystals",
"Location and Timezone": "location",
"I-Ching": "iching",
}
def_snake_case(name: str) ->str:
"""Split on non-alphanumerics, lowercase, join with underscores."""
parts= [pforpinre.split(r"[^a-zA-Z0-9]+", str(name)) ifp]
ifnotparts:
returnstr(name).lower()
return"_".join(p.lower() forpinparts)
deftag_to_attr(name: str) ->str:
"""Return the snake_case attribute name on the Roxy aggregate for a tag."""
returnNAMESPACE_ALIASES.get(name, _snake_case(name))
deftag_to_class(name: str) ->str:
"""Return the PascalCase domain class name for a tag, suffixed with Domain."""
attr=tag_to_attr(name)
pascal=attr.title().replace("_", "")
returnf"{pascal}Domain"
deftag_summary(tag: dict[str, Any]) ->str:
"""Extract a short, dev-facing summary from the spec's tag object.
Prefers ``x-sdk-summary`` if present (forward-compat for when the server adds
explicit SDK summaries per tag). Otherwise takes the first sentence of
``description``, capped at ~120 chars.
"""
sdk_summary=tag.get("x-sdk-summary")
ifisinstance(sdk_summary, str) andsdk_summary.strip():
returnsdk_summary.strip()
desc= (tag.get("description") or"").strip()
ifnotdesc:
returnstr(tag.get("name") or"")
first_sentence=re.split(r"\.\s+", desc, maxsplit=1)[0].strip()
flat=re.sub(r"\s+", " ", first_sentence)
returnflat[:117].rstrip() +"..."iflen(flat) >120elseflat
defcamel_to_snake(name: str) ->str:
s1=re.sub(r"([A-Z]+)([A-Z][a-z])", r"\1_\2", name)
returnre.sub(r"([a-z\d])([A-Z])", r"\1_\2", s1).lower()
defjson_type_to_python(schema: dict) ->str:
t=schema.get("type", "string")
ift=="integer":
return"int"
ift=="number":
return"float"
ift=="boolean":
return"bool"
ift=="array":
inner=json_type_to_python(schema.get("items", {}))
returnf"list[{inner}]"
ift=="object":
return"dict[str, Any]"
return"str"
defresolve_ref(spec: dict, ref: str) ->dict:
parts=ref.lstrip("#/").split("/")
obj=spec
forpartinparts:
obj=obj[part]
returnobj
defextract_body(spec: dict, operation: dict) ->tuple[dict, list[str]]:
"""Extract request body properties and required fields."""
rb=operation.get("requestBody", {})
ifnotrb:
return {}, []
content=rb.get("content", {}).get("application/json", {})
schema=content.get("schema", {})
if"$ref"inschema:
schema=resolve_ref(spec, schema["$ref"])
props= {}
forname, propinschema.get("properties", {}).items():
if"$ref"inprop:
prop=resolve_ref(spec, prop["$ref"])
props[name] =prop
returnprops, schema.get("required", [])
defbuild_method(op: dict) ->str:
"""Generate sync + async wrapper methods for one endpoint."""
func=camel_to_snake(op["operationId"])
http=op["method"]
path=op["path"]
summary= (op.get("summary") orfunc).replace("'", "").replace('"', "")
path_params= [p["name"] forpinop.get("parameters", []) ifp.get("in") =="path"]
query_params= [pforpinop.get("parameters", []) ifp.get("in") =="query"]
# Build method signature params
sig_parts: list[str] = []
forpinpath_params:
sig_parts.append(f"{camel_to_snake(p)}: str")
body_props=op.get("body_properties", {})
body_required=op.get("body_required_fields", [])
ifbody_props:
forprop_name, prop_infoinbody_props.items():
py_name=camel_to_snake(prop_name)
py_type=json_type_to_python(prop_info)
ifprop_nameinbody_required:
sig_parts.append(f"{py_name}: {py_type}")
else:
sig_parts.append(f"{py_name}: {py_type} | None = None")
# Query params (skip lang, add at end)
forqpinquery_params:
ifqp["name"] =="lang":
continue
py_name=camel_to_snake(qp["name"])
py_type=json_type_to_python(qp.get("schema", {}))
sig_parts.append(f"{py_name}: {py_type} | None = None")
has_lang=any(qp["name"] =="lang"forqpinquery_params)
ifhas_lang:
sig_parts.append("lang: str | None = None")
sig=", ".join(["self", "*"] +sig_parts) ifsig_partselse"self"
# Build f-string path
fpath=path
forpinpath_params:
fpath=fpath.replace(f"{{{p}}}", f"{{{camel_to_snake(p)}}}")
# Build method body
body_lines: list[str] = []
ifhttp=="get":
ifquery_params:
body_lines.append(" params: dict[str, Any] = {}")
forqpinquery_params:
py_name=camel_to_snake(qp["name"])
body_lines.append(f" if {py_name} is not None:")
body_lines.append(f' params["{qp["name"]}"] = {py_name}')
body_lines.append(f' return self._get(f"{fpath}", params=params or None)')
else:
body_lines.append(f' return self._get(f"{fpath}")')
else: # POST
ifbody_props:
body_lines.append(" body: dict[str, Any] = {}")
forprop_nameinbody_props:
py_name=camel_to_snake(prop_name)
ifprop_nameinbody_required:
body_lines.append(f' body["{prop_name}"] = {py_name}')
else:
body_lines.append(f" if {py_name} is not None:")
body_lines.append(f' body["{prop_name}"] = {py_name}')
else:
body_lines.append(" body: dict[str, Any] = {}")
ifhas_lang:
body_lines.append(" params: dict[str, Any] = {}")
body_lines.append(" if lang is not None:")
body_lines.append(' params["lang"] = lang')
body_lines.append(f' return self._post(f"{fpath}", body, params=params or None)')
else:
body_lines.append(f' return self._post(f"{fpath}", body)')
body_code="\n".join(body_lines)
async_body=body_code.replace("self._get(", "await self._get_async(").replace(
"self._post(", "await self._post_async("
)
returnf""" def {func}({sig}) -> Any:
\"\"\"{summary}\"\"\"
{body_code}
async def {func}_async({sig}) -> Any:
\"\"\"{summary} (async)\"\"\"
{async_body}
"""
defmain() ->None:
spec=json.loads(SPEC_PATH.read_text())
# Index tag objects (with descriptions) for summary extraction.
tag_objects: dict[str, dict[str, Any]] = {
t["name"]: tfortinspec.get("tags", []) ifisinstance(t, dict) and"name"int
}
# Warn on stale NAMESPACE_ALIASES — aliases pointing at tags no longer in
# the spec. New tags are fine; they auto-derive via tag_to_attr / tag_to_class.
spec_tag_names: set[str] =set(tag_objects.keys())
for_, path_iteminspec.get("paths", {}).items():
forhttp_methodin ("get", "post"):
op=path_item.get(http_method)
ifop:
spec_tag_names.add((op.get("tags", ["Other"]) or ["Other"])[0])
foralias_taginNAMESPACE_ALIASES:
ifalias_tagnotinspec_tag_names:
print(
f"WARNING: NAMESPACE_ALIASES entry '{alias_tag}' is stale — "
"no such tag in the OpenAPI spec. Remove it from codegen.py."
)
# Group operations by tag
domains: dict[str, list[dict]] = {}
forpath, path_iteminspec.get("paths", {}).items():
forhttp_methodin ("get", "post"):
operation=path_item.get(http_method)
ifnotoperation:
continue
tags=operation.get("tags", ["Other"])
tag=tags[0]
oid=operation.get("operationId", "")
ifnotoid:
continue
body_props, body_req=extract_body(spec, operation)
iftagnotindomains:
domains[tag] = []
domains[tag].append(
{
"operationId": oid,
"method": http_method,
"path": path,
"summary": operation.get("summary", ""),
"parameters": operation.get("parameters", []),
"body_properties": body_props,
"body_required_fields": body_req,
}
)
# Write output
out: list[str] = [
'"""',
"AUTO-GENERATED by codegen.py from OpenAPI spec. Do not edit manually.",
"Regenerate with: python generate.py",
'"""',
"from __future__ import annotations",
"",
"from typing import Any",
"",
"import httpx",
"",
"from roxy_sdk.version import VERSION",
"",
"",
'_BASE_URL = "https://roxyapi.com/api/v2"',
"",
"",
"class RoxyAPIError(Exception):",
' """Error returned by the RoxyAPI."""',
"",
" def __init__(self, error: str, code: str, status_code: int) -> None:",
" self.error = error",
" self.code = code",
" self.status_code = status_code",
' super().__init__(f"[{status_code}] {code}: {error}")',
"",
" def __repr__(self) -> str:",
' return f"RoxyAPIError(error={self.error!r}, code={self.code!r}, status_code={self.status_code})"',
"",
"",
"def _default_headers(api_key: str) -> dict[str, str]:",
" return {",
' "X-API-Key": api_key,',
' "X-SDK-Client": f"roxy-sdk-python/{VERSION}",',
' "Accept": "application/json",',
" }",
"",
"",
"def _handle_response(resp: httpx.Response) -> Any:",
' """Parse response, raising RoxyAPIError on 4xx/5xx."""',
" if resp.status_code >= 400:",
" try:",
" body = resp.json()",
" except Exception:",
" body = {}",
" raise RoxyAPIError(",
' error=body.get("error", resp.text or "Unknown error"),',
' code=body.get("code", "unknown"),',
" status_code=resp.status_code,",
" )",
" return resp.json()",
"",
"",
"class _BaseDomain:",
' """Base class for all domain namespaces."""',
"",
" def __init__(self, client: httpx.Client, async_client: httpx.AsyncClient) -> None:",
" self._client = client",
" self._async_client = async_client",
"",
" def _get(self, path: str, params: dict[str, Any] | None = None) -> Any:",
" return _handle_response(self._client.get(path, params=params))",
"",
" async def _get_async(self, path: str, params: dict[str, Any] | None = None) -> Any:",
" return _handle_response(await self._async_client.get(path, params=params))",
"",
" def _post(self, path: str, body: dict[str, Any] | None = None, params: dict[str, Any] | None = None) -> Any:",
" return _handle_response(self._client.post(path, json=body, params=params))",
"",
" async def _post_async(self, path: str, body: dict[str, Any] | None = None, params: dict[str, Any] | None = None) -> Any:",
" return _handle_response(await self._async_client.post(path, json=body, params=params))",
"",
]
# Domain classes. Emit in spec tag order when available; fall back to
# alphabetical so brand-new endpoints get a deterministic position.
spec_tag_order= [
t["name"] fortinspec.get("tags", []) ifisinstance(t, dict) and"name"int
]
ordered_tags= [tfortinspec_tag_orderiftindomains]
ordered_tags+=sorted(tfortindomainsiftnotinspec_tag_order)
domain_classes: list[tuple[str, str]] = []
fortaginordered_tags:
class_name=tag_to_class(tag)
attr_name=tag_to_attr(tag)
summary=tag_summary(tag_objects.get(tag, {"name": tag}))
docstring=summaryorf"{tag} endpoints."
domain_classes.append((class_name, attr_name))
out.append("")
out.append(f"class {class_name}(_BaseDomain):")
out.append(f' """{docstring}"""')
out.append("")
foropinsorted(domains[tag], key=lambdax: x["operationId"]):
out.append(build_method(op))
# Roxy class
out.append("")
out.append("class Roxy:")
out.append(' """')
out.append(" RoxyAPI Python SDK.")
out.append(" Reuses HTTP connections. Supports context manager.")
out.append("")
out.append(" Usage::")
out.append(" from roxy_sdk import create_roxy")
out.append(' roxy = create_roxy("your-api-key")')
out.append(' horoscope = roxy.astrology.get_daily_horoscope(sign="aries")')
out.append(' """')
out.append("")
out.append(
" def __init__(self, api_key: str, base_url: str = _BASE_URL, timeout: float = 30.0) -> None:"
)
out.append(" if not api_key:")
out.append(
' raise ValueError("API key is required. Get one at https://roxyapi.com/pricing")'
)
out.append(" headers = _default_headers(api_key)")
out.append(
" self._client = httpx.Client(base_url=base_url, headers=headers, timeout=timeout)"
)
out.append(
" self._async_client = httpx.AsyncClient(base_url=base_url, headers=headers, timeout=timeout)"
)
forcn, anindomain_classes:
out.append(f" self.{an} = {cn}(self._client, self._async_client)")
out.append("")
out.append(" def close(self) -> None:")
out.append(' """Close sync HTTP connections."""')
out.append(" self._client.close()")
out.append("")
out.append(" async def aclose(self) -> None:")
out.append(' """Close all HTTP connections (sync + async)."""')
out.append(" self._client.close()")
out.append(" await self._async_client.aclose()")
out.append("")
out.append(" def __enter__(self) -> Roxy:")
out.append(" return self")
out.append("")
out.append(" def __exit__(self, *args: Any) -> None:")
out.append(" self.close()")
out.append("")
out.append(" async def __aenter__(self) -> Roxy:")
out.append(" return self")
out.append("")
out.append(" async def __aexit__(self, *args: Any) -> None:")
out.append(" await self.aclose()")
out.append("")
out.append(" def __repr__(self) -> str:")
out.append(' return f"Roxy(base_url={self._client.base_url!r})"')
out.append("")
out.append("")
# create_roxy
out.append(
"def create_roxy(api_key: str, base_url: str = _BASE_URL, timeout: float = 30.0) -> Roxy:"
)
out.append(' """')
out.append(" Create a configured Roxy instance.")
out.append("")
out.append(" Args:")
out.append(" api_key: Your RoxyAPI key. Get one at https://roxyapi.com/pricing")
out.append(
" base_url: Override the default API base URL. Default: https://roxyapi.com/api/v2"
)
out.append(" timeout: Request timeout in seconds. Default: 30.")
out.append(' """')
out.append(" return Roxy(api_key=api_key, base_url=base_url, timeout=timeout)")
out.append("")
OUTPUT_PATH.write_text("\n".join(out))
print(f"Generated {OUTPUT_PATH} ({len(out)} lines)")
if__name__=="__main__":
main()