Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Option to skip per-method docstring generation in build() (memory / high-concurrency)

Abierto
  • ¿Algo no está bien?
#2,779 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
52/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
python
Área
api, backend

Línea de trabajo

Comienza en build() y sigue discovery.createMethod, schema.Schemas.prettyPrintSchema y prettyPrintByName para ver dónde se generan los docstrings de response-schema durante la construcción de servicios y subrecursos perezosos. Reproduce el perfil de memoria de Sheets v4 descrito en el issue; el trabajo estará terminado cuando una opción de tiempo de compilación compatible omita esa generación sin afectar a la construcción normal cuando esté habilitada.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Feature request: an option to skip per-method docstring generation in build()

Problem

build() (and lazy sub-resource construction) generates a fully-expanded, recursively
pretty-printed prototype of each method's response schema and attaches it as
method.__doc__ (discovery.createMethod → schema.Schemas.prettyPrintSchema /
prettyPrintByName). For APIs with large, deeply-nested schemas this is very expensive, and it
is paid every time a service/resource is constructed.

Concrete numbers from profiling Sheets v4 (google-api-python-client==2.198.0, Python 3.13),
measured with RSS (no tracemalloc, to avoid its overhead):

  • Building the service, then touching one sub-resource (service.spreadsheets(), no API
    call    ): ~66 MB.
  • Of that, ~99.9% is the docstring schema expansion — no-oping prettyPrintSchema/
    prettyPrintByName drops it to ~1 MB. The .spreadsheets() methods themselves are ~24 KB.
  • The docstrings are only useful for interactive help(); in a server they are never read.
Impact

In a concurrent server (a fresh service built per request, common with per-user credentials),
these allocations are not shared across in-flight requests. 8 concurrent Sheets requests
each build ~66 MB of docstrings simultaneously ≈ 530 MB peak, which OOM-kills a
memory-limited container. This is the concurrent-peak sibling of the long-standing
reference-cycle memory issue in #535 (whose recommended fix — build/reuse a single service — is
not always feasible when credentials differ per request).

Request

A supported way to skip docstring generation at build time, e.g.:

build("sheets", "v4", credentials=creds, generate_docstrings=False)
# or a module/env toggle

Today the only options are to monkeypatch Schemas.prettyPrintSchema/prettyPrintByName
(fragile across versions) or fork. A first-class flag would let memory-constrained / high-
concurrency deployments opt out of documentation strings they never use.

Environment
  • google-api-python-client==2.198.0, Python 3.13
  • Reproly: build any large-schema API (Sheets v4), touch a sub-resource, measure RSS; repeat
    concurrently to see the multiplier.

Related: #535 (memory from repeated build() / reference cycles).

Lenguaje dominante
Python
Estrellas
8.9k
Forks
2.6k
Merge medio
1 d 10 h
PR fusionados (30 d)
16

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de googleapis/google-api-python-client

Todos los issues de googleapis/google-api-python-client

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.