Title: Option to skip per-method docstring generation in build() (memory / high-concurrency) · Issue #2779 · googleapis/google-api-python-client · GitHub
Open Graph Title: Option to skip per-method docstring generation in build() (memory / high-concurrency) · Issue #2779 · googleapis/google-api-python-client
X Title: Option to skip per-method docstring generation in build() (memory / high-concurrency) · Issue #2779 · googleapis/google-api-python-client
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 atta...
Open Graph 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 o...
X 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 o...
Opengraph URL: https://github.com/googleapis/google-api-python-client/issues/2779
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Option to skip per-method docstring generation in build() (memory / high-concurrency)","articleBody":"## Feature request: an option to skip per-method docstring generation in `build()`\n\n### Problem\n\n`build()` (and lazy sub-resource construction) generates a fully-expanded, recursively\npretty-printed prototype of each method's **response schema** and attaches it as\n`method.__doc__` (`discovery.createMethod` → `schema.Schemas.prettyPrintSchema` /\n`prettyPrintByName`). For APIs with large, deeply-nested schemas this is very expensive, and it\nis paid **every time a service/resource is constructed**.\n\nConcrete numbers from profiling Sheets v4 (`google-api-python-client==2.198.0`, Python 3.13),\nmeasured with RSS (no tracemalloc, to avoid its overhead):\n\n- Building the service, then touching one sub-resource (`service.spreadsheets()`, **no API\n call**): **~66 MB**.\n- Of that, ~99.9% is the docstring schema expansion — no-oping `prettyPrintSchema`/\n `prettyPrintByName` drops it to **~1 MB**. The `.spreadsheets()` methods themselves are ~24 KB.\n- The docstrings are only useful for interactive `help()`; in a server they are never read.\n\n### Impact\n\nIn a concurrent server (a fresh service built per request, common with per-user credentials),\nthese allocations are **not shared** across in-flight requests. 8 concurrent Sheets requests\neach build ~66 MB of docstrings simultaneously ≈ **530 MB peak**, which OOM-kills a\nmemory-limited container. This is the concurrent-peak sibling of the long-standing\nreference-cycle memory issue in #535 (whose recommended fix — build/reuse a single service — is\nnot always feasible when credentials differ per request).\n\n### Request\n\nA supported way to skip docstring generation at build time, e.g.:\n\n```python\nbuild(\"sheets\", \"v4\", credentials=creds, generate_docstrings=False)\n# or a module/env toggle\n```\n\nToday the only options are to monkeypatch `Schemas.prettyPrintSchema`/`prettyPrintByName`\n(fragile across versions) or fork. A first-class flag would let memory-constrained / high-\nconcurrency deployments opt out of documentation strings they never use.\n\n### Environment\n\n- `google-api-python-client==2.198.0`, Python 3.13\n- Reproly: build any large-schema API (Sheets v4), touch a sub-resource, measure RSS; repeat\n concurrently to see the multiplier.\n\nRelated: #535 (memory from repeated `build()` / reference cycles).\n","author":{"url":"https://github.com/walkingpendulum","@type":"Person","name":"walkingpendulum"},"datePublished":"2026-07-21T18:18:34Z","url":"https://github.com/googleapis/google-api-python-client/issues/2779"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:4a7f253f-7ca0-ee4a-b095-c1720eabca76 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | E572:21149E:58B0F8:7A15E4:6B00934C |
| html-safe-nonce | e0c5372a239e516dc8a8083b3baf4b38cd8966edff1efe8c714acaaace3ae169 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJFNTcyOjIxMTQ5RTo1OEIwRjg6N0ExNUU0OjZCMDA5MzRDIiwidmlzaXRvcl9pZCI6IjM1Nzk4ODYzNTQ3MzEyMjEyNCIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 500caf2a87071e8583eedcaf18443dabaaea497fcdf1ba80acc4003e9613066d |
| hovercard-subject-tag | issue:4941857464 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/googleapis/google-api-python-client/2779/issue_layout |
| twitter:image | https://opengraph.githubassets.com/d5cbf9645e9f50027ab130e88aa4b3e0cdfb551edd8135200dc6c020004d0e63/googleapis/google-api-python-client/issues/2779 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/d5cbf9645e9f50027ab130e88aa4b3e0cdfb551edd8135200dc6c020004d0e63/googleapis/google-api-python-client/issues/2779 |
| og:image:alt | 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 o... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | walkingpendulum |
| hostname | github.com |
| expected-hostname | github.com |
| None | c710a5cb5c47be60abfe6e8410436d409906979dbed614ef09f29c60f5535b08 |
| turbo-cache-control | no-preview |
| go-import | github.com/googleapis/google-api-python-client git https://github.com/googleapis/google-api-python-client.git |
| octolytics-dimension-user_id | 16785467 |
| octolytics-dimension-user_login | googleapis |
| octolytics-dimension-repository_id | 15749269 |
| octolytics-dimension-repository_nwo | googleapis/google-api-python-client |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 15749269 |
| octolytics-dimension-repository_network_root_nwo | googleapis/google-api-python-client |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | be616a2a6ec1c609d6e002896dff5352d5c5f28b |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width