Skip to main content

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

Credentials →


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

  1. Python version >= 2.7.
  2. If using Ark runtime (byteplussdkarkruntime), Python version >= 3.6 is required.

Table of Contents

  1. Credentials — AK/SK, STS, AssumeRole, OIDC, SAML, ECS Role, Default Chain
  2. Endpoint Configuration — Custom Endpoint, RegionId, Automatic Resolution
  3. Transport — HTTP Connection Pool, HTTPS Scheme, SSL Verification, HTTP(S) Proxy
  4. Timeout — Request Timeout Configuration
  5. Retry — Retry Strategy, Backoff Strategy
  6. Error Handling — Exception Handling
  7. Debugging — Debug Mode, Log Output
  8. 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.65

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for byteplus-python-sdk-v2 3.0.65
File Interpreter ABI Platform Actions
byteplus_python_sdk_v2-3.0.65-py2.py3-none-any.whl Python 2, Python 3 none any Details for byteplus_python_sdk_v2-3.0.65-py2.py3-none-any.whl

Release files / byteplus_python_sdk_v2-3.0.65-py2.py3-none-any.whl

Download URL byteplus_python_sdk_v2-3.0.65-py2.py3-none-any.whl
Size 8.1 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
f99655a089fb9ab7359a0e8df67435b9519c371cb7bd9d39f2bfb97bb6d92a23
BLAKE2b-256 checksum
How to use checksums
5a7ea6cc78783226c940061d7a88e8472a61ba22befe6f778224ea90e66ff2a6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.2

Security for byteplus-python-sdk-v2 3.0.65

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

3.0.65 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page