p123client 0.0.7__tar.gz → 0.0.7.1__tar.gz

{p123client-0.0.7 → p123client-0.0.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: p123client
-Version: 0.0.7
+Version: 0.0.7.1
 Summary: Python 123 webdisk client.
 Home-page: https://github.com/ChenyangGao/p123client
 License: MIT

{p123client-0.0.7 → p123client-0.0.7.1}/p123client/client.py

@@ -22,7 +22,7 @@ from os import fsdecode, fstat, isatty, PathLike
 from os.path import basename
 from pathlib import Path, PurePath
 from re import compile as re_compile, MULTILINE
-from string import digits, ascii_uppercase
+from string import digits, hexdigits, ascii_uppercase
 from sys import _getframe
 from tempfile import TemporaryFile
 from typing import cast, overload, Any, Final, Literal, Self
@@ -1644,7 +1644,7 @@ class P123OpenClient:
 
         :payload:
             - businessType: int = <default> 💡 业务类型：2:转码空间
-            - category: int = <default>     💡 分类代码：0:未知 1:音频 2:视频 3:图片 4:音频 5:其它
+            - category: int = <default>     💡 分类代码：0:未知 1:音频 2:视频 3:图片 4:音频 5:其它 6:保险箱 7:收藏夹
             - lastFileId: int = <default>   💡 上一页的最后一条记录的 FileID，翻页查询时需要填写
             - limit: int = 100              💡 分页大小，最多 100
             - parentFileId: int | str = 0   💡 父目录 id，根目录是 0
@@ -5810,7 +5810,7 @@ class P123Client(P123OpenClient):
         """执行一次自动扫码，但并不因此更新 ``self.token``
 
         .. caution::
-            非会员目前只支持同时在线 3 台登录设备
+            非会员目前只支持同时在线 3 台登录设备，VIP 则支持同时在线 10 台
 
         :param platform: 用哪个设备平台扫码
         :param base_url: 接口的基地址
@@ -7032,6 +7032,8 @@ class P123Client(P123OpenClient):
                 - 3: 图片
                 - 4: 音频
                 - 5: 其它
+                - 6: 保险箱
+                - 7: 收藏夹
 
             - dateGranularity: int = <default> 💡 按时间分组展示
 
@@ -7426,6 +7428,98 @@ class P123Client(P123OpenClient):
             **request_kwargs, 
         )
 
+    @overload
+    def fs_safe_box_lock(
+        self, 
+        /, 
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        *, 
+        async_: Literal[False] = False, 
+        **request_kwargs, 
+    ) -> dict:
+        ...
+    @overload
+    def fs_safe_box_lock(
+        self, 
+        /, 
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        *, 
+        async_: Literal[True], 
+        **request_kwargs, 
+    ) -> Coroutine[Any, Any, dict]:
+        ...
+    def fs_safe_box_lock(
+        self, 
+        /, 
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        *, 
+        async_: Literal[False, True] = False, 
+        **request_kwargs, 
+    ) -> dict | Coroutine[Any, Any, dict]:
+        """锁定保险箱
+
+        POST https://www.123pan.com/api/restful/goapi/v1/file/safe_box/auth/lock
+        """
+        return self.request(
+            "restful/goapi/v1/file/safe_box/auth/lock", 
+            "POST", 
+            base_url=base_url, 
+            async_=async_, 
+            **request_kwargs, 
+        )
+
+    @overload
+    def fs_safe_box_unlock(
+        self, 
+        payload: dict | int | str, 
+        /, 
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        *, 
+        async_: Literal[False] = False, 
+        **request_kwargs, 
+    ) -> dict:
+        ...
+    @overload
+    def fs_safe_box_unlock(
+        self, 
+        payload: dict | int | str, 
+        /, 
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        *, 
+        async_: Literal[True], 
+        **request_kwargs, 
+    ) -> Coroutine[Any, Any, dict]:
+        ...
+    def fs_safe_box_unlock(
+        self, 
+        payload: dict | int | str, 
+        /, 
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        *, 
+        async_: Literal[False, True] = False, 
+        **request_kwargs, 
+    ) -> dict | Coroutine[Any, Any, dict]:
+        """解锁保险箱
+
+        .. note::
+            保险箱的 id，可以用 ``client.user_info()`` 接口获得，字段为 "SafeBoxFileId"
+
+        POST https://www.123pan.com/api/restful/goapi/v1/file/safe_box/auth/unlockbox
+
+        :payload:
+            - password: int | str 💡 6 位密码
+        """
+        if not isinstance(payload, dict):
+            payload = {"password": payload}
+        return self.request(
+            "restful/goapi/v1/file/safe_box/auth/unlockbox", 
+            "POST", 
+            json=payload, 
+            base_url=base_url, 
+            async_=async_, 
+            **request_kwargs, 
+        )
+
     @overload
     def fs_star(
         self, 
@@ -8267,6 +8361,64 @@ class P123Client(P123OpenClient):
 
     ########## Offline Download API ##########
 
+    @overload
+    def offline_task_abort(
+        self, 
+        payload: int | Iterable[int] | dict, 
+        /, 
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        *, 
+        async_: Literal[False] = False, 
+        **request_kwargs, 
+    ) -> dict:
+        ...
+    @overload
+    def offline_task_abort(
+        self, 
+        payload: int | Iterable[int] | dict, 
+        /, 
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        *, 
+        async_: Literal[True], 
+        **request_kwargs, 
+    ) -> Coroutine[Any, Any, dict]:
+        ...
+    def offline_task_abort(
+        self, 
+        payload: int | Iterable[int] | dict, 
+        /, 
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        *, 
+        async_: Literal[False, True] = False, 
+        **request_kwargs, 
+    ) -> dict | Coroutine[Any, Any, dict]:
+        """取消离线下载任务
+
+        POST https://www.123pan.com/api/offline_download/task/abort
+
+        :payload:
+            - task_ids: list[int]   💡 任务 id 列表
+            - is_abort: bool = True 💡 是否取消
+            - all: bool = False     💡 是否全部
+        """
+        if isinstance(payload, int):
+            payload = {"task_ids": [payload]}
+        elif not isinstance(payload, dict):
+            if not isinstance(payload, (list, tuple)):
+                payload = tuple(payload)
+            payload = {"task_ids": payload}
+        payload = cast(dict, payload)
+        payload.setdefault("is_abort", True)
+        payload.setdefault("all", False)
+        return self.request(
+            "offline_download/task/abort", 
+            "POST", 
+            json=payload, 
+            base_url=base_url, 
+            async_=async_, 
+            **request_kwargs, 
+        )
+
     @overload
     def offline_task_delete(
         self, 
@@ -8407,7 +8559,7 @@ class P123Client(P123OpenClient):
     ) -> dict | Coroutine[Any, Any, dict]:
         """解析下载链接
 
-        POST https://www.123pan.com/api/offline_download/task/resolve
+        POST https://www.123pan.com/api/v2/offline_download/task/resolve
 
         :payload:
             - urls: str = <default> 💡 下载链接，多个用 "\\n" 隔开（用于新建链接下载任务）
@@ -8418,7 +8570,7 @@ class P123Client(P123OpenClient):
         elif not isinstance(payload, dict):
             payload = {"urls": "\n".join(payload)}
         return self.request(
-            "offline_download/task/resolve", 
+            "v2/offline_download/task/resolve", 
             "POST", 
             json=payload, 
             base_url=base_url, 
@@ -8426,11 +8578,10 @@ class P123Client(P123OpenClient):
             **request_kwargs, 
         )
 
-    # TODO: 支持接受一个 Iterable[dict | int]，int 视为 id （select_file 为 [0]），dict 视为 resolve 信息
     @overload
     def offline_task_submit(
         self, 
-        payload: dict, 
+        payload: dict | Iterable[dict], 
         /, 
         base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
         *, 
@@ -8441,7 +8592,7 @@ class P123Client(P123OpenClient):
     @overload
     def offline_task_submit(
         self, 
-        payload: dict, 
+        payload: dict | Iterable[dict], 
         /, 
         base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
         *, 
@@ -8451,7 +8602,7 @@ class P123Client(P123OpenClient):
         ...
     def offline_task_submit(
         self, 
-        payload: dict, 
+        payload: dict | Iterable[dict], 
         /, 
         base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
         *, 
@@ -8460,7 +8611,19 @@ class P123Client(P123OpenClient):
     ) -> dict | Coroutine[Any, Any, dict]:
         """提交离线下载任务
 
-        POST https://www.123pan.com/api/offline_download/task/submit
+        POST https://www.123pan.com/api/v2/offline_download/task/submit
+
+        .. note::
+            提交信息来自 ``client.offline_task_resolve()`` 接口的响应，假设响应为 ``resp``，那么
+
+            .. code:: python
+
+                payload = {
+                    "resource_list": [{
+                        "resource_id": resource["id"], 
+                        "select_file_id": [info["id"] for info in resource["files"]], 
+                    } for resource in resp["data"]["list"]]
+                }
 
         :payload:
             - resource_list: list[Task] 💡 资源列表
@@ -8468,14 +8631,21 @@ class P123Client(P123OpenClient):
                 .. code:: python
 
                     File = {
-                        "resource_id": int, 
-                        "select_file": list[int] # 如果是链接下载，则传 [0]，如果BT下载，则传需要下载的文件在列表中的索引的列表
+                        "resource_id": int,          # 资源 id
+                        "select_file_id": list[int], # 此资源内的文件 id
                     }
 
             - upload_dir: int 💡 保存到目录的 id
         """
+        if not isinstance(payload, dict):
+            payload = {
+                "resource_list": [{
+                    "resource_id": resource["id"], 
+                    "select_file_id": [info["id"] for info in resource["files"]], 
+                } for resource in payload]
+            }
         return self.request(
-            "offline_download/task/submit", 
+            "v2/offline_download/task/submit", 
             "POST", 
             json=payload, 
             base_url=base_url, 
@@ -8531,6 +8701,71 @@ class P123Client(P123OpenClient):
             **request_kwargs, 
         )
 
+    @overload
+    def offline_add(
+        self, 
+        /, 
+        url: str | Iterable[str], 
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        *, 
+        async_: Literal[False] = False, 
+        **request_kwargs, 
+    ) -> dict:
+        ...
+    @overload
+    def offline_add(
+        self, 
+        /, 
+        url: str | Iterable[str], 
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        *, 
+        async_: Literal[True], 
+        **request_kwargs, 
+    ) -> Coroutine[Any, Any, dict]:
+        ...
+    def offline_add(
+        self, 
+        /, 
+        url: str | Iterable[str], 
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        *, 
+        async_: Literal[False, True] = False, 
+        **request_kwargs, 
+    ) -> dict | Coroutine[Any, Any, dict]:
+        """添加离线下载任务
+
+        POST https://www.123pan.com/api/offline_download/upload/seed
+
+        :param url: info_hash（只允许单个）、下载链接（多个用 "\n" 分隔）或者多个下载链接的迭代器
+        :param base_url: API 链接的基地址
+        :param async_: 是否异步
+        :param request_kwargs: 其它请求参数
+
+        :return: 接口响应信息
+        """
+        def gen_step():
+            if isinstance(url, str):
+                if len(url) == 40 and not url.strip(hexdigits):
+                    payload: dict = {"info_hash": url}
+                else:
+                    payload = {"urls": url}
+            else:
+                payload = {"urls": "\n".join(url)}
+            resp = yield self.offline_task_resolve(
+                payload, 
+                base_url=base_url, 
+                async_=async_, 
+                **request_kwargs, 
+            )
+            check_response(resp)
+            return self.offline_task_submit(
+                resp["data"]["list"], 
+                base_url=base_url, 
+                async_=async_, 
+                **request_kwargs, 
+            )
+        return run_gen_step(gen_step, async_)
+
     ########## Share API ##########
 
     @overload
@@ -10267,3 +10502,4 @@ with temp_globals():
             except KeyError:
                 CLIENT_API_METHODS_MAP[api] = [name]
 
+# TODO: 实现 check_for_relogin 参数，当报错 401，则重新登录（如果用的是 client_id，账号密码 或 refresh_token），调用 client.login()

{p123client-0.0.7 → p123client-0.0.7.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "p123client"
-version = "0.0.7"
+version = "0.0.7.1"
 description = "Python 123 webdisk client."
 authors = ["ChenyangGao <wosiwujm@gmail.com>"]
 license = "MIT"