openapi-generators / openapi-generators/openapi-python-client
Generates invalid python code for seemingly correct json
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Python
- Estrelas
- 2k
- Forks
- 293
- Merge médio
- 34min
- PRs com merge (30d)
- 1
Descrição
Describe the bug
generator around primitives in request body fails
OpenAPI Spec File
I cannot share the full spec but this is an excempt:
"/api/helloworlduser/{externalId}/something": {
"patch": {
"tags": [
"UpdateHelloWorldUser"
],
"description": "Update user",
"operationId": "HelloWorldUserUpdate",
"parameters": [
{
"name": "externalId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "number",
"format": "double",
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserReadDTO"
}
}
}
}
}
}
},
this generates the file:
from http import HTTPStatus
from typing import Any, cast
from urllib.parse import quote
import httpx
from ...client import AuthenticatedClient, Client
from ...types import Response, UNSET
from ... import errors
from ...models.user_read_dto import UserReadDTO
from ...types import UNSET, Unset
from typing import cast
def _get_kwargs(
external_id: str,
*,
body: float | None | Unset = UNSET,
) -> dict[str, Any]:
headers: dict[str, Any] = {}
_kwargs: dict[str, Any] = {
"method": "patch",
"url": "/api/helloworlduser/{external_id}/something".format(external_id=quote(str(external_id), safe=""),),
}
else:
_kwargs["json"] = body
headers["Content-Type"] = "application/json"
_kwargs["headers"] = headers
return _kwargs
def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> UserReadDTO | None:
if response.status_code == 200:
response_200 = UserReadDTO.from_dict(response.json())
return response_200
if client.raise_on_unexpected_status:
raise errors.UnexpectedStatus(response.status_code, response.content)
else:
return None
def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[UserReadDTO]:
return Response(
status_code=HTTPStatus(response.status_code),
content=response.content,
headers=response.headers,
parsed=_parse_response(client=client, response=response),
)
def sync_detailed(
external_id: str,
*,
client: AuthenticatedClient | Client,
body: float | None | Unset = UNSET,
) -> Response[UserReadDTO]:
""" Update user
Args:
external_id (str):
body (float | None | Unset):
Raises:
errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:
Response[UserReadDTO]
"""
kwargs = _get_kwargs(
external_id=external_id,
body=body,
)
response = client.get_httpx_client().request(
**kwargs,
)
return _build_response(client=client, response=response)
def sync(
external_id: str,
*,
client: AuthenticatedClient | Client,
body: float | None | Unset = UNSET,
) -> UserReadDTO | None:
""" Update user
Args:
external_id (str):
body (float | None | Unset):
Raises:
errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:
UserReadDTO
"""
return sync_detailed(
external_id=external_id,
client=client,
body=body,
).parsed
async def asyncio_detailed(
external_id: str,
*,
client: AuthenticatedClient | Client,
body: float | None | Unset = UNSET,
) -> Response[UserReadDTO]:
""" Update user
Args:
external_id (str):
body (float | None | Unset):
Raises:
errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:
Response[UserReadDTO]
"""
kwargs = _get_kwargs(
external_id=external_id,
body=body,
)
response = await client.get_async_httpx_client().request(
**kwargs
)
return _build_response(client=client, response=response)
async def asyncio(
external_id: str,
*,
client: AuthenticatedClient | Client,
body: float | None | Unset = UNSET,
) -> UserReadDTO | None:
""" Update user
Args:
external_id (str):
body (float | None | Unset):
Raises:
errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:
UserReadDTO
"""
return (await asyncio_detailed(
external_id=external_id,
client=client,
body=body,
)).parsed
which is a complete broken file (see the else in get_kwargs).
Desktop (please complete the following information):
- OS: mac os
- Python Version: 3.14
- openapi-python-client version: 0.28.3
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Reproduza o problema com o trecho de OpenAPI fornecido usando openapi-python-client 0.28.3 e, em seguida, rastreie a geração do corpo da requisição para schemas primitivos nullable. O payload não nomeia nenhum arquivo do repositório nem teste; o trabalho estará concluído quando o módulo de endpoint gerado for sintaticamente válido e lidar com o corpo da requisição primitivo sem o else órfão mostrado no relatório.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- openapi, python
- Domínio
- tooling
- Tipo de issue
- Bug
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Status de atividade
- Pouca atividade
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 55/100