p123client 0.0.6.9.2__tar.gz → 0.0.6.9.4__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: p123client
-Version: 0.0.6.9.2
+Version: 0.0.6.9.4
 Summary: Python 123 webdisk client.
 Home-page: https://github.com/ChenyangGao/p123client
 License: MIT
@@ -33,6 +33,7 @@ Requires-Dist: python-http_request (>=0.0.7)
 Requires-Dist: python-httpfile (>=0.0.5)
 Requires-Dist: python-iterutils (>=0.2.4.1)
 Requires-Dist: python-property (>=0.0.3)
+Requires-Dist: qrcode
 Requires-Dist: yarl
 Project-URL: Repository, https://github.com/ChenyangGao/p123client
 Description-Content-Type: text/markdown
@@ -45,7 +46,7 @@ Description-Content-Type: text/markdown
 ![PyPI - Format](https://img.shields.io/pypi/format/p123client)
 ![PyPI - Status](https://img.shields.io/pypi/status/p123client)
 
-## 安装
+## 0. 安装
 
 你可以从 [pypi](https://pypi.org/project/p123client/) 安装最新版本
 
@@ -53,9 +54,7 @@ Description-Content-Type: text/markdown
 pip install -U p123client
 ```
 
-## 入门介绍
-
-### 1. 导入模块和创建实例
+## 1. 导入模块和创建实例
 
 导入模块
 
@@ -63,13 +62,21 @@ pip install -U p123client
 from p123client import P123Client
 ```
 
-创建客户端对象，需要传入 JWT <kbd>token</kbd>
+创建客户端对象，需要传入 JWT <kbd>token</kbd>，也就是 `access_token`
 
 ```python
 token = "..."
 client = P123Client(token=token)
 ```
 
+不过我更推荐把 <kbd>token</kbd> 写入一个文件中，例如在 `~/123-token.txt`
+
+```python
+from pathlib import Path
+
+client = P123Client(token=Path("~/123-token.txt").expanduser())
+```
+
 你也可以用账户和密码登录
 
 ```python
@@ -78,7 +85,26 @@ password = "..." # 密码
 client = P123Client(passport, password)
 ```
 
-### 2. 接口调用
+它的这个 <kbd>token</kbd>，就包含了有关信息
+
+```python
+from base64 import 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+"==")))
+```
+
+当你需要刷新此 <kbd>token</kbd> 时：
+
+- 要么利用另一个 `refresh_token`
+- 要么直接用这个 <kbd>token</kbd> 授权一次扫码，即可获得新的 <kbd>token</kbd>
+- 要么重新用账号和密码登录
+
+## 2. 接口调用
 
 所有需要直接或间接执行 HTTP 请求的接口，都有同步和异步的调用方式，且默认是采用 POST 发送 JSON 请求数据
 
@@ -177,7 +203,7 @@ class MyCustom123Client(P123Client):
         )
 ```
 
-### 3. 检查响应
+## 3. 检查响应
 
 接口被调用后，如果返回的是 dict 类型的数据（说明原本是 JSON），则可以用 `p123client.check_response` 执行检查。首先会查看其中名为 "code" 的键的对应值，如果为 0 或 200 或者不存在，则原样返回被检查的数据；否则，抛出一个 `p123client.P123OSError` 的实例。
 
@@ -190,7 +216,7 @@ data = check_response(client.method(payload))
 data = check_response(await client.method(payload, async_=True))
 ```
 
-### 4. 辅助工具
+## 4. 辅助工具
 
 一些简单的封装工具可能是必要的，特别是那种实现起来代码量比较少，可以封装成单个函数的。我把平常使用过程中，积累的一些经验具体化为一组工具函数。这些工具函数分别有着不同的功能，如果组合起来使用，或许能解决很多问题。
 
@@ -198,7 +224,9 @@ data = check_response(await client.method(payload, async_=True))
 from p123client import tool
 ```
 
-#### 1. 创建自定义 uri
+## 5. 学习案例
+
+### 1. 创建自定义 uri
 
 ```python
 from p123client import P123Client
@@ -212,7 +240,7 @@ file_id = 15688945
 print(make_uri(client, file_id))
 ```
 
-#### 2. 由自定义 uri 转存文件到你的网盘
+### 2. 由自定义 uri 转存文件到你的网盘
 
 ```python
 from p123client import P123Client
@@ -225,7 +253,7 @@ uri = "123://torrentgalaxy.db|1976025090|582aa8bfb0ad8e6f512d9661f6243bdd"
 print(upload_uri(client, uri, duplicate=1))
 ```
 
-#### 3. 由自定义 uri 获取下载直链
+### 3. 由自定义 uri 获取下载直链
 
 ```python
 from p123client import P123Client
@@ -240,7 +268,7 @@ print(get_downurl(client, "123://torrentgalaxy.db|1976025090|582aa8bfb0ad8e6f512
 print(get_downurl(client, "123://torrentgalaxy.db|1976025090|582aa8bfb0ad8e6f512d9661f6243bdd"))
 ```
 
-#### 4. 直链服务
+### 4. 直链服务
 
 需要先安装 [fastapi](https://pypi.org/project/fastapi/)
 
@@ -289,9 +317,11 @@ if __name__ == "__main__":
     run(app, host="0.0.0.0", port=8123)
 ```
 
-#### 5. 遍历文件列表
+### 5. 遍历文件列表
 
-**遍历网盘中的文件列表**
+导出的文件信息中，有个 `"uri"`，表示文件的自定义链接，前面以 `123://` 开头，你可以替换成 302 服务的地址，例如 `http://localhost:8123/`
+
+#### 1. 遍历网盘中的文件列表
 
 ```python
 from p123client import P123Client
@@ -300,21 +330,87 @@ from p123client.tool import iterdir
 # TODO: 改成你自己的账户和密码
 client = P123Client(passport="手机号或邮箱", password="登录密码")
 
-for info in iterdir(client, parent_id=0, max_depth=-1, predicate=lambda a: not a["is_dir"]):
+for info in iterdir(client, parent_id=0, max_depth=-1):
     print(info)
 ```
 
-**遍历分享中的文件列表（无需登录）**
+#### 2. 遍历分享中的文件列表，不含目录
 
 ```python
 from p123client.tool import share_iterdir
 
-# TODO: 分享码
-share_key = "g0n0Vv-2sbI"
-# TODO: 密码
-share_pwd = ""
-
-for info in share_iterdir(share_key, share_pwd, parent_id=0, max_depth=-1, predicate=lambda a: not a["is_dir"]):
+# NOTE: 无需登录
+for info in share_iterdir(
+    "https://www.123684.com/s/oec7Vv-CIYWh?提取码:ZY4K", 
+    max_depth=-1, 
+    predicate=lambda a: not a["is_dir"], 
+):
     print(info)
 ```
 
+#### 3. 导出分享中的文件列表到本地 .json 文件
+
+```python
+from orjson import dumps
+from p123client.tool import share_iterdir
+
+def export_share_files_json(
+    link: str, 
+    path: str = "", 
+    cooldown: float = 0, 
+):
+    """把分享链接中的文件列表导出到 json 文件
+
+    :param link: 分享链接，可以包含提取码
+    :param path: 保存的路径，如果不提供则自动确定
+    :param cooldown: 两次调用之间，冷却的时间（用两次调用开始时的时间差，而不是一次完成到下一次开始的时间差）
+    """
+    print("< 将拉取:", link)
+    ls: list[dict] = []
+    for i, a in enumerate(share_iterdir(link, max_depth=-1, cooldown=cooldown), 1):
+        ls.append(a)
+        print(i, a)
+    if ls:
+        info = ls[0]
+        if not path:
+            suffix = f"@{info['ShareKey']},{info['SharePwd']}.json"
+            path = f"{info['name'][:255-len(suffix)]}{suffix}"
+        open(path, "wb").write(dumps(ls))
+        print()
+        print("> 已拉取:", link)
+        print("> 已保存:", path)
+
+export_share_files_json("https://www.123684.com/s/oec7Vv-CIYWh?提取码:ZY4K")
+```
+
+### 6. 最新的操作记录
+
+在网盘中，你可以按更新时间逆序查询，即可得到最新上传的文件列表
+
+```python
+client.fs_list_new({
+    "orderBy": "update_time", 
+    "orderDirection": "desc", 
+    "SearchData": ".", 
+})
+```
+
+更一般的，你可以在[同步空间](https://www.123pan.com/SynchronousSpace/main)中执行文件操作。
+
+而在拉取文件列表时，需要指定
+
+```python
+client.fs_list_new({
+    "operateType": "SyncSpacePage", 
+    "event": "syncFileList", 
+    "RequestSource": 1, 
+})
+```
+
+同步空间中的增删改操作都有[操作记录](https://www.123pan.com/SynchronousSpace/record)，你可以用接口
+
+```python
+client.fs_sync_log()
+```
+
+