Skip to content

Commit 98df6fb

Browse files
Merge 'feat/add-known-issue' into 'master'
feat: add known issue See merge request: !1030
2 parents 8fb62ad + cdd01a7 commit 98df6fb

File tree

2 files changed

+46
-0
lines changed

2 files changed

+46
-0
lines changed

README.EN.MD

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,28 @@
11
English | [中文](README.md)
22

33
# Volcengine SDK for Python
4+
## ⚠️ Known Issue (Historical Versions)
5+
6+
In some historical versions of **volcengine-python-sdk** (**4.0.1 – 4.0.42**, inclusive), the SDK’s built-in retry mechanism has a defect.
7+
8+
When a request encounters an exception (such as network instability or API errors), the SDK may trigger its retry logic internally; however, due to this defect, the retry does not take effect as expected. As a result, the client may still experience the exception from the initial request, and the retry mechanism cannot effectively improve request success rates.
9+
10+
### Affected Versions
11+
12+
- **SDK**: volcengine-python-sdk
13+
- **Versions**: 4.0.1 – 4.0.42 (inclusive)
14+
15+
### Impact
16+
17+
For applications that rely on the SDK’s retry mechanism to handle transient failures or network instability:
18+
19+
- Actual request availability may be lower than expected
20+
- Retry configurations may not function as intended
21+
22+
### Resolution and Recommendation
23+
24+
This issue has been fixed in **version 4.0.43 and above**.
25+
**We strongly recommend all users upgrade to volcengine-python-sdk ≥ 4.0.43** to ensure the retry mechanism functions correctly in exception scenarios.
426

527
## Breaking Change Notice
628

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,30 @@
22

33
# Volcengine SDK for Python
44

5+
## ⚠️ 已知缺陷说明(历史版本)
6+
7+
**volcengine-python-sdk** 的部分历史版本(**4.0.1 ~ 4.0.42,含**)中,发现 SDK 内置的重试机制存在缺陷。
8+
9+
当请求过程中出现异常(如网络抖动、接口返回错误等)时,SDK 虽会触发重试逻辑,但由于该缺陷,重试未能实际生效,客户端仍可能直接感知到首次请求异常,导致重试机制无法有效提升请求成功率。
10+
11+
### 影响范围
12+
13+
- **SDK**:volcengine-python-sdk
14+
- **受影响版本**:4.0.1 ~ 4.0.42(含)
15+
16+
### 影响说明
17+
18+
对于依赖 SDK 内置重试机制来应对瞬时异常或网络不稳定场景的业务:
19+
20+
- 实际请求可用性可能低于预期
21+
- 重试相关配置无法发挥应有的保障作用
22+
23+
### 解决方案与建议
24+
25+
该问题已在 **4.0.43 及以上版本**中修复。
26+
**强烈建议所有用户升级至 volcengine-python-sdk ≥ 4.0.43**,以确保请求重试机制在异常场景下能够正常生效。
27+
28+
529
## 非兼容升级通知
630

731
Volcengine SDK for Python 非兼容升级通知

0 commit comments

Comments
 (0)