Skip to content

Commit fd5472d

Browse files
authored
Use sdk id for package name instead of filename (#127)
1 parent 3a7dd19 commit fd5472d

2 files changed

Lines changed: 60 additions & 39 deletions

File tree

‎codegen/gen_client.py‎

Lines changed: 57 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
import tomllib
1818
from collections.abc import Iterator
1919
from contextlib import contextmanager
20+
from dataclasses import dataclass
2021
from pathlib import Path
2122

2223
CODEGEN_DIR = Path(__file__).resolve().parent
@@ -50,6 +51,13 @@
5051
}
5152

5253

54+
@dataclass(frozen=True)
55+
class Service:
56+
model: Path
57+
shape_id: str
58+
slug: str
59+
60+
5361
def main() -> None:
5462
sys.stdout.reconfigure(line_buffering=True)
5563
parser = argparse.ArgumentParser()
@@ -62,27 +70,25 @@ def main() -> None:
6270
if args.batch_size < 1:
6371
sys.exit("--batch-size must be at least 1")
6472

65-
models = (
66-
sorted(MODELS.glob("*.json"))
67-
if args.all
68-
else [resolve_model(n) for n in args.names]
73+
services = (
74+
load_services() if args.all else [_resolve_service(n) for n in args.names]
6975
)
70-
if not models:
76+
if not services:
7177
sys.exit("no clients selected")
7278

7379
if args.pinned:
7480
with _pinned_codegen(_pinned_commit()) as gradle_args:
75-
_generate(models, args.batch_size, gradle_args)
81+
_generate(services, args.batch_size, gradle_args)
7682
else:
77-
_generate(models, args.batch_size, [])
83+
_generate(services, args.batch_size, [])
7884

7985

80-
def _generate(models: list[Path], batch_size: int, gradle_args: list[str]) -> None:
81-
for start in range(0, len(models), batch_size):
82-
batch = models[start : start + batch_size]
86+
def _generate(services: list[Service], batch_size: int, gradle_args: list[str]) -> None:
87+
for start in range(0, len(services), batch_size):
88+
batch = services[start : start + batch_size]
8389
_build(batch, gradle_args)
84-
for model in batch:
85-
_install_client(model.stem)
90+
for service in batch:
91+
_install_client(service.slug)
8692

8793

8894
def _pinned_commit() -> str:
@@ -153,38 +159,51 @@ def _smithy_python() -> Path:
153159
).resolve()
154160

155161

156-
def resolve_model(name: str) -> Path:
157-
key = name.strip()
158-
for prefix in ("aws-sdk-", "aws_sdk_"):
159-
if key.startswith(prefix):
160-
key = key[len(prefix) :]
161-
break
162-
for cand in {key, key.replace("_", "-"), key.replace("-", "_")}:
163-
model = MODELS / f"{cand}.json"
164-
if model.exists():
165-
return model
166-
available = sorted(p.stem for p in MODELS.glob("*.json"))
167-
sys.exit(f"no model for '{name}' in {MODELS}\navailable: {', '.join(available)}")
162+
def load_services() -> list[Service]:
163+
return [_load_service(model) for model in sorted(MODELS.glob("*.json"))]
168164

169165

