Async Baidu Disk SDK - 百度网盘异步 Python SDK
Project description
abdds
Async Baidu Disk SDK - 简单、有效、报错清晰的百度网盘异步 Python SDK。
基于 百度网盘开放平台 API 封装,核心依赖 httpx + aiofiles,全面异步化。
安装
pip install abdds
要求 Python 3.9+。
快速开始
1. 获取应用凭证
在 百度网盘开放平台 创建应用,获取 client_id、client_secret 和 app_name。
2. 初始化客户端
from pathlib import Path
from abdds import AsyncBaiduPanClient
async with AsyncBaiduPanClient(
client_id="your_client_id",
client_secret="your_client_secret",
app_name="your_app_name",
) as client:
if not client.is_authenticated:
print(f"请在浏览器打开: {client.auth_url}")
code = input("请输入授权码: ")
await client.fetch_token(code)
Token 会自动保存到 ~/.baidupan/ 目录,下次启动无需重新授权。
3. 使用 API
# 查询空间配额
q = await client.quota()
print(f"已用: {q.used / 1024**3:.1f} GB / 总计: {q.total / 1024**3:.1f} GB")
# 上传文件 - 支持 Path / bytes / Generator / AsyncGenerator
result = await client.upload(Path("local_file.txt"))
result = await client.upload(Path("data.bin"), remote_path="/backup/data.bin")
result = await client.upload(b"hello world", remote_path="/hello.txt")
# 获取文件元信息
metas = await client.file_metas([result.fs_id])
dlink = metas[0].dlink
# 下载文件到本地路径
await client.download_to_file(dlink, Path("downloaded.txt"))
# 流式下载(适合大文件或自定义处理)
async for chunk in client.download_stream(dlink):
process(chunk)
# 带断点续传的流式下载
async for chunk in client.download_stream_with_range(dlink, range=(1024, None)):
process(chunk)
# 列出文件
items = await client.list_files("/apps/your_app_name/")
for item in items:
print(f"{'[DIR]' if item.is_dir else ' '} {item.filename} ({item.size} bytes)")
# 删除文件
await client.delete(["/apps/your_app_name/old_file.txt"])
或使用异步工厂方法:
client = await AsyncBaiduPanClient.create(client_id, client_secret, app_name)
q = await client.quota()
await client.close()
API 参考
AsyncBaiduPanClient
| 方法 | 说明 |
|---|---|
await upload(source, remote_path="") |
异步上传数据。source 支持 Path / bytes / Generator[bytes] / AsyncGenerator[bytes];remote_path 为远程路径字符串 |
await download_to_file(dlink, local_path, *, chunk_size=1048576) |
下载文件到本地路径,返回 Path |
download_stream(dlink, *, chunk_size=1048576) |
异步流式下载,返回 AsyncGenerator[bytes] |
download_stream_with_range(dlink, range, *, chunk_size=1048576, max_retries=5) |
带断点续传的异步流式下载,range 为 (start, end) 元组 |
await quota() |
获取空间配额,返回 ApiQuotaInfo |
await file_metas(fsids) |
获取文件元信息(含 dlink),返回 list[ApiFileMeta] |
await list_files(path="/") |
列出目录文件,返回 list[ApiFileListItem] |
await delete(paths) |
批量删除文件 |
await fetch_token(code) |
通过授权码获取 Token |
await refresh_token() |
刷新 Token |
is_authenticated |
是否已认证(属性) |
await close() |
关闭客户端 |
异常体系
BaiduPanError
├── BaiduPanNetworkError # 网络通信异常
├── BaiduPanAPIError # API 业务异常 (errno, errmsg, request_id)
└── TokenExpiredError # Token 过期或无效
所有异常均继承自 BaiduPanError,方便统一捕获。
特性
- 全面异步 — 基于 httpx + aiofiles,原生 async/await
- 自动重试 — 网络请求自动重试(可配置次数)
- Token 管理 — 自动持久化、自动刷新、文件权限限制
- 分片上传 — 大文件自动分片上传(4MB 分片)
- 流式下载 — 支持断点续传、Range 分片、指数重试
- 类型安全 — 完整类型标注,支持 PEP 561 (
py.typed) - 报错清晰 — 异常包含
errno、errmsg、request_id、url等上下文
与同步版本 bdds 的差异
| 特性 | bdds (同步) | abdds (异步) |
|---|---|---|
| HTTP 客户端 | requests | httpx |
| 文件 I/O | 内置 open | aiofiles |
| 上下文管理器 | with / __enter__ |
async with / __aenter__ |
| 上传数据源 | Path / bytes / Generator | Path / bytes / Generator / AsyncGenerator |
| 下载返回 | Generator[bytes] | AsyncGenerator[bytes] |
| Token 回调 | 同步函数 | 异步函数 |
| 测试 mock | responses | respx |
开发
# 安装开发依赖
pip install -e ".[dev]"
# 运行测试
python -m pytest -v
# 构建
python -m build
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
abdds-0.2.0.tar.gz
(25.0 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
abdds-0.2.0-py3-none-any.whl
(18.6 kB
view details)
File details
Details for the file abdds-0.2.0.tar.gz.
File metadata
- Download URL: abdds-0.2.0.tar.gz
- Upload date:
- Size: 25.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a7adba319b9223f193da04a63dc1880b198bad53b1c2abaa59c93fd277f05fa4
|
|
| MD5 |
8e8e63d44adc0ff11f9ca6a60f8e8a43
|
|
| BLAKE2b-256 |
44db25f7dbca8b402794e2d243bdc5adc2241b9d22e6fa67216fae2588bdc334
|
File details
Details for the file abdds-0.2.0-py3-none-any.whl.
File metadata
- Download URL: abdds-0.2.0-py3-none-any.whl
- Upload date:
- Size: 18.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
10eb455ca02a83c321da9db528aee1175d1bdb538ea5325ab12a1a920c501aa3
|
|
| MD5 |
daac2be3d49e2c6bc6d038b38e429295
|
|
| BLAKE2b-256 |
0486d1cb10a901b71405e97a28cdc70710f21d3b200ed188358d376a369aaeee
|