Option to skip per-method docstring generation in build() (memory / high-concurrency)
Les mainteneurs répondent en général sous 1 jour
Évaluation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Accessibilité débutants
- 52/100
Piste de recherche
Commencez par build() et suivez discovery.createMethod, schema.Schemas.prettyPrintSchema et prettyPrintByName pour voir où les chaînes de documentation de response-schema sont générées lors de la construction des services et des sous-ressources lazy. Reproduisez le profil mémoire de Sheets v4 décrit dans l’issue ; le travail est terminé lorsqu’une option de build prise en charge ignore cette génération sans affecter la construction normale lorsqu’elle est activée.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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/
prettyPrintByNamedrops 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).
- Langage dominant
- Python
- Étoiles
- 8.9k
- Forks
- 2.6k
- Merge moyen
- 8 h 37 min
- PR mergées (30 j)
- 7
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de googleapis/google-api-python-client
-
Disable prettyPrint by default for Google Sheets API responsesPeut-être pris @pawciobiel l’a pris il y a 62 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
googleapis/google-api-python-client#2788 ·
Les mainteneurs répondent en général sous 1 jour
-
test: connection leak test test_discovery_http_is_closed is shadowed and syntactically invalidPeut-être pris @Capstan l’a pris il y a 137 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
googleapis/google-api-python-client#2757 ·
Les mainteneurs répondent en général sous 1 jour
-
test: strict positional parameter enforcement is ignored under pytestPeut-être pris @Capstan l’a pris il y a 137 jours. Ouverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 92/100
googleapis/google-api-python-client#2755 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 35/100
googleapis/google-api-python-client#2825 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
Audit samples and docs for references to old APIs (like G+).Peut-être pris @Mudassir55 l’a pris il y a 123 jours. Ouvertesamples type: docs
Difficulté 3/5 1-2 jours Accessibilité débutants 52/100
googleapis/google-api-python-client#2754 ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de googleapis/google-api-python-client
Issues similaires
-
`burr` fails to start when the Python path has a space in itPeut-être pris @enekoreto l’a pris aujourd’hui. Ouvertestatus/needs-triage
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
Les mainteneurs répondent en général sous 5 jours
-
gemini 出现了新的域名需要加入Ouverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 72/100
-
Difficulté 2/5 Une demi-journée Accessibilité débutants 72/100
debpalash/VoiceStudio#2903 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
dagster-io/community-integrations#367 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 74/100
aws-samples/sample-per-model-bedrock#243 ·
Les mainteneurs répondent en général sous 1 jour