Feature Request: Add Configurable Network Timeouts to HTTP Clients
還沒有人認領這個 Issue。
評估
- 難度
- 4/5
- 預估耗時
- 1-2 天
- 新手友好度
- 56/100
- Issue 類型
- 功能
- 描述清晰度
- 描述清楚
- 活躍度
- 冷清
- 技術堆疊
- python
研究方向
Start by locating the initialization methods for Client, AsyncClient, OauthClient, and AsyncOauthClient, then check how they construct or accept httpx clients. Trace the existing README.md examples and project tests for custom client behavior. Done means all four clients support the documented timeout setting, custom httpx client settings remain intact, and the updated examples are included.
由索引模型根據 Issue 內容生成。
描述
The Problem
By default, the underlying httpx HTTP library used by this SDK applies a strict 5-second timeout to all network requests.
If an API method takes longer than 5 seconds to process-for example, generating a large PDF file, querying a heavy dataset, or doing operations over a slow network connection-the SDK will unexpectedly crash with a TimeoutException.
Currently, the only way for developers to fix this is to understand how httpx works underneath, build a custom httpx.Client() object with a custom timeout, and explicitly pass it into our SDK upon initialization. This is a bit too much boilerplate work for such a common requirement.
Proposed Solution
We should add a built-in timeout parameter directly into the initialization methods of all our clients (Client, AsyncClient, OauthClient, and AsyncOauthClient), giving it a safer default limit of 30.0 seconds.
Expected behavior:
# Before: Developers had to do all this
import httpx
custom_client = httpx.Client(timeout=60.0)
client = Client(token="abc", client=custom_client)
# After: Simple, clean SDK syntax
client = Client(token="abc", timeout=60.0)
Acceptance Criteria
- Add
timeout: float = 30.0toClientandAsyncClient. - Add
timeout: float = 30.0toOauthClientandAsyncOauthClient. - Pass this parameter into the underlying
httpxclient natively. - Ensure full backward compatibility—if a user manually passes a custom
httpxclient, their settings are preserved and not overridden. - Update
README.mdand PyPI docs with code examples showing how to configure the timeout. - Verify all existing unit tests pass cleanly.
Why this matters / Benefits
- Smarter Defaults: Bumping the default timeout from 5 to 30 seconds prevents the SDK from crashing during heavier, perfectly valid API workloads.
- Better Developer Experience (DX): Allows users to configure timeouts cleanly in one line of code without needing to learn the intricacies of the underlying
httpxlibrary.
- 主要語言
- 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 3-5 天 新手友好度 38/100
openapi/openapi-python-sdk#20 · 1 則留言 ·
-
難度 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
-
approved Good First Issue scope: docs
難度 1/5 1 小時以內 新手友好度 85/100
hiero-ledger/hiero-sdk-python#2730 · 3 則留言 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 62/100
wemake-services/wemake-django-template#3178 · 1 個 reaction ·
維護者通常 1 天內回覆
-
md/asciidoc/csv: an explicit `encoding="utf-8"` keeps a leading BOM, the auto-detect path drops it未關閉
難度 2/5 1-3 小時 新手友好度 82/100
docling-project/docling#4846 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 78/100
neurostuff/NiMARE#1181 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 78/100
pytest-dev/pytest#15180 ·
維護者通常 1 天內回覆