feat: generalize generator & api_config for 3.0+ (multi-version OpenAPI types, model_dump) and update templates

Author: Doug Borg

src/openapi_python_generator/language_converters/python/api_config_generator.py

@@ -1,10 +1,11 @@
 from typing import Optional
 
-from openapi_pydantic.v3.v3_0 import OpenAPI
+from openapi_pydantic.v3 import OpenAPI
 
 from openapi_python_generator.common import PydanticVersion
 from openapi_python_generator.language_converters.python.jinja_config import (
-    API_CONFIG_TEMPLATE, API_CONFIG_TEMPLATE_PYDANTIC_V2,
+    API_CONFIG_TEMPLATE,
+    API_CONFIG_TEMPLATE_PYDANTIC_V2,
 )
 from openapi_python_generator.language_converters.python.jinja_config import (
     create_jinja_env,
@@ -13,19 +14,24 @@
 
 
 def generate_api_config(
-        data: OpenAPI, env_token_name: Optional[str] = None,
-        pydantic_version: PydanticVersion = PydanticVersion.V2,
+    data: OpenAPI,
+    env_token_name: Optional[str] = None,
+    pydantic_version: PydanticVersion = PydanticVersion.V2,
 ) -> APIConfig:
     """
     Generate the API model.
     """
 
-    template_name = API_CONFIG_TEMPLATE_PYDANTIC_V2 if pydantic_version == PydanticVersion.V2 else API_CONFIG_TEMPLATE
+    template_name = (
+        API_CONFIG_TEMPLATE_PYDANTIC_V2
+        if pydantic_version == PydanticVersion.V2
+        else API_CONFIG_TEMPLATE
+    )
     jinja_env = create_jinja_env()
     return APIConfig(
         file_name="api_config",
         content=jinja_env.get_template(template_name).render(
-            env_token_name=env_token_name, **data.dict()
+            env_token_name=env_token_name, **data.model_dump()
         ),
         base_url=data.servers[0].url if len(data.servers) > 0 else "NO SERVER",
     )

src/openapi_python_generator/language_converters/python/generator.py

@@ -1,6 +1,7 @@
-from typing import Optional
+from typing import Optional, Union
 
-from openapi_pydantic.v3.v3_0 import OpenAPI
+from openapi_pydantic.v3.v3_0 import OpenAPI as OpenAPI30
+from openapi_pydantic.v3.v3_1 import OpenAPI as OpenAPI31
 
 from openapi_python_generator.common import PydanticVersion
 from openapi_python_generator.language_converters.python import common
@@ -16,17 +17,20 @@
 from openapi_python_generator.models import ConversionResult
 from openapi_python_generator.models import LibraryConfig
 
+# Type alias for both OpenAPI versions
+OpenAPISpec = Union[OpenAPI30, OpenAPI31]
+
 
 def generator(
-    data: OpenAPI,
+    data: OpenAPISpec,
     library_config: LibraryConfig,
     env_token_name: Optional[str] = None,
     use_orjson: bool = False,
     custom_template_path: Optional[str] = None,
     pydantic_version: PydanticVersion = PydanticVersion.V2,
 ) -> ConversionResult:
     """
-    Generate Python code from an OpenAPI 3.0 specification.
+    Generate Python code from an OpenAPI 3.0+ specification.
     """
 
     common.set_use_orjson(use_orjson)

src/openapi_python_generator/language_converters/python/templates/aiohttp.jinja2

@@ -1,4 +1,4 @@
-async def {{ operation_id }}({{ params }} api_config_override : Optional[APIConfig] = None) -> {% if return_type.type is none or return_type.type.converted_type is none %}None{% else %}{{ return_type.type.converted_type}}{% endif %}:
+async def {{ operation_id }}(api_config_override : Optional[APIConfig] = None{% if params.strip() %}, *, {{ params.rstrip(', ') }}{% endif %}) -> {% if return_type.type is none or return_type.type.converted_type is none %}None{% else %}{{ return_type.type.converted_type}}{% endif %}:
     api_config = api_config_override if api_config_override else APIConfig()
 
     base_path = api_config.base_path

src/openapi_python_generator/language_converters/python/templates/httpx.jinja2

@@ -1,4 +1,4 @@
-{%  if async_client %}async {% endif %}def {{ operation_id }}({{ params }} api_config_override : Optional[APIConfig] = None) -> {% if return_type.type is none or return_type.type.converted_type is none %}None{% else %}{{ return_type.type.converted_type}}{% endif %}:
+{%  if async_client %}async {% endif %}def {{ operation_id }}(api_config_override : Optional[APIConfig] = None{% if params.strip() %}, *, {{ params.rstrip(', ') }}{% endif %}) -> {% if return_type.type is none or return_type.type.converted_type is none %}None{% else %}{{ return_type.type.converted_type}}{% endif %}:
     api_config = api_config_override if api_config_override else APIConfig()
 
     base_path = api_config.base_path

src/openapi_python_generator/language_converters/python/templates/requests.jinja2

@@ -1,4 +1,4 @@
-def {{ operation_id }}({{ params }} api_config_override : Optional[APIConfig] = None) -> {% if return_type.type is none or return_type.type.converted_type is none %}None{% else %}{{ return_type.type.converted_type}}{% endif %}:
+def {{ operation_id }}(api_config_override : Optional[APIConfig] = None{% if params.strip() %}, *, {{ params.rstrip(', ') }}{% endif %}) -> {% if return_type.type is none or return_type.type.converted_type is none %}None{% else %}{{ return_type.type.converted_type}}{% endif %}:
     api_config = api_config_override if api_config_override else APIConfig()
 
     base_path = api_config.base_path

src/openapi_python_generator/language_converters/python/templates/service.jinja2

@@ -3,6 +3,7 @@ import {{ library_import }}
 import json
 {% if use_orjson %}
 import orjson
+from uuid import UUID
 {% endif %}
 
 from ..models import *

tests/test_api_config.py

@@ -1,4 +1,4 @@
-from openapi_pydantic.v3.v3_0 import OpenAPI
+from openapi_pydantic.v3 import OpenAPI
 
 from openapi_python_generator.language_converters.python.api_config_generator import (
     generate_api_config,