openapi-generators / openapi-generators/openapi-python-client

Missing typehint of File payload for async requests

Aberta
#1,239 0 comentários 0 reações 0 responsáveis Ver no GitHub

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

LOW PRIORITY

If an API provides an "upload_file" endpoint, when using async, one has to use an asynchronous way to open a file.

Using anyio from httpx, it would require an "AsyncFile" object:
https://github.com/agronholm/anyio/blob/2a63fd0bef1575e583c4cf63cebe7d76a218c83e/src/anyio/_core/_fileio.py#L38C49-L39C5

This doesn't match with File payload typehint:
openapi_python_client/templates/types.py.jinja, line 25
and results with an incorrect IDE warning.

OpenAPI Spec File
https://github.com/openapi-generators/openapi-python-client/blob/main/openapi_python_client/templates/types.py.jinja#L25

Example async usage:

def send_file(client: AuthenticatedClient, my_filepath: str):
    async with await anyio.open_file(my_filepath, mode="rb") as async_file:
        file = types.File(async_file, my_filepath, "text/html; charset=utf-8")
        return await upload.asyncio(client=client, body=file)

(This works fine, but IDE will complain about async_file type)

Desktop (please complete the following information):

  • OS: Ubuntu 22.04
  • Python Version: 3.11
  • openapi-python-client version: 0.24.1

Additional context

Quick solution:

@define
class File:
    """ Contains information for file uploads """

    payload: BinaryIO | AsyncFile
    file_name: Optional[str] = None
    mime_type: Optional[str] = None

But:
Running upload.asyncio function with payload of type BinaryIO will result in the following exception:
Runtime Error: Attempted to send an sync request with an AsyncClient instance.

So, to prevent users from getting this a little bit misleading exception, they should get an IDE warning. To do that, asyncio functions should require a different type of payload than sync, when it comes to IO objects:

@define
class File:
    """ Contains information for file uploads """

    payload: BinaryIO
    file_name: Optional[str] = None
    mime_type: Optional[str] = None

[.....]

from anyio import AsyncFile

@define
class AsyncFile_:
    """ Contains information for file uploads """

    payload: AsyncFile
    file_name: Optional[str] = None
    mime_type: Optional[str] = None

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece por openapi_python_client/templates/types.py.jinja na linha 25 e inspecione como os tipos de payload de arquivo são usados pelas funções de upload síncronas e asyncio geradas. Compare os casos BinaryIO e anyio AsyncFile descritos na issue; considera-se concluído quando as dicas de tipo geradas distinguirem o payload válido para cada estilo de requisição e evitarem orientações enganosas da IDE.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python
Domínio
developer-experience, tooling
Tipo de issue
Bug
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
45/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.