guangyapan client

guangyapan 是一个 光鸭网盘 的 Python 客户端模块，不过仅提供最直接的接口包装。

支持同步和异步操作，全面封装了各种接口。

安装

你可以从 pypi 安装最新版本

pip install -U guangyapan

或者从 github 安装最新版本

pip install -U git+https://github.com/ChenyangGao/guangyapan@main

入门介绍

1. 导入模块

导入模块

from guangyapan import GuangyaPanClient

2. 创建实例

创建客户端对象，可以传入 access_token 和 refresh_token，如果不传，就自己调用 GuangyaPanClient.login() 方法登录

1. 用 refresh_token 创建实例

refresh_token = "..."
client = GuangyaPanClient(refresh_token)
# NOTE: 立即刷新一个访问令牌出来
client.refresh_access_token()

2. 用 access_token 创建实例

access_token = "..."
client = GuangyaPanClient(access_token)
# NOTE: 底层会在检测到 refresh_token 缺失，然后用这个 access_token 授权登录然后获取新的 access_token 和 refresh_token
client.refresh_access_token()

3. 手动登录

client = GuangyaPanClient()
# NOTE: 命令行等待扫码登录
client.login()

# 或者提供手机号，则会发送验证码登录
mobile = "+86 xxxxxxxxxxx"
client.login(mobile)

3. 接口调用

我推荐你选择 ipython 作为执行环境，可以交互式地执行代码和分析结果

所有需要直接或间接执行 HTTP 请求的接口，都有同步和异步的调用方式

# 同步调用
client.method(payload)
client.method(payload, async_=False)

# 异步调用
await client.method(payload, async_=True)

它们都能接受一个参数 request，具体要求可以查看 guangyapan.request 的文档。我也封装了一些模块, 它们都能提供一个符合要求的 request 函数。更一般的实现，可以参考 python-http_request。

1. aiohttp_client_request
2. aiosonic_request
3. asks_request
4. blacksheep_client_request
5. curl_cffi_request
6. http_client_request
7. httpcore_request
8. httpx_request
9. niquests_request
10. pycurl_request
11. python-urlopen
12. requests_request
13. tornado_client_request
14. urllib3_request
15. urllib3_future_request

注意：从根本上讲，所有接口的封装，最终都会调用 GuangyaPanClient.request

4. 检查响应

接口被调用后，如果返回的是 dict 类型的数据（说明原本是 JSON），则可以用 guangyapan.check_response 执行检查。首先会查看其中名为 "state" 的键的对应值，如果为 True、1 或不存在，则原样返回被检查的数据；否则，"state" 的对应值大概是 False 或 0，说明有问题出现，会根据实际情况抛出一个异常，但都是 guangyapan.P115OSError 的实例。

from guangyapan import check_response

# 检查同步调用
data = check_response(client.method(payload))

# 检查异步调用
data = check_response(await client.method(payload, async_=True))
# 或者
data = await check_response(client.method(payload, async_=True))

5. 辅助工具

一些简单的封装工具可能是必要的，特别是那种实现起来代码量比较少，可以封装成单个函数的。我把平常使用过程中，积累的一些经验具体化为一组工具函数。这些工具函数分别有着不同的功能，如果组合起来使用，或许能解决很多问题。

from guangyapan import tool