Lack of built-in retry mechanism for handling transient network errors and rate limits
還沒有人認領這個 Issue。
評估
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 新手友好度
- 38/100
- Issue 類型
- 功能
- 描述清晰度
- 基本清楚
- 活躍度
- 冷清
- 技術堆疊
- python
研究方向
Read the synchronous and asynchronous client constructors and the HTTP request paths for Client, AsyncClient, OauthClient, and AsyncOauthClient. Check how the SDK handles network errors, response status codes, and Retry-After headers, then identify the tests covering those paths. Done means opt-in retries work across all four clients with backoff, jitter, rate-limit handling, and the stated defaults.
由索引模型根據 Issue 內容生成。
描述
Currently, the OpenAPI Python SDK is designed with low-level HTTP primitives. If an API request fails due to a transient error, the client raises an error or fails immediately:
- Transient Network Errors: Minor network drops, socket timeouts, or DNS hiccups fail immediately.
- Temporary Server Overloads: Gateway errors (HTTP
502 Bad Gateway,503 Service Unavailable,504 Gateway Timeout) trigger immediate crashes. - Rate Limits (HTTP 429): If the client hits API rate limits, it fails instantly rather than waiting for the reset window.
To handle these scenarios, developers using the SDK must write custom retry loops and catch blocks in their application code, leading to unnecessary boilerplate.
Proposed Feature
Implement an optional, built-in retry mechanism for both synchronous and asynchronous clients (Client, AsyncClient, OauthClient, and AsyncOauthClient).
This retry mechanism should feature:
- Exponential Backoff: Gradually increase wait times between retries (e.g. wait 1s, then 2s, then 4s) to give the server time to recover.
- Jitter (Randomized Noise): Add random variation to the sleep durations to prevent multiple clients from hitting the server at the exact same millisecond.
- Smart Rate-Limit Handling: Automatically detect HTTP 429 status codes, parse the
Retry-Afterheader if available, and sleep for the requested duration before retrying. - Customizable Configuration: Allow developers to configure the retries during client initialization, with safe defaults.
Proposed API Design
Add optional retry parameters to the client constructors:
client = Client(
token="your_token",
max_retries=3, # Number of retry attempts (0 to disable)
backoff_factor=1.0, # Multiplier for exponential sleep delay
retry_on_status=[429, 502, 503, 504] # Status codes that trigger a retry
)
To ensure 100% backward compatibility, max_retries should default to 0 (disabled), ensuring no existing production code or tests are affected unless the developer explicitly opts in.
Benefits
- Resilience: SDK handles transient internet drops and brief server downtime gracefully.
- Ease of Use: Reduces boilerplate code in the consumer's application.
- Backward-Compatible: Defaulting
max_retriesto0guarantees existing behavior is preserved.
- 主要語言
- Python
- 星號
- 18
- 分支
- 4
- PR 合併指標
- 30 天內沒有已合併 PR
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 沒有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
openapi/openapi-python-sdk 的其他 Issue
-
Rename package to openapi-sdk (PyPI approval in progress)可能已有人在做 @francescobianco 於 107 天前認領。 未關閉
難度 1/5 1 小時以內 新手友好度 15/100
-
難度 4/5 1-2 天 新手友好度 56/100
-
難度 4/5 3-5 天 新手友好度 42/100
-
難度 4/5 3-5 天 新手友好度 42/100
-
good first issue help wanted
難度 2/5 1-3 小時 新手友好度 55/100
openapi/openapi-python-sdk#9 · 7 則留言 ·
查看 openapi/openapi-python-sdk 的全部 Issue
相似的 Issue
-
documentation pkg: sphinx-needs
難度 1/5 1 小時以內 新手友好度 82/100
useblocks/sphinx-needs#2255 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 60/100
home-assistant/core#186538 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 72/100
btclib-org/btclib-secp256k1#1181 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 65/100
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 78/100
pyrite-wiki/pyrite#917 ·
維護者通常 1 天內回覆