fix: writing type aliases as python3.12 type declarations

Author: Anders Brams

openapi_python/generator/templates/alias.py.j2

@@ -1 +1 @@
-{{ alias.name }}: TypeAlias = {{ alias.annotation | annotation }}
+type {{ alias.name }} = {{ alias.annotation | annotation }}

openapi_python/generator/templates/types.py.j2

@@ -5,7 +5,7 @@ from enum import Enum
 {% if has_field_descriptions -%}
 from importlib import import_module
 {% endif -%}
-from typing import Annotated, Any, Literal, NotRequired, TypeAlias, TypedDict
+from typing import Annotated, Any, Literal, NotRequired, TypedDict
 
 {% if has_field_descriptions %}
 def _openapi_python_field(description: str) -> object:

tests/contract/discriminated_union/app.py

@@ -5,7 +5,7 @@
 from fastapi import FastAPI
 from pydantic import BaseModel, Field
 
-app = FastAPI()
+app = FastAPI(separate_input_output_schemas=False)
 
 
 class Cat(BaseModel):
@@ -34,3 +34,35 @@ def get_pet(pet_id: int) -> PetEnvelope:
 @app.post("/pets", response_model=PetEnvelope)
 def create_pet(body: PetEnvelope) -> PetEnvelope:
     return body
+
+
+class CiscoSiteArea(BaseModel):
+    type: Literal["area"]
+    name: str
+
+
+class CiscoSiteBuilding(BaseModel):
+    type: Literal["building"]
+    name: str
+    country: str
+
+
+class CiscoSiteFloor(BaseModel):
+    type: Literal["floor"]
+    name: str
+    floor_number: int
+
+
+type CiscoSite = Annotated[
+    CiscoSiteArea | CiscoSiteBuilding | CiscoSiteFloor,
+    Field(discriminator="type"),
+]
+
+
+class CiscoAccessPointConfig(BaseModel):
+    site_hierarchy: list[CiscoSite]
+
+
+@app.post("/sites", response_model=CiscoAccessPointConfig)
+def create_site(body: CiscoAccessPointConfig) -> CiscoAccessPointConfig:
+    return body

tests/contract/discriminated_union/generate.py

@@ -1,21 +1,54 @@
-from __future__ import annotations
-
 import json
 from pathlib import Path
+from typing import cast
 
 from app import app
+from fastapi import FastAPI
 
 from openapi_python.generator import GenerationRequest, generate_client
 
+OUTPUT_DIR = Path(__file__).parent / "generated"
+
+
+def _service_b_openapi() -> dict:
+    from generated.service_a_client.types import CiscoAccessPointConfig, PetEnvelope
+
+    service_b = FastAPI(separate_input_output_schemas=False)
+
+    @service_b.get("/pets/{pet_id}", response_model=PetEnvelope)
+    def get_pet(pet_id: int) -> PetEnvelope:
+        return cast(
+            PetEnvelope,
+            {"pet": {"pet_type": "cat", "lives": 9}, "request_id": f"pet_{pet_id}"},
+        )
+
+    @service_b.post("/pets", response_model=PetEnvelope)
+    def create_pet(body: PetEnvelope) -> PetEnvelope:
+        return body
+
+    @service_b.post("/sites", response_model=CiscoAccessPointConfig)
+    def create_site(body: CiscoAccessPointConfig) -> CiscoAccessPointConfig:
+        return body
+
+    return service_b.openapi()
+
 
 def main() -> None:
     generate_client(
         GenerationRequest(
-            output_dir=Path(__file__).parent / "generated",
+            output_dir=OUTPUT_DIR,
+            package_name="service_a_client",
             spec_json=json.dumps(app.openapi()),
             overwrite=True,
         )
     )
+    generate_client(
+        GenerationRequest(
+            output_dir=OUTPUT_DIR,
+            spec_json=json.dumps(_service_b_openapi()),
+            overwrite=True,
+        )
+    )
 
 
 if __name__ == "__main__":

tests/contract/discriminated_union/usage_async.py

@@ -3,7 +3,16 @@
 from typing import Literal, assert_type
 
 from generated.my_client import AsyncClient
-from generated.my_client.types import Cat, Dog, PetEnvelope
+from generated.my_client.types import (
+    Cat,
+    CiscoAccessPointConfig,
+    CiscoSite,
+    CiscoSiteArea,
+    CiscoSiteBuilding,
+    CiscoSiteFloor,
+    Dog,
+    PetEnvelope,
+)
 
 async_client = AsyncClient(base_url="http://testserver")
 
@@ -29,3 +38,22 @@ async def use_async_client() -> None:
     fetched = await async_client.get("/pets/{pet_id}")(params={"pet_id": 1})
     assert_type(fetched, PetEnvelope)
     assert_type(fetched["pet"], Cat | Dog)
+
+    area: CiscoSiteArea = {"type": "area", "name": "Global"}
+    building: CiscoSiteBuilding = {
+        "type": "building",
+        "name": "HQ",
+        "country": "DK",
+    }
+    floor: CiscoSiteFloor = {
+        "type": "floor",
+        "name": "Ground",
+        "floor_number": 0,
+    }
+    site: CiscoSite = floor
+    body: CiscoAccessPointConfig = {"site_hierarchy": [area, building, site]}
+
+    created = await async_client.post("/sites")(body=body)
+    assert_type(created, CiscoAccessPointConfig)
+    assert_type(created["site_hierarchy"][0], CiscoSite)
+    assert_type(floor["type"], Literal["floor"])

tests/contract/discriminated_union/usage_sync.py

@@ -3,7 +3,16 @@
 from typing import Literal, assert_type
 
 from generated.my_client import Client
-from generated.my_client.types import Cat, Dog, PetEnvelope
+from generated.my_client.types import (
+    Cat,
+    CiscoAccessPointConfig,
+    CiscoSite,
+    CiscoSiteArea,
+    CiscoSiteBuilding,
+    CiscoSiteFloor,
+    Dog,
+    PetEnvelope,
+)
 
 client = Client(base_url="http://testserver")
 
@@ -27,3 +36,22 @@
 fetched = client.get("/pets/{pet_id}")(params={"pet_id": 1})
 assert_type(fetched, PetEnvelope)
 assert_type(fetched["pet"], Cat | Dog)
+
+area: CiscoSiteArea = {"type": "area", "name": "Global"}
+building: CiscoSiteBuilding = {
+    "type": "building",
+    "name": "HQ",
+    "country": "DK",
+}
+floor: CiscoSiteFloor = {
+    "type": "floor",
+    "name": "Ground",
+    "floor_number": 0,
+}
+site: CiscoSite = floor
+body: CiscoAccessPointConfig = {"site_hierarchy": [area, building, site]}
+
+created = client.post("/sites")(body=body)
+assert_type(created, CiscoAccessPointConfig)
+assert_type(created["site_hierarchy"][0], CiscoSite)
+assert_type(floor["type"], Literal["floor"])