Disable prettyPrint by default for Google Sheets API responses
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 68/100
Línea de trabajo
Localiza el documento de descubrimiento de Sheets API en el repositorio y busca el parámetro prettyPrint y su valor predeterminado. Cambia el valor predeterminado documentado a false, conservando un valor explícito proporcionado por el llamador, y ejecuta después la suite de pruebas relevante o las pruebas del documento de descubrimiento para verificar que las solicitudes usen prettyPrint=false de forma predeterminada.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- Python
- Estrellas
- 8.9k
- Forks
- 2.6k
- Merge medio
- 2 d 2 h
- PR fusionados (30 d)
- 15
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de googleapis/google-api-python-client
-
test: connection leak test test_discovery_http_is_closed is shadowed and syntactically invalid Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 92/100
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 1/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 52/100
-
samples type: docs
Dificultad 3/5 1-2 días Aptitud para principiantes 52/100
Todos los issues de googleapis/google-api-python-client
Issues similares
-
documentation help wanted
Dificultad 2/5 1-3 horas Aptitud para principiantes 90/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 90/100
simonw/sqlite-utils#872 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100