p115client 0.0.5.12__tar.gz → 0.0.5.12.1__tar.gz

{p115client-0.0.5.12 → p115client-0.0.5.12.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: p115client
-Version: 0.0.5.12
+Version: 0.0.5.12.1
 Summary: Python 115 webdisk client.
 Home-page: https://github.com/ChenyangGao/p115client
 License: MIT

{p115client-0.0.5.12 → p115client-0.0.5.12.1}/p115client/client.py

@@ -15,6 +15,7 @@ from collections.abc import (
     AsyncGenerator, AsyncIterable, Awaitable, Buffer, Callable, Coroutine, Generator, 
     ItemsView, Iterable, Iterator, Mapping, MutableMapping, Sequence, 
 )
+from contextlib import contextmanager
 from datetime import date, datetime, timedelta
 from functools import partial
 from hashlib import md5, sha1
@@ -30,11 +31,12 @@ from platform import system
 from posixpath import splitext
 from re import compile as re_compile, MULTILINE
 from string import digits
+from sys import _getframe
 from tempfile import TemporaryFile
 from threading import Lock
 from time import time
 from typing import cast, overload, Any, Final, Literal, Self, Unpack
-from urllib.parse import quote, unquote, urlencode, urlsplit, urlunsplit
+from urllib.parse import parse_qsl, quote, unquote, urlencode, urlsplit, urlunsplit
 from uuid import uuid4
 from warnings import warn
 
@@ -63,7 +65,10 @@ from startfile import startfile, startfile_async # type: ignore
 from undefined import undefined
 from yarl import URL
 
-from .const import CLASS_TO_TYPE, CLIENT_API_MAP, SSOENT_TO_APP, SUFFIX_TO_TYPE, errno
+from .const import (
+    CLASS_TO_TYPE, CLIENT_API_METHODS_MAP, CLIENT_METHOD_API_MAP, 
+    SSOENT_TO_APP, SUFFIX_TO_TYPE, errno, 
+)
 from .exception import (
     AccessTokenError, AuthenticationError, BusyOSError, DataError, LoginError, 
     OpenAppAuthLimitExceeded, NotSupportedError, P115OSError, OperationalError, 
@@ -74,7 +79,6 @@ from ._upload import buffer_length, make_dataiter, oss_upload, oss_multipart_upl
 
 
 CRE_SET_COOKIE: Final = re_compile(r"[0-9a-f]{32}=[0-9a-f]{32}.*")
-CRE_CLIENT_API_search: Final = re_compile(r"^ +((?:GET|POST) .*)", MULTILINE).search
 CRE_COOKIES_UID_search: Final = re_compile(r"(?<=\bUID=)[^\s;]+").search
 CRE_API_match: Final = re_compile(r"http://(web|pro)api.115.com(?=/|\?|#|$)").match
 ED2K_NAME_TRANSTAB: Final = dict(zip(b"/|", ("%2F", "%7C")))
@@ -229,6 +233,20 @@ def try_parse_int(
     return int(s)
 
 
+@contextmanager
+def temp_globals(f_globals: None | dict = None, /, **ns):
+    if f_globals is None:
+        f_globals = _getframe(2).f_globals
+    old_globals = f_globals.copy()
+    if ns:
+        f_globals.update(ns)
+    try:
+        yield f_globals
+    finally:
+        f_globals.clear()
+        f_globals.update(old_globals)
+
+
 def json_loads(content: Buffer, /):
     try:
         if isinstance(content, (bytes, bytearray, memoryview)):
@@ -1573,6 +1591,19 @@ class ClientRequestMixin:
         """
         api = complete_api("/open/authorize", base_url=base_url)
         payload = {"response_type": "code", **payload}
+        def parse(resp, content, /):
+            if resp.status_code == 302:
+                return {
+                    "state": True, 
+                    "url": resp.headers["location"], 
+                    "data": dict(parse_qsl(urlsplit(resp.headers["location"]).query)), 
+                    "headers": dict(resp.headers), 
+                }
+            else:
+                return json_loads(content)
+        request_kwargs["parse"] = parse
+        for key in ("allow_redirects", "follow_redirects", "redirect"):
+            request_kwargs[key] = False
         return self.request(url=api, params=payload, async_=async_, **request_kwargs)
 
     @overload
@@ -2615,7 +2646,6 @@ class ClientRequestMixin:
 
         :return: 文件的 ed2k 链接
         """
-        trantab = dict(zip(b"/|", ("%2F", "%7C")))
         if async_:
             async def request():
                 async with self.open(url, headers=headers, async_=True) as file:
@@ -3481,6 +3511,7 @@ class P115OpenClient(ClientRequestMixin):
               - "user_ptime": 创建时间（无效，效果相当于 "user_utime"）
               - "user_otime": 上一次打开时间（无效，效果相当于 "user_utime"）
 
+            - qid: int = <default>
             - r_all: 0 | 1 = <default>
             - record_open_time: 0 | 1 = 1 💡 是否要记录目录的打开时间
             - scid: int | str = <default>
@@ -3861,7 +3892,7 @@ class P115OpenClient(ClientRequestMixin):
         return self.fs_update(payload, async_=async_, **request_kwargs)
 
     @overload
-    def fs_video_history(
+    def fs_video(
         self, 
         payload: str | dict, 
         /, 
@@ -3872,7 +3903,7 @@ class P115OpenClient(ClientRequestMixin):
     ) -> dict:
         ...
     @overload
-    def fs_video_history(
+    def fs_video(
         self, 
         payload: str | dict, 
         /, 
@@ -3882,7 +3913,7 @@ class P115OpenClient(ClientRequestMixin):
         **request_kwargs, 
     ) -> Coroutine[Any, Any, dict]:
         ...
-    def fs_video_history(
+    def fs_video(
         self, 
         payload: str | dict, 
         /, 
@@ -3891,24 +3922,28 @@ class P115OpenClient(ClientRequestMixin):
         async_: Literal[False, True] = False, 
         **request_kwargs, 
     ) -> dict | Coroutine[Any, Any, dict]:
-        """获取视频播放进度
-
-        GET https://proapi.115.com/open/video/history
+        """获取视频在线播放地址（和视频文件相关数据）
 
+        GET https://proapi.115.com/open/video/play
+        
         .. admonition:: Reference
 
-            https://www.yuque.com/115yun/open/gssqdrsq6vfqigag
+            https://www.yuque.com/115yun/open/hqglxv3cedi3p9dz
+
+        .. hint::
+            需切换音轨时，在请求返回的播放地址中增加请求参数 `&audio_track=${index}`，值就是接口响应中 `multitrack_list` 中某个成员的索引，从 0 开始计数
 
         :payload:
             - pick_code: str 💡 文件提取码
+            - share_id: int | str = <default> 💡 共享 id，获取共享文件播放地址所需
         """
-        api = complete_proapi("/open/video/history", base_url)
+        api = complete_proapi("/open/video/play", base_url)
         if isinstance(payload, str):
             payload = {"pick_code": payload}
         return self.request(url=api, params=payload, async_=async_, **request_kwargs)
 
     @overload
-    def fs_video_history_set(
+    def fs_video_history(
         self, 
         payload: str | dict, 
         /, 
@@ -3919,7 +3954,7 @@ class P115OpenClient(ClientRequestMixin):
     ) -> dict:
         ...
     @overload
-    def fs_video_history_set(
+    def fs_video_history(
         self, 
         payload: str | dict, 
         /, 
@@ -3929,7 +3964,7 @@ class P115OpenClient(ClientRequestMixin):
         **request_kwargs, 
     ) -> Coroutine[Any, Any, dict]:
         ...
-    def fs_video_history_set(
+    def fs_video_history(
         self, 
         payload: str | dict, 
         /, 
@@ -3938,26 +3973,24 @@ class P115OpenClient(ClientRequestMixin):
         async_: Literal[False, True] = False, 
         **request_kwargs, 
     ) -> dict | Coroutine[Any, Any, dict]:
-        """记忆视频播放进度
+        """获取视频播放进度
 
-        POST https://proapi.115.com/open/video/history
+        GET https://proapi.115.com/open/video/history
 
         .. admonition:: Reference
 
-            https://www.yuque.com/115yun/open/bshagbxv1gzqglg4
+            https://www.yuque.com/115yun/open/gssqdrsq6vfqigag
 
         :payload:
             - pick_code: str 💡 文件提取码
-            - time: int = <default> 💡 视频播放进度时长 (单位秒)
-            - watch_end: int = <default> 💡 视频是否播放播放完毕 0:未完毕 1:完毕
         """
         api = complete_proapi("/open/video/history", base_url)
         if isinstance(payload, str):
             payload = {"pick_code": payload}
-        return self.request(url=api, method="POST", data=payload, async_=async_, **request_kwargs)
+        return self.request(url=api, params=payload, async_=async_, **request_kwargs)
 
     @overload
-    def fs_video_play(
+    def fs_video_history_set(
         self, 
         payload: str | dict, 
         /, 
@@ -3968,7 +4001,7 @@ class P115OpenClient(ClientRequestMixin):
     ) -> dict:
         ...
     @overload
-    def fs_video_play(
+    def fs_video_history_set(
         self, 
         payload: str | dict, 
         /, 
@@ -3978,7 +4011,7 @@ class P115OpenClient(ClientRequestMixin):
         **request_kwargs, 
     ) -> Coroutine[Any, Any, dict]:
         ...
-    def fs_video_play(
+    def fs_video_history_set(
         self, 
         payload: str | dict, 
         /, 
@@ -3987,25 +4020,23 @@ class P115OpenClient(ClientRequestMixin):
         async_: Literal[False, True] = False, 
         **request_kwargs, 
     ) -> dict | Coroutine[Any, Any, dict]:
-        """获取视频在线播放地址（和视频文件相关数据）
+        """记忆视频播放进度
 
-        GET https://proapi.115.com/open/video/play
-        
-        .. admonition:: Reference
+        POST https://proapi.115.com/open/video/history
 
-            https://www.yuque.com/115yun/open/hqglxv3cedi3p9dz
+        .. admonition:: Reference
 
-        .. hint::
-            需切换音轨时，在请求返回的播放地址中增加请求参数 `&audio_track=${index}`，值就是接口响应中 `multitrack_list` 中某个成员的索引，从 0 开始计数
+            https://www.yuque.com/115yun/open/bshagbxv1gzqglg4
 
         :payload:
             - pick_code: str 💡 文件提取码
-            - share_id: int | str = <default> 💡 共享 id，获取共享文件播放地址所需
+            - time: int = <default> 💡 视频播放进度时长 (单位秒)
+            - watch_end: int = <default> 💡 视频是否播放播放完毕 0:未完毕 1:完毕
         """
-        api = complete_proapi("/open/video/play", base_url)
+        api = complete_proapi("/open/video/history", base_url)
         if isinstance(payload, str):
             payload = {"pick_code": payload}
-        return self.request(url=api, params=payload, async_=async_, **request_kwargs)
+        return self.request(url=api, method="POST", data=payload, async_=async_, **request_kwargs)
 
     @overload
     def fs_video_push(
@@ -4048,13 +4079,15 @@ class P115OpenClient(ClientRequestMixin):
 
         :payload:
             - pick_code: str 💡 文件提取码
-            - op: str = "vip_push" 💡 提交视频加速转码方式：vip_push:根据；vip 等级加速 pay_push:枫叶加速
+            - op: str = "vip_push" 💡 提交视频加速转码方式
+
+                - "vip_push": 根据；vip 等级加速
+                - "pay_push": 枫叶加速
         """
         api = complete_proapi("/open/video/video_push", base_url)
         if isinstance(payload, str):
-            payload = {"pick_code": payload, "op": "vip_push"}
-        else:
-            payload.setdefault("op", "vip_push")
+            payload = {"pick_code": payload}
+        payload.setdefault("op", "vip_push")
         return self.request(url=api, method="POST", data=payload, async_=async_, **request_kwargs)
 
     @overload
@@ -5305,7 +5338,7 @@ class P115OpenClient(ClientRequestMixin):
     ) -> dict | Coroutine[Any, Any, dict]:
         """获取产品列表地址（即引导用户扫码购买 115 的 VIP 服务，以获取提成）
 
-        GET https://proapi.115.com/open/open/vip/qr_url
+        GET https://proapi.115.com/open/vip/qr_url
 
         .. admonition:: Reference
 
@@ -5336,9 +5369,9 @@ class P115OpenClient(ClientRequestMixin):
     fs_move_open = fs_move
     fs_search_open = fs_search
     fs_star_set_open = fs_star_set
+    fs_video_open = fs_video
     fs_video_history_open = fs_video_history
     fs_video_history_set_open = fs_video_history_set
-    fs_video_play_open = fs_video_play
     fs_video_push_open = fs_video_push
     fs_video_subtitle_open = fs_video_subtitle
     fs_update_open = fs_update
@@ -10960,6 +10993,8 @@ class P115Client(P115OpenClient):
             payload = {"fetch": "one", **payload}
         return self.request(url=api, params=payload, async_=async_, **request_kwargs)
 
+    fs_video_history = fs_files_history
+
     @overload
     def fs_files_history_set(
         self, 
@@ -11002,6 +11037,7 @@ class P115Client(P115OpenClient):
             - definition: int = <default> 💡 视频清晰度
             - share_id: int | str = <default>
             - time: int = <default> 💡 播放时间点（用来向服务器同步播放进度）
+            - watch_end: int = <default> 💡 视频是否播放播放完毕 0:未完毕 1:完毕
             - ...（其它未找全的参数）
         """
         api = complete_webapi("/files/history", base_url=base_url)
@@ -11011,6 +11047,8 @@ class P115Client(P115OpenClient):
             payload = {"op": "update", **payload}
         return self.request(url=api, method="POST", data=payload, async_=async_, **request_kwargs)
 
+    fs_video_history_set = fs_files_history_set
+
     @overload
     def fs_files_second_type(
         self, 
@@ -13232,7 +13270,7 @@ class P115Client(P115OpenClient):
         GET https://proapi.115.com/android/music/musicplay
 
         .. note::
-            即使文件格式不正确或者过大（超过 200MB），也可返回一些信息（包括 parent_id），但如果是目录则信息匮乏（但由此也可判定一个目录）
+            即使文件格式不正确或者过大（超过 200 MB），也可返回一些信息（包括 parent_id），但如果是目录则信息匮乏（但由此也可判定一个目录）
 
         :payload:
             - pickcode: str 💡 提取码
@@ -15374,11 +15412,21 @@ class P115Client(P115OpenClient):
 
         GET https://webapi.115.com/files/video
 
+        .. caution::
+            `local` 在有些视频上不起作用，无论如何，都相当于 `local=0`，可能是因为文件超过 200 MB
+
+            但如果 `local=1` 有效，则返回仅可得到下载链接，key 为 "download_url"
+
         .. important::
             仅这几种设备可用：`harmony`, `web`, `desktop`, **wechatmini**, **alipaymini**, **tv**
 
             但是如果要获取 m3u8 文件，则要提供 web 设备的 cookies，否则返回空数据
 
+        .. note::
+            如果返回信息中有 "queue_url"，则可用于查询转码状态
+
+            如果视频从未被转码过，则会自动推送转码
+
         :payload:
             - pickcode: str 💡 提取码
             - share_id: int | str = <default> 💡 分享 id
@@ -15650,6 +15698,57 @@ class P115Client(P115OpenClient):
             payload = {"pickcode": payload}
         return self.request(url=api, params=payload, async_=async_, **request_kwargs)
 
+    @overload
+    def fs_video_transcode(
+        self, 
+        payload: dict | str, 
+        /, 
+        app: str = "web", 
+        base_url: bool | str | Callable[[], str] = False, 
+        method: str = "GET", 
+        *, 
+        async_: Literal[False] = False, 
+        **request_kwargs, 
+    ) -> dict:
+        ...
+    @overload
+    def fs_video_transcode(
+        self, 
+        payload: dict | str, 
+        /, 
+        app: str = "web", 
+        base_url: bool | str | Callable[[], str] = False, 
+        method: str = "GET", 
+        *, 
+        async_: Literal[True], 
+        **request_kwargs, 
+    ) -> Coroutine[Any, Any, dict]:
+        ...
+    def fs_video_transcode(
+        self, 
+        payload: dict | str, 
+        /, 
+        app: str = "web", 
+        base_url: bool | str | Callable[[], str] = False, 
+        method: str = "GET", 
+        *, 
+        async_: Literal[False, True] = False, 
+        **request_kwargs, 
+    ) -> dict | Coroutine[Any, Any, dict]:
+        """获取视频的转码进度
+
+        GET http://transcode.115.com/api/1.0/android/1.0/trans_code/check_transcode_job
+
+        :payload:
+            - sha1: str
+            - priority: int = 100 💡 优先级
+        """
+        api = complete_api(f"/api/1.0/{app}/1.0/trans_code/check_transcode_job", "transcode", base_url=base_url)
+        if isinstance(payload, str):
+            payload = {"sha1": payload}
+        payload.setdefault("priority", 100)
+        return self.request(url=api, method=method, params=payload, async_=async_, **request_kwargs)
+
     ########## Life API ##########
 
     @overload
@@ -22921,13 +23020,22 @@ class P115Client(P115OpenClient):
         return self.request(url=api, method="POST", data=payload, async_=async_, **request_kwargs)
 
 
-for name, method in P115Client.__dict__.items():
-    if not (callable(method) and method.__doc__):
-        continue
-    match = CRE_CLIENT_API_search(method.__doc__)
-    if match is not None:
-        CLIENT_API_MAP[match[1]] = "P115Client." + name
+with temp_globals():
+    CRE_CLIENT_API_search: Final = re_compile(r"^ +((?:GET|POST|PUT|DELETE|PATCH) .*)", MULTILINE).search
+    for name in dir(P115Client):
+        method = getattr(P115Client, name)
+        if not (callable(method) and method.__doc__):
+            continue
+        match = CRE_CLIENT_API_search(method.__doc__)
+        if match is not None:
+            api = match[1]
+            name = "P115Client." + name
+            CLIENT_METHOD_API_MAP[name] = api
+            try:
+                CLIENT_API_METHODS_MAP[api].append(name)
+            except KeyError:
+                CLIENT_API_METHODS_MAP[api] = [name]
+
 
 # TODO: 提供一个可随时终止和暂停的上传功能，并且可以输出进度条和获取进度
 # TODO: 更新一下，p115client._upload，做更多的封装，至少让断点续传更易于使用
-

{p115client-0.0.5.12 → p115client-0.0.5.12.1}/p115client/const.py

@@ -5,8 +5,8 @@ from __future__ import annotations
 
 __author__ = "ChenyangGao <https://chenyanggao.github.io>"
 __all__ = [
-    "AVAILABLE_APPS", "APP_TO_SSOENT", "SSOENT_TO_APP", "CLIENT_API_MAP", 
-    "CLASS_TO_TYPE", "SUFFIX_TO_TYPE", "errno", 
+    "AVAILABLE_APPS", "APP_TO_SSOENT", "SSOENT_TO_APP", "CLIENT_METHOD_API_MAP", 
+    "CLIENT_API_METHODS_MAP", "CLASS_TO_TYPE", "SUFFIX_TO_TYPE", "errno", 
 ]
 
 from enum import IntEnum
@@ -69,8 +69,11 @@ SSOENT_TO_APP: Final[dict[str, str]] = {
     "S1": "harmony", 
 }
 
-#: 所有已封装的 115 接口以及对应的方法名
-CLIENT_API_MAP: Final[dict[str, str]] = {}
+#: 所有已封装的方法名和对应的 115 接口
+CLIENT_METHOD_API_MAP: Final[dict[str, str]] = {}
+
+#: 所有已封装的 115 接口和对应的方法名
+CLIENT_API_METHODS_MAP: Final[dict[str, list[str]]] = {}
 
 #: 文件的 class 属性对应的所属类型的整数代码
 CLASS_TO_TYPE: Final[dict[str, int]] = {

{p115client-0.0.5.12 → p115client-0.0.5.12.1}/p115client/tool/offline.py

@@ -7,12 +7,14 @@ __doc__ = "这个模块提供了一些和离线下载有关的函数"
 
 from asyncio import sleep as async_sleep
 from collections.abc import AsyncIterator, Callable, Iterable, Iterator
+from errno import EBUSY
 from itertools import count
 from time import sleep, time
 from typing import overload, Literal
 
 from iterutils import run_gen_step_iter, with_iter_next, Yield, YieldFrom
 from p115client import check_response, P115Client, P115OpenClient
+from p115client.exception import BusyOSError
 
 
 @overload
@@ -22,7 +24,8 @@ def offline_iter(
     page_start: int = 1, 
     page_stop: int = -1, 
     cooldown: float = 0, 
-    use_open_api: bool = False, 
+    raise_for_update: bool = False, 
+    use_open_api: bool = False,  
     *, 
     async_: Literal[False] = False, 
     **request_kwargs, 
@@ -35,6 +38,7 @@ def offline_iter(
     page_start: int = 1, 
     page_stop: int = -1, 
     cooldown: float = 0, 
+    raise_for_update: bool = False, 
     use_open_api: bool = False, 
     *, 
     async_: Literal[True], 
@@ -47,6 +51,7 @@ def offline_iter(
     page_start: int = 1, 
     page_stop: int = -1, 
     cooldown: float = 0, 
+    raise_for_update: bool = False, 
     use_open_api: bool = False, 
     *, 
     async_: Literal[False, True] = False, 
@@ -54,10 +59,18 @@ def offline_iter(
 ) -> Iterator[dict] | AsyncIterator[dict]:
     """遍历任务列表，获取任务信息
 
+    .. tip::
+        在逐页拉取的间隔期间，任务列表可能发生变化，可能导致重复和遗漏：
+
+        1. 新增任务，特别是状态为进行中
+        2. 删除任务
+        3. 曾经取得的进行中的任务，变为完成
+
     :param client: 115 客户端或 cookies
     :param page_start: 开始页数
     :param page_stop: 结束页数（不含），如果 <= 0，则不限
     :param cooldown: 接口调用冷却时间，单位：秒
+    :param raise_for_update: 当列表发生更新时，是否报错退出
     :param use_open_api: 是否使用 open api
     :param async_: 是否异步
     :param request_kwargs: 其它请求参数
@@ -79,21 +92,40 @@ def offline_iter(
             offline_list = client.offline_list_open
         else:
             offline_list = client.offline_list
-        if cooldown > 0:
+        may_sleep = cooldown > 0
+        if may_sleep:
             do_sleep = async_sleep if async_ else sleep
-        last_t: float = 0
+            last_t: float = 0
+        if raise_for_update:
+            count = -1
+            seen: set[str] = set()
+            add_info_hash = seen.add
         for page in pages:
-            if last_t and (diff := last_t + cooldown - time()) > 0:
-                yield do_sleep(diff)
-            last_t = time()
+            if may_sleep:
+                if last_t and (diff := last_t + cooldown - time()) > 0:
+                    yield do_sleep(diff)
+                last_t = time()
             resp = yield offline_list(page, async_=async_, **request_kwargs)
             check_response(resp)
             if use_open_api:
                 resp = resp["data"]
+            if raise_for_update:
+                if count < 0:
+                    count = resp["count"]
+                elif count != resp["count"]:
+                    raise BusyOSError(EBUSY, f"detected count changes: {count} != {resp['count']}")
             tasks = resp["tasks"]
             if not tasks:
                 break
-            yield YieldFrom(resp["tasks"])
+            if raise_for_update:
+                for task in tasks:
+                    info_hash = task["info_hash"]
+                    if info_hash in seen:
+                        raise BusyOSError(EBUSY, f"detected duplicate task: info_hash={info_hash!r}")
+                    add_info_hash(info_hash)
+                    yield Yield(task)
+            else:
+                yield YieldFrom(resp["tasks"])
             if len(tasks) < 30 or page >= resp["page_count"]:
                 break
     return run_gen_step_iter(gen_step, async_=async_)

{p115client-0.0.5.12 → p115client-0.0.5.12.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "p115client"
-version = "0.0.5.12"
+version = "0.0.5.12.1"
 description = "Python 115 webdisk client."
 authors = ["ChenyangGao <wosiwujm@gmail.com>"]
 license = "MIT"