p123client 0.0.6.7__tar.gz → 0.0.6.9__tar.gz

{p123client-0.0.6.7 → p123client-0.0.6.9}/PKG-INFO

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

{p123client-0.0.6.7 → p123client-0.0.6.9}/p123client/client.py

@@ -1215,6 +1215,8 @@ class P123OpenClient:
         })
         return self.request(api, params=payload, async_=async_, **request_kwargs)
 
+    fs_list_v2 = fs_list
+
     @overload
     def fs_list_v1(
         self, 
@@ -1261,7 +1263,7 @@ class P123OpenClient:
         :payload:
             - limit: int = 100         💡 分页大小，最多 100
             - orderBy: str = "file_id" 💡 排序依据
-            
+
                 - "file_id": 文件 id
                 - "file_name": 文件名
                 - "size":  文件大小
@@ -4288,6 +4290,7 @@ class P123OpenClient:
     fs_detail_open = fs_detail
     fs_info_open = fs_info
     fs_list_open = fs_list
+    fs_list_v2_open = fs_list_v2
     fs_list_v1_open = fs_list_v1
     fs_mkdir_open = fs_mkdir
     fs_move_open = fs_move
@@ -4459,6 +4462,45 @@ class P123Client(P123OpenClient):
             request_kwargs["async_"] = async_
         return request(**request_kwargs)
 
+    @overload
+    @staticmethod
+    def app_server_time(
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        request: None | Callable = None, 
+        *, 
+        async_: Literal[False] = False, 
+        **request_kwargs, 
+    ) -> dict:
+        ...
+    @overload
+    @staticmethod
+    def app_server_time(
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        request: None | Callable = None, 
+        *, 
+        async_: Literal[True], 
+        **request_kwargs, 
+    ) -> Coroutine[Any, Any, dict]:
+        ...
+    @staticmethod
+    def app_server_time(
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        request: None | Callable = None, 
+        *, 
+        async_: Literal[False, True] = False, 
+        **request_kwargs, 
+    ) -> dict | Coroutine[Any, Any, dict]:
+        """获取 123 网盘的服务器时间戳
+
+        GET https://www.123pan.com/api/get/server/time
+        """
+        request_kwargs["url"] = complete_url("/api/get/server/time", base_url)
+        request_kwargs.setdefault("parse", default_parse)
+        if request is None:
+            request = get_default_request()
+            request_kwargs["async_"] = async_
+        return request(**request_kwargs)
+
     @overload
     def download_info(
         self, 
@@ -5055,7 +5097,7 @@ class P123Client(P123OpenClient):
             - next: int = 0    💡 下一批拉取开始的 id
             - orderBy: str = "file_id" 💡 排序依据
 
-                - "file_id": 文件 id
+                - "file_id": 文件 id，也可以写作 "fileId"
                 - "file_name": 文件名
                 - "size":  文件大小
                 - "create_at": 创建时间
@@ -5151,7 +5193,7 @@ class P123Client(P123OpenClient):
             - next: int = 0    💡 下一批拉取开始的 id
             - orderBy: str = "file_id" 💡 排序依据
 
-                - "file_id": 文件 id
+                - "file_id": 文件 id，也可以写作 "fileId"
                 - "file_name": 文件名
                 - "size":  文件大小
                 - "create_at": 创建时间
@@ -5160,7 +5202,7 @@ class P123Client(P123OpenClient):
                 - ...
 
             - orderDirection: "asc" | "desc" = "asc" 💡 排序顺序
-            - Page: int = <default> 💡 第几页，从 1 开始，可以是 0
+            - Page: int = 1 💡 第几页，从 1 开始
             - parentFileId: int | str = 0 💡 父目录 id
             - trashed: "false" | "true" = <default> 💡 是否查看回收站的文件
             - inDirectSpace: "false" | "true" = "false"
@@ -5171,8 +5213,13 @@ class P123Client(P123OpenClient):
                 - "syncFileList": 同步空间
 
             - operateType: int | str = <default> 💡 操作类型，如果在同步空间，则需要指定为 "SyncSpacePage"
+
+                .. note::
+                    这个值似乎不影响结果，所以可以忽略。我在浏览器中，看到罗列根目录为 1，搜索（指定 `SearchData`）为 2，同步空间的根目录为 3，罗列其它目录大多为 4，偶尔为 8，也可能是其它值
+
             - SearchData: str = <default> 💡 搜索关键字（将无视 `parentFileId` 参数）
-            - OnlyLookAbnormalFile: int = <default>
+            - OnlyLookAbnormalFile: int = 0 💡 大概可传入 0 或 1
+            - RequestSource: int = <default> 💡 浏览器中，在同步空间中为 1
         """
         if isinstance(payload, (int, str)):
             payload = {"parentFileId": payload}
@@ -5185,6 +5232,8 @@ class P123Client(P123OpenClient):
             "parentFileId": 0, 
             "inDirectSpace": "false", 
             "event": event, 
+            "OnlyLookAbnormalFile": 0, 
+            "Page": 1, 
         })
         if not payload.get("trashed"):
             match payload["event"]:
@@ -5322,6 +5371,50 @@ class P123Client(P123OpenClient):
             **request_kwargs, 
         )
 
+    @overload
+    def fs_fresh(
+        self, 
+        payload: dict = {}, 
+        /, 
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        *, 
+        async_: Literal[False] = False, 
+        **request_kwargs, 
+    ) -> dict:
+        ...
+    @overload
+    def fs_fresh(
+        self, 
+        payload: dict = {}, 
+        /, 
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        *, 
+        async_: Literal[True], 
+        **request_kwargs, 
+    ) -> Coroutine[Any, Any, dict]:
+        ...
+    def fs_fresh(
+        self, 
+        payload: 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/restful/goapi/v1/cdnLink/cache/refresh
+        """
+        return self.request(
+            "restful/goapi/v1/cdnLink/cache/refresh", 
+            "POST", 
+            json=payload, 
+            base_url=base_url, 
+            async_=async_, 
+            **request_kwargs, 
+        )
+
     @overload # type: ignore
     def fs_rename(
         self, 
@@ -5378,6 +5471,56 @@ class P123Client(P123OpenClient):
             **request_kwargs, 
         )
 
+    @overload
+    def fs_sync_log(
+        self, 
+        payload: dict | int = 1, 
+        /, 
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        *, 
+        async_: Literal[False] = False, 
+        **request_kwargs, 
+    ) -> dict:
+        ...
+    @overload
+    def fs_sync_log(
+        self, 
+        payload: dict | int = 1, 
+        /, 
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        *, 
+        async_: Literal[True], 
+        **request_kwargs, 
+    ) -> Coroutine[Any, Any, dict]:
+        ...
+    def fs_sync_log(
+        self, 
+        payload: dict | int = 1, 
+        /, 
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        *, 
+        async_: Literal[False, True] = False, 
+        **request_kwargs, 
+    ) -> dict | Coroutine[Any, Any, dict]:
+        """获取同步空间的操作记录
+
+        GET https://www.123pan.com/api/restful/goapi/v1/sync-disk/file/log
+
+        :payload:
+            - page: int = 1               💡 第几页
+            - pageSize: int = 100         💡 每页大小
+            - searchData: str = <default> 💡 搜索关键字
+        """
+        if not isinstance(payload, dict):
+            payload = {"page": payload, "pageSize": 100}
+        return self.request(
+            "restful/goapi/v1/sync-disk/file/log", 
+            params=payload, 
+            base_url=base_url, 
+            async_=async_, 
+            **request_kwargs, 
+        )
+
     @overload # type: ignore
     def fs_trash(
         self, 
@@ -5433,6 +5576,8 @@ class P123Client(P123OpenClient):
                 - "recycleRestore": 移出回收站
 
             - operation: bool = <default>
+            - operatePlace: int = <default>
+            - RequestSource: int = <default>
         """
         if isinstance(payload, (int, str)):
             payload = {"fileTrashInfoList": [{"FileId": payload}]}
@@ -7265,6 +7410,55 @@ class P123Client(P123OpenClient):
             )
         return run_gen_step(gen_step, async_)
 
+    @overload
+    def user_device_list(
+        self, 
+        payload: dict | str = "deviceManagement", 
+        /, 
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        *, 
+        async_: Literal[False] = False, 
+        **request_kwargs, 
+    ) -> dict:
+        ...
+    @overload
+    def user_device_list(
+        self, 
+        payload: dict | str = "deviceManagement", 
+        /, 
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        *, 
+        async_: Literal[True], 
+        **request_kwargs, 
+    ) -> Coroutine[Any, Any, dict]:
+        ...
+    def user_device_list(
+        self, 
+        payload: dict | str = "deviceManagement", 
+        /, 
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        *, 
+        async_: Literal[False, True] = False, 
+        **request_kwargs, 
+    ) -> dict | Coroutine[Any, Any, dict]:
+        """用户设备列表
+
+        GET https://www.123pan.com/api/user/device_list
+
+        :payload:
+            - event: str = "deviceManagement" 💡 事件类型，"deviceManagement" 为管理登录设备列表
+            - operateType: int = <default>
+        """
+        if not isinstance(payload, dict):
+            payload = {"event": payload}
+        return self.request(
+            "user/device_list", 
+            params=payload, 
+            base_url=base_url, 
+            async_=async_, 
+            **request_kwargs, 
+        )
+
     @overload
     def user_info(
         self, 
@@ -7357,8 +7551,57 @@ class P123Client(P123OpenClient):
             request_kwargs["async_"] = async_
         return request(url=api, method="POST", json=payload, **request_kwargs)
 
-# TODO: 添加扫码登录接口，以及通过扫码登录的方法
+    @overload
+    def user_use_history(
+        self, 
+        payload: dict | str = "loginRecord", 
+        /, 
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        *, 
+        async_: Literal[False] = False, 
+        **request_kwargs, 
+    ) -> dict:
+        ...
+    @overload
+    def user_use_history(
+        self, 
+        payload: dict | str = "loginRecord", 
+        /, 
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        *, 
+        async_: Literal[True], 
+        **request_kwargs, 
+    ) -> Coroutine[Any, Any, dict]:
+        ...
+    def user_use_history(
+        self, 
+        payload: dict | str = "loginRecord", 
+        /, 
+        base_url: str | Callable[[], str] = DEFAULT_BASE_URL, 
+        *, 
+        async_: Literal[False, True] = False, 
+        **request_kwargs, 
+    ) -> dict | Coroutine[Any, Any, dict]:
+        """用户使用记录
+
+        GET https://www.123pan.com/api/user/use_history
+
+        :payload:
+            - event: str = "loginRecord" 💡 事件类型，"loginRecord" 为登录记录
+        """
+        if not isinstance(payload, dict):
+            payload = {"event": payload}
+        return self.request(
+            "user/use_history", 
+            params=payload, 
+            base_url=base_url, 
+            async_=async_, 
+            **request_kwargs, 
+        )
+
+# TODO: 添加扫码登录接口，以及通过扫码登录的方法，特别是用已登录的设备扫描一个新的 token 出来
 # TODO: 添加 同步空间 和 直链空间 的操作接口
 # TODO: 添加 图床 的操作接口
 # TODO: 添加 视频转码 的操作接口
 # TODO: 对于某些工具的接口封装，例如 重复文件清理
+# TODO: 开放接口有更新了，从此开始 https://123yunpan.yuque.com/org-wiki-123yunpan-muaork/cr6ced/xogi45g7okqk7svr

{p123client-0.0.6.7 → p123client-0.0.6.9}/p123client/tool/__init__.py

@@ -6,14 +6,14 @@ __all__ = ["make_uri", "upload_uri", "get_downurl", "iterdir", "share_iterdir"]
 
 from asyncio import sleep as async_sleep
 from collections import deque
-from collections.abc import AsyncIterator, Callable, Coroutine, Iterator
+from collections.abc import AsyncIterator, Callable, Coroutine, Iterable, Iterator, Mapping
 from errno import EISDIR, ENOENT
 from functools import partial
 from itertools import count
 from time import sleep, time
 from typing import Literal
 from typing import overload, Any, Literal
-from urllib.parse import unquote
+from urllib.parse import unquote, urlsplit
 
 from encode_uri import encode_uri_component_loose
 from iterutils import run_gen_step, run_gen_step_iter, Yield
@@ -216,6 +216,9 @@ def get_downurl(
     return run_gen_step(gen_step, async_)
 
 
+# TODO: _iterdir 支持广度优先遍历
+# TODO: 失败时，报错信息支持返回已经成功和未成功的列表，并且形式上也要利于断点重试
+# TODO: 支持传入其它自定义的查询参数
 @overload
 def _iterdir(
     fs_files: Callable, 
@@ -224,7 +227,9 @@ def _iterdir(
     min_depth: int = 1, 
     max_depth: int = 1, 
     predicate: None | Callable[[dict], Literal[None, 0, 1, False, True]] = None, 
-    interval: int | float = 0, 
+    cooldown: int | float = 0, 
+    base_url: None | str | Callable[[], str] = None, 
+    extra_data: None | Mapping | Iterable[tuple[str, Any]] = None, 
     *, 
     async_: Literal[False] = False, 
     **request_kwargs, 
@@ -238,7 +243,9 @@ def _iterdir(
     min_depth: int = 1, 
     max_depth: int = 1, 
     predicate: None | Callable[[dict], Literal[None, 0, 1, False, True]] = None, 
-    interval: int | float = 0, 
+    cooldown: int | float = 0, 
+    base_url: None | str | Callable[[], str] = None, 
+    extra_data: None | Mapping | Iterable[tuple[str, Any]] = None, 
     *, 
     async_: Literal[True], 
     **request_kwargs, 
@@ -251,7 +258,9 @@ def _iterdir(
     min_depth: int = 1, 
     max_depth: int = 1, 
     predicate: None | Callable[[dict], Literal[None, 0, 1, False, True]] = None, 
-    interval: int | float = 0, 
+    cooldown: int | float = 0, 
+    base_url: None | str | Callable[[], str] = None, 
+    extra_data: None | Mapping | Iterable[tuple[str, Any]] = None, 
     *, 
     async_: Literal[False, True] = False, 
     **request_kwargs, 
@@ -270,7 +279,9 @@ def _iterdir(
         - 如果返回值是 False，则跳过此节点（但依然会继续处理位于此节点之下的节点）
         - 如果返回值是 True，则输出此节点
 
-    :param interval: 两次调用之间，休息的时间
+    :param cooldown: 两次调用之间，冷却的时间（用两次调用开始时的时间差，而不是一次完成到下一次开始的时间差）
+    :param base_url: 基地址，如果为空，则用默认
+    :param extra_data: 附加数据
     :param async_: 是否异步
     :param request_kwargs: 其它请求参数
 
@@ -278,6 +289,8 @@ def _iterdir(
     """
     default_payload = payload
     page_size = int(payload.setdefault("limit", 100))
+    if base_url:
+        request_kwargs["base_url"] = base_url
     def gen_step():
         nonlocal parent_id
         dq: deque[tuple[int, int, str]] = deque()
@@ -290,13 +303,13 @@ def _iterdir(
             payload = {**default_payload, "parentFileId": parent_id}
             for i in count(1):
                 payload["Page"] = i
-                if last_ts and interval > 0 and (remains := last_ts + interval - time()) > 0:
+                if last_ts and cooldown > 0 and (remains := last_ts + cooldown - time()) > 0:
                     if async_:
                         yield async_sleep(remains)
                     else:
                         sleep(remains)
                 resp = yield fs_files(payload, async_=async_, **request_kwargs)
-                if interval > 0:
+                if cooldown > 0:
                     last_ts = time()
                 check_response(resp)
                 info_list = resp["data"]["InfoList"]
@@ -320,6 +333,8 @@ def _iterdir(
                         continue
                     elif pred:
                         if depth >= min_depth:
+                            if extra_data:
+                                info = dict(extra_data, **info)
                             yield Yield(info)
                         if pred is 1:
                             continue
@@ -343,7 +358,8 @@ def iterdir(
     min_depth: int = 1, 
     max_depth: int = 1, 
     predicate: None | Callable[[dict], Literal[None, 0, 1, False, True]] = None, 
-    interval: int | float = 0, 
+    cooldown: int | float = 0, 
+    base_url: None | str | Callable[[], str] = None, 
     use_list_new: bool = False, 
     *, 
     async_: Literal[False] = False, 
@@ -357,7 +373,8 @@ def iterdir(
     min_depth: int = 1, 
     max_depth: int = 1, 
     predicate: None | Callable[[dict], Literal[None, 0, 1, False, True]] = None, 
-    interval: int | float = 0, 
+    cooldown: int | float = 0, 
+    base_url: None | str | Callable[[], str] = None, 
     use_list_new: bool = False, 
     *, 
     async_: Literal[True], 
@@ -370,7 +387,8 @@ def iterdir(
     min_depth: int = 1, 
     max_depth: int = 1, 
     predicate: None | Callable[[dict], Literal[None, 0, 1, False, True]] = None, 
-    interval: int | float = 0, 
+    cooldown: int | float = 0, 
+    base_url: None | str | Callable[[], str] = None, 
     use_list_new: bool = False, 
     *, 
     async_: Literal[False, True] = False, 
@@ -389,7 +407,8 @@ def iterdir(
         - 如果返回值是 False，则跳过此节点（但依然会继续处理位于此节点之下的节点）
         - 如果返回值是 True，则输出此节点
 
-    :param interval: 两次调用之间，休息的时间
+    :param cooldown: 两次调用之间，冷却的时间（用两次调用开始时的时间差，而不是一次完成到下一次开始的时间差）
+    :param base_url: 基地址，如果为空，则用默认
     :param use_list_new: 使用 `P123Client.fs_list_new` 而不是 `P123Client.fs_list`
     :param async_: 是否异步
     :param request_kwargs: 其它请求参数
@@ -402,7 +421,8 @@ def iterdir(
         min_depth=min_depth, 
         max_depth=max_depth, 
         predicate=predicate, 
-        interval=interval, 
+        cooldown=cooldown, 
+        base_url=base_url, 
         async_=async_, 
         **request_kwargs, 
     )
@@ -416,7 +436,8 @@ def share_iterdir(
     min_depth: int = 1, 
     max_depth: int = 1, 
     predicate: None | Callable[[dict], Literal[None, 0, 1, False, True]] = None, 
-    interval: int | float = 0, 
+    cooldown: int | float = 0, 
+    base_url: None | str | Callable[[], str] = None, 
     *, 
     async_: Literal[False] = False, 
     **request_kwargs, 
@@ -430,7 +451,8 @@ def share_iterdir(
     min_depth: int = 1, 
     max_depth: int = 1, 
     predicate: None | Callable[[dict], Literal[None, 0, 1, False, True]] = None, 
-    interval: int | float = 0, 
+    cooldown: int | float = 0, 
+    base_url: None | str | Callable[[], str] = None, 
     *, 
     async_: Literal[True], 
     **request_kwargs, 
@@ -443,15 +465,24 @@ def share_iterdir(
     min_depth: int = 1, 
     max_depth: int = 1, 
     predicate: None | Callable[[dict], Literal[None, 0, 1, False, True]] = None, 
-    interval: int | float = 0, 
+    cooldown: int | float = 0, 
+    base_url: None | str | Callable[[], str] = None, 
     *, 
     async_: Literal[False, True] = False, 
     **request_kwargs, 
 ) -> Iterator[dict] | AsyncIterator[dict]:
     """遍历分享的文件列表
 
-    :param share_key: 分享码，在分享链接中的位置形如 "https://www.123pan.com/s/{share_key}"
-    :param share_pwd: 密码，如果没有就不传
+    :param share_key: 分享码或者分享链接（可以携带提取码）
+
+        .. note::
+            在分享链接中的位置形如 f"https://www.123pan.com/s/{share_key}"
+
+            如果携带提取码，要写成 f"https://www.123pan.com/s/{share_key}?提取码:{share_pwd}"
+
+            上面的基地址不必是 "https://www.123pan.com"
+
+    :param share_pwd: 提取码（4个文字），可以为空
     :param parent_id: 父目录 id，默认是根目录
     :param min_depth: 最小深度，小于此深度的不会输出
     :param max_depth: 最大深度，大于此深度的不会输出，如果小于 0 则无限
@@ -462,20 +493,33 @@ def share_iterdir(
         - 如果返回值是 False，则跳过此节点（但依然会继续处理位于此节点之下的节点）
         - 如果返回值是 True，则输出此节点
 
-    :param interval: 两次调用之间，休息的时间
+    :param cooldown: 两次调用之间，冷却的时间（用两次调用开始时的时间差，而不是一次完成到下一次开始的时间差）
+    :param base_url: 基地址，如果为空，则用默认（如果 `share_key` 是分享链接，则用它的 origin）
     :param async_: 是否异步
     :param request_kwargs: 其它请求参数
 
     :return: 迭代器，产生文件或目录的信息
     """
+    if share_key.startswith(("http://", "https://")):
+        urlp = urlsplit(share_key)
+        if not base_url:
+            base_url = f"{urlp.scheme}://{urlp.netloc}"
+        share_key = urlp.path.rsplit("/", 1)[-1]
+        if not share_pwd:
+            share_pwd = urlp.query.rpartition(":")[-1]
+            if len(share_pwd) != 4:
+                share_pwd = ""
+    payload = {"ShareKey": share_key, "SharePwd": share_pwd}
     return _iterdir(
         P123Client.share_fs_list, 
-        {"ShareKey": share_key, "SharePwd": share_pwd}, 
+        payload, 
         parent_id=parent_id, 
         min_depth=min_depth, 
         max_depth=max_depth, 
         predicate=predicate, 
-        interval=interval, 
+        cooldown=cooldown, 
+        base_url=base_url, 
+        extra_data=payload, 
         async_=async_, 
         **request_kwargs, 
     )

{p123client-0.0.6.7 → p123client-0.0.6.9}/pyproject.toml

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