Disable prettyPrint by default for Google Sheets API responses

Aberta Para iniciantes
#2,788 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
68/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Pouca atividade
Stack de tecnologia
python
Domínio
api

Direção de pesquisa

Localize o documento de discovery da Sheets API no repositório e procure o parâmetro prettyPrint e seu valor padrão. Altere o valor padrão documentado para false, preservando um valor explícito fornecido pelo chamador, e execute a suíte de testes relevante ou os testes do documento de discovery para verificar se as solicitações usam prettyPrint=false por padrão.

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

Descrição

Large Google Sheets API responses are currently pretty-printed by default. For machine-to-machine use, the additional whitespace and line breaks provide no benefit while increasing response size and I/O. When processing large responses, this can also contribute to unnecessary memory usage.

Describe the solution you'd like

Change the default value of prettyPrint from true to false for the Sheets API discovery document
and send prettyPrint=false unless the caller says otherwise.

Describe alternatives you've considered

The current workaround is to explicitly pass prettyPrint=False to every request. This works, but requires application code to opt out of an unnecessary default and is easy to miss, especially in codebases making many Sheets API requests.

Another option would be to modify the client code to inject prettyPrint=False, but changing the API discovery document's default seems simpler and more consistent with the intended API behavior.

Additional context

This is particularly relevant for applications processing large Sheets responses programmatically. Avoiding pretty printing would reduce the amount of data transferred and processed, as well as the memory required to hold the response in memory. For large responses, this can also help reduce peak process RSS.

As a bonus, this would make the default more appropriate for API clients, where responses are consumed programmatically rather than displayed directly to users.

Linguagem predominante
Python
Estrelas
8.9k
Forks
2.6k
Merge médio
2d 2h
PRs com merge (30d)
15

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.

Mais de googleapis/google-api-python-client

Todas as issues de googleapis/google-api-python-client

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

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