p123client 0.0.6.9.4__tar.gz → 0.0.6.10__tar.gz

{p123client-0.0.6.9.4 → p123client-0.0.6.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: p123client
-Version: 0.0.6.9.4
+Version: 0.0.6.10
 Summary: Python 123 webdisk client.
 Home-page: https://github.com/ChenyangGao/p123client
 License: MIT
@@ -56,19 +56,29 @@ pip install -U p123client
 
 ## 1. 导入模块和创建实例
 
-导入模块
+首先导入模块
 
 ```python
 from p123client import P123Client
 ```
 
+### 1. 用 token 创建实例
+
 创建客户端对象，需要传入 JWT <kbd>token</kbd>，也就是 `access_token`
 
 ```python
+# TODO: 访问令牌
 token = "..."
+
 client = P123Client(token=token)
 ```
 
+或者直接写作
+
+```python
+client = P123Client(token)
+```
+
 不过我更推荐把 <kbd>token</kbd> 写入一个文件中，例如在 `~/123-token.txt`
 
 ```python
@@ -77,33 +87,152 @@ from pathlib import Path
 client = P123Client(token=Path("~/123-token.txt").expanduser())
 ```
 
-你也可以用账户和密码登录
+或者直接写作
+
+```python
+client = P123Client(Path("~/123-token.txt").expanduser())
+```
+
+### 2. 账号和密码登录
+
+```python
+# TODO: 手机号或者邮箱
+passport = "..." 
+# TODO: 密码
+password = "..."
+
+client = P123Client(passport=passport, password=passport)
+```
+
+或者直接写作
+
+```python
+client = P123Client(passport, passport)
+```
+
+### 3. client_id 和 client_secret 登录
+
+需要先申请成为开发者
+
+https://123yunpan.yuque.com/org-wiki-123yunpan-muaork/cr6ced/hpengmyg32blkbg8
+
+```python
+# TODO: 应用标识，创建应用时分配的 appId
+client_id = "..." 
+# TODO: 应用密钥，创建应用时分配的 secretId
+client_secret = "..."
+
+client = P123Client(client_id=client_id, client_secret=client_secret)
+```
+
+或者直接写作
 
 ```python
-passport = "..." # 手机号或者邮箱
-password = "..." # 密码
-client = P123Client(passport, password)
+client = P123Client(client_id, client_secret)
 ```
 
-它的这个 <kbd>token</kbd>，就包含了有关信息
+### 4. refresh_token 登录
 
 ```python
-from base64 import b64decode
+# TODO: 刷新令牌
+refresh_token = "..."
+
+client = P123Client(refresh_token=refresh_token)
+```
+
+或者直接写作
+
+```python
+client = P123Client(refresh_token)
+```
+
+**注意**：使用 refresh_token（或者说 oauth 登录），只允许访问 open 接口
+
+### 5. oauth 登录
+
+需要先去开发者后台设置一下回调链接，审核通过后才可用
+
+```python
+# TODO: 应用标识，创建应用时分配的 appId
+client_id = "..." 
+# TODO: 应用密钥，创建应用时分配的 secretId
+client_secret = "..."
+# TODO: 回调链接
+redirect_uri = "..."
+# TODO: 访问令牌
+token = "..."
+
+resp = P123Client.login_with_oauth(
+    client_id=client_id, 
+    client_secret=client_secret, 
+    redirect_uri=redirect_uri, 
+    token=token, 
+)
+client = P123Client(
+    client_id=client_id, 
+    client_secret=client_secret, 
+    token=resp["access_token"], 
+    refresh_token=resp["refresh_token"], 
+)
+```
+
+### 6. 扫码登录
+
+当你什么都不传时，就会要求你扫码登录
+
+```python
+client = P123Client()
+```
+
+### 7. 用 token 来扫码新的 token
+
+你可以用一个 token 去扫码获得另一个 token（仅当不是 oauth 登录时）
+
+```python
+client_new = client.login_another()
+```
+
+另外你也可以用 oauth 登录，虽然仅能访问 open 接口，但是 QPS 上放得更宽
+
+下面我用 clouddrive 在 123 网盘上用 oauth 登录举例说明第三方挂载应用登录：
+
+https://123yunpan.yuque.com/org-wiki-123yunpan-muaork/cr6ced/kf05anzt1r0qnudd
+
+```python
+import requests
+from urllib.parse import parse_qsl, urlsplit
+
+resp = client.login_oauth_authorize({
+    "client_id": "7c278c60da9e43848c45ff8e6fa9da0a", 
+    "redirect_uri": "https://redirect123pan.zhenyunpan.com/redirect_pan123", 
+    "accessToken": client.token, 
+    "state": "http://localhost:19798", 
+})
+with requests.get(resp["url"], allow_redirects=False, stream=True) as response:
+    resp = dict(parse_qsl(urlsplit(response.headers["location"]).query))
+client_new = P123Client(token=resp["access_token"], refresh_token=resp["refresh_token"])
+```
+
+### 8. 关于 token 的结构
+
+<kbd>token</kbd> 中包含了一些信息，以 "." 进行分割，可以拆成 3 个部分：
+
+- JWT 算法（经过 base64 加密）
+- 用户信息（经过 base64 加密）
+- 签名字符串
+
+```python
+from base64 import urlsafe_b64decode
 from json import loads
 
 token = client.token
 
 method, user_info, sign = token.split(".", 2)
-print("JWT 算法:", loads(b64decode(method)))
-print("用户信息:", loads(b64decode(user_info+"==")))
+print("JWT 算法:", loads(urlsafe_b64decode(method)))
+print("用户信息:", loads(urlsafe_b64decode(user_info+"==")))
+print("签名:", sign)
 ```
 
-当你需要刷新此 <kbd>token</kbd> 时：
-
-- 要么利用另一个 `refresh_token`
-- 要么直接用这个 <kbd>token</kbd> 授权一次扫码，即可获得新的 <kbd>token</kbd>
-- 要么重新用账号和密码登录
-
 ## 2. 接口调用
 
 所有需要直接或间接执行 HTTP 请求的接口，都有同步和异步的调用方式，且默认是采用 POST 发送 JSON 请求数据
@@ -270,10 +399,10 @@ print(get_downurl(client, "123://torrentgalaxy.db|1976025090|582aa8bfb0ad8e6f512
 
 ### 4. 直链服务
 
-需要先安装 [fastapi](https://pypi.org/project/fastapi/)
+需要先安装 [fastapi](https://pypi.org/project/blacksheep/)
 
 ```console
-pip install 'fastapi[uvicorn]'
+pip install 'blacksheep[uvicorn]'
 ```
 
 然后启动如下服务，就可以访问以获取直链了
@@ -287,29 +416,30 @@ http://localhost:8123/torrentgalaxy.db|1976025090|582aa8bfb0ad8e6f512d9661f6243b
 http://localhost:8123/torrentgalaxy.db|1976025090|582aa8bfb0ad8e6f512d9661f6243bdd
 
 ```python
-from fastapi import FastAPI, Request
-from fastapi.responses import JSONResponse, RedirectResponse
+from blacksheep import json, redirect, Application, Request
 from p123client import P123Client
 from p123client.tool import get_downurl
 
 # TODO: 改成你自己的账户和密码
-client = P123Client(passport="手机号或邮箱", password="登录密码")
+client = P123Client(passport="15888364500", password="Gchenyang123")
+## 或者
+# from pathlib import Path
+# client = P123Client(Path("~/123-token.txt").expanduser())
 
-app = FastAPI(debug=True)
+app = Application(show_error_details=__debug__)
 
-@app.get("/{uri:path}")
-@app.head("/{uri:path}")
+@app.router.route("/{path:uri}", methods=["GET", "HEAD"])
 async def index(request: Request, uri: str):
     try:
         payload = int(uri)
     except ValueError:
         if uri.count("|") < 2:
-            return JSONResponse({"state": False, "message": f"bad uri: {uri!r}"}, 500)
+            return json({"state": False, "message": f"bad uri: {uri!r}"}, 500)
         payload = uri
         if s3_key_flag := request.url.query:
-            payload += "?" + s3_key_flag
+            payload += "?" + s3_key_flag.decode("ascii")
     url = await get_downurl(client, payload, quoted=False, async_=True)
-    return RedirectResponse(url, 302)
+    return redirect(url)
 
 if __name__ == "__main__":
     from uvicorn import run
@@ -413,4 +543,9 @@ client.fs_list_new({
 client.fs_sync_log()
 ```
 
+## 其它资源
+
+- 如果你需要更详细的文档，特别是关于各种接口的信息，可以阅读
+
+    [https://p123client.readthedocs.io/en/latest/](https://p123client.readthedocs.io/en/latest/)