Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

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

Offen
  • Stimmt etwas nicht?
#2,779 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

@rootkiller6788 arbeitet bereits daran.

Seit 21.9.2026.

  • #2822 von @rootkiller6788 — offen

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
52/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Ruhig
Tech-Stack
python
Bereich
api, backend

Rechercherichtung

Beginne bei build() und verfolge discovery.createMethod, schema.Schemas.prettyPrintSchema und prettyPrintByName, um zu sehen, wo response-schema-Dokumentstrings während der Erstellung von Services und verzögerten Subressourcen erzeugt werden. Reproduziere das im Issue beschriebene Speicherprofil von Sheets v4; die Aufgabe ist abgeschlossen, wenn eine unterstützte Build-Zeit-Option diese Erzeugung überspringt, ohne die normale Erstellung zu beeinflussen, wenn sie aktiviert ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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).

Vorherrschende Sprache
Python
Sterne
8.9k
Forks
2.6k
Ø Merge
2 T. 17 Std.
Gemergte PRs (30 T.)
10

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus googleapis/google-api-python-client

Alle Issues in googleapis/google-api-python-client

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.