170-
def service_id(model: Path) -> str:
171-
shapes = json.loads(model.read_text())["shapes"]
166+
def _load_service(model: Path) -> Service:
167+
shapes = json.loads(model.read_text(encoding="utf-8"))["shapes"]
172168
services = [k for k, v in shapes.items() if v.get("type") == "service"]
173169
if len(services) != 1:
174170
sys.exit(
175171
f"expected exactly one service shape in {model.name}, found {services}"
176172
)
177-
return services[0]
178-
179-
180-
def _projection(model: Path) -> dict[str, object]:
181-
slug = model.stem
173+
shape_id = services[0]
174+
sdk_id = shapes[shape_id].get("traits", {}).get("aws.api#service", {}).get("sdkId")
175+
if not isinstance(sdk_id, str):
176+
sys.exit(f"{model.name}: {shape_id} has no aws.api#service sdkId")
177+
slug = _sdk_id_slug(sdk_id)
178+
if not re.fullmatch(r"[a-z0-9]+(-[a-z0-9]+)*", slug):
179+
sys.exit(f"{model.name}: sdkId {sdk_id!r} does not form a valid package name")
180+
if slug != model.stem:
181+
sys.exit(f"{model.name}: sdkId {sdk_id!r} requires the name {slug}.json")
182+
return Service(model, shape_id, slug)
183+
184+
185+
def _sdk_id_slug(sdk_id: str) -> str:
186+
# split() rather than replace(" ", "-"): a run of whitespace, or any at either
187+
# end, must not produce repeated or dangling hyphens.
188+
return "-".join(sdk_id.lower().split())
189+
190+
191+
def _resolve_service(name: str) -> Service:
192+
key = name.strip().lower().replace("_", "-").removeprefix("aws-sdk-")
193+
model = MODELS / f"{key}.json"
194+
if model.is_file():
195+
return _load_service(model)
196+
available = ", ".join(sorted(p.stem for p in MODELS.glob("*.json")))
197+
sys.exit(f"no model for '{name}' in {MODELS}\navailable: {available}")
198+
199+
200+
def _projection(service: Service) -> dict[str, object]:
182201
return {
183202
"plugins": {
184203
"python-client-codegen": {
185-
"service": service_id(model),
186-
"module": _module(slug),
187-
"moduleVersion": _client_version(slug),
204+
"service": service.shape_id,
205+
"module": _module(service.slug),
206+
"moduleVersion": _client_version(service.slug),
188207
}
189208
},
190209
}
@@ -211,17 +230,18 @@ def _read_version(pyproject: Path) -> str:
211230
return tomllib.load(f)["project"]["version"]
212231

213232

214-
def _build(models: list[Path], gradle_args: list[str]) -> None:
233+
def _build(services: list[Service], gradle_args: list[str]) -> None:
215234
# Generated shape order depends on the loaded model set, so every build loads all
216235
# models, as the release build does; batch size then cannot affect output.
217236
build_config = {
218237
"version": "1.0",
219238
"imports": [str(MODELS)],
220-
"projections": {m.stem: _projection(m) for m in models},
239+
"projections": {s.slug: _projection(s) for s in services},
221240
}
222241
build_file = CODEGEN_DIR / "smithy-build.json"
223242
build_file.write_text(json.dumps(build_config, indent=4) + "\n")
224-
print(f"generating {len(models)} client(s): {', '.join(m.stem for m in models)}")
243+
slugs = ", ".join(s.slug for s in services)
244+
print(f"generating {len(services)} client(s): {slugs}")
225245
subprocess.run(
226246
[
227247
str(CODEGEN_DIR / "gradlew"),

‎codegen/gen_fragments.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,11 @@
1313
import tomllib
1414
from pathlib import Path
1515

16+
from gen_client import load_services
17+
1618
CODEGEN_DIR = Path(__file__).resolve().parent
1719
REPO = CODEGEN_DIR.parent
1820
CLIENTS = REPO / "clients"
19-
MODELS = CODEGEN_DIR / "aws-models"
2021
POINTER = CODEGEN_DIR / "smithy-python.toml"
2122
SYNC_CHANGELOG = REPO / "CODEGEN_SYNC_CHANGELOG.md"
2223
SMITHY_PYTHON_COMMITS = "https://github.com/smithy-lang/smithy-python/commits"
@@ -65,7 +66,7 @@ def _description(previous: str, commit: str) -> str:
6566

6667

6768
def _generated_clients() -> list[str]:
68-
return [f"aws-sdk-{model.stem}" for model in sorted(MODELS.glob("*.json"))]
69+
return [f"aws-sdk-{service.slug}" for service in load_services()]
6970

7071

7172
def _write_fragment(name: str, commit: str, description: str) -> None:

0 commit comments

Comments
 (0)