byteplus SDK for Python
⚠️ 已知缺陷说明(历史版本)
在 byteplus-python-sdk-v2 的部分历史版本(3.0.1 ~ 3.0.23,含)中,发现 SDK 内置的重试机制存在缺陷。
当请求过程中出现异常(如网络抖动、接口返回错误等)时,SDK 虽会触发重试逻辑,但由于该缺陷,重试未能实际生效,客户端仍可能直接感知到首次请求异常,导致重试机制无法有效提升请求成功率。
影响范围
- SDK:byteplus-python-sdk-v2
- 受影响版本:3.0.1 ~ 3.0.23(含)
影响说明
对于依赖 SDK 内置重试机制来应对瞬时异常或网络不稳定场景的业务:
- 实际请求可用性可能低于预期
- 重试相关配置无法发挥应有的保障作用
解决方案与建议
该问题已在 3.0.24 及以上版本中修复。
强烈建议所有用户升级至 byteplus-python-sdk-v2 ≥ 3.0.24,以确保请求重试机制在异常场景下能够正常生效。
非兼容升级通知
Byteplus SDK for Python 非兼容升级通知
影响版本:2.0.1 以及后续版本
变更描述:
从 2.0.1 版本开始,发起请求将默认从使用 HTTP 协议变成使用 HTTPS 协议,请升级到新版本的用户注意是否会产生兼容性风险,做好充分测试。如需继续使用
HTTP 协议,请在发起请求时指定 scheme 参数为 http(不推荐):
import byteplussdkcore
configuration = byteplussdkcore.Configuration()
configuration.scheme = 'http'
Table of Contents
- Requirements
- Install
- Usage
Requirements
Python version >=2.7。
Install
Install via pip
pip install byteplus-python-sdk-v2
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install to install the package for all users)
Usage
1:config Configuration
configuration = byteplussdkcore.Configuration()
configuration.client_side_validation = True
configuration.schema = "http"
configuration.debug = False
configuration.logger_file = "sdk.log"
byteplussdkcore.Configuration.set_default(configuration)
SDK Documentation
SDK Integration
When calling APIs, it is recommended to integrate the SDK in your project. Using the SDK simplifies development, speeds up integration, and reduces long-term maintenance costs.
Requirements
- Python version >= 2.7.
- If using Ark runtime (
byteplussdkarkruntime), Python version >= 3.6 is required.
Table of Contents
- Credentials — AK/SK, STS, AssumeRole, OIDC, SAML, ECS Role, Default Chain
- Endpoint Configuration — Custom Endpoint, RegionId, Automatic Resolution
- Transport — HTTP Connection Pool, HTTPS Scheme, SSL Verification, HTTP(S) Proxy
- Timeout — Request Timeout Configuration
- Retry — Retry Strategy, Backoff Strategy
- Error Handling — Exception Handling
- Debugging — Debug Mode, Log Output
- Environment Variables — Environment Variable Configuration
Security and privacy
This project takes security seriously. For vulnerability reporting and supported versions, see SECURITY.md
Metadata
Release files for byteplus-python-sdk-v2 3.0.59
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| byteplus_python_sdk_v2-3.0.59.tar.gz | 4.9 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| byteplus_python_sdk_v2-3.0.59-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 23.3 MB
Release files / byteplus_python_sdk_v2-3.0.59.tar.gz
| Download URL | byteplus_python_sdk_v2-3.0.59.tar.gz |
|---|---|
| Size | 4.9 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
286513102db3869fc605e80cc786d2a3040a171306e393dbd1cc60a046203557
|
|
BLAKE2b-256 checksum How to use checksums |
6b31bff5571b920c272ddfc8a0d4fba17a89d64ed5030c758976bcf9e7d0fe1a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.11.2
|
Release files / byteplus_python_sdk_v2-3.0.59-py2.py3-none-any.whl
| Download URL | byteplus_python_sdk_v2-3.0.59-py2.py3-none-any.whl |
|---|---|
| Size | 18.4 MB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
a83c90470b5360528ad21b287e255c5fb39fd3566091d7564b0e56fc57bac661
|
|
BLAKE2b-256 checksum How to use checksums |
e5c442d062839f3a2f35950e69e720b3449af5a770ae58ea94d7ee7856e741c8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.11.2
|