p115client 0.0.5.9.3__py3-none-any.whl → 0.0.5.10__py3-none-any.whl

p115client/tool/pool.py

@@ -18,12 +18,14 @@ from itertools import cycle, repeat
 from math import inf, isinf
 from threading import Lock
 from time import time
-from typing import cast, Any
 
 from iterutils import run_gen_step
 from p115client import check_response, P115Client
+from p115client.const import AVAILABLE_APP_IDS
 from p115client.exception import P115OSError, AuthenticationError, LoginError
 
+from .util import get_status, is_timeouterror
+
 
 @total_ordering
 class ComparedWithID[T]:
@@ -51,35 +53,9 @@ class ComparedWithID[T]:
         return f"{type(self).__qualname__}({self.value!r})"
 
 
-def get_status(e: BaseException, /) -> None | int:
-    status = (
-        getattr(e, "status", None) or 
-        getattr(e, "code", None) or 
-        getattr(e, "status_code", None)
-    )
-    if status is None and hasattr(e, "response"):
-        response = e.response
-        status = (
-            getattr(response, "status", None) or 
-            getattr(response, "code", None) or 
-            getattr(response, "status_code", None)
-        )
-    return status
-
-
-def is_timeouterror(exc: Exception) -> bool:
-    exctype = type(exc)
-    for exctype in exctype.mro():
-        if exctype is Exception:
-            break
-        if "Timeout" in exctype.__name__:
-            return True
-    return False
-
-
 def generate_auth_factory(
     client: str | P115Client, 
-    app_ids: Iterable[int] = range(100195123, 100196659, 2), 
+    app_ids: Iterable[int] = AVAILABLE_APP_IDS, 
     **request_kwargs, 
 ) -> Callable:
     """利用一个已登录设备的 cookies，产生若干开放应用的 access_token
@@ -262,7 +238,7 @@ def make_pool[T](
 
 def auth_pool(
     client: str | P115Client, 
-    app_ids: Iterable[int] = range(100195123, 100196659, 2), 
+    app_ids: Iterable[int] = AVAILABLE_APP_IDS, 
     heap: None | list[tuple[float, dict | ComparedWithID[dict]]] = None, 
     cooldown_time: int | float = 1, 
     live_time: int | float = 7000, 
@@ -404,6 +380,7 @@ def call_wrap_with_pool(get_cert_headers: Callable, /, func: Callable) -> Callab
         return run_gen_step(gen_step, async_=async_)
     return update_wrapper(wrapper, func)
 
+
 # TODO: 需要完整的类型签名
 # TODO: 池子可以被导出，下次继续使用
 # TODO: 支持多个不同设备的 cookies 组成池，以及刷新（自己刷新自己，或者由另一个 cookies 辅助刷新）

p115client/tool/request.py

@@ -126,6 +126,7 @@ def make_request(
         case _:
             raise ValueError(f"can't make request for {module!r}")
 
+
 # TODO: 基于 http.client 实现一个 request，并且支持连接池
 # TODO: 基于 https://asks.readthedocs.io/en/latest/ 实现一个 request
 # TODO: 基于 https://pypi.org/project/pycurl/ 实现一个 request

p115client/tool/util.py

@@ -0,0 +1,107 @@
+#!/usr/bin/env python3
+# encoding: utf-8
+
+__author__ = "ChenyangGao <https://chenyanggao.github.io>"
+__all__ = [
+    "get_status", "is_timeouterror", "posix_escape_name", "reduce_image_url_layers", 
+    "share_extract_payload", "unescape_115_charref", 
+]
+__doc__ = "这个模块提供了一些工具函数"
+
+from re import compile as re_compile
+from typing import cast, Final, TypedDict
+from urllib.parse import urlsplit
+
+
+CRE_115_CHARREF_sub: Final = re_compile("\\[\x02([0-9]+)\\]").sub
+CRE_SHARE_LINK_search1 = re_compile(r"(?:/s/|share\.115\.com/)(?P<share_code>[a-z0-9]+)\?password=(?:(?P<receive_code>[a-z0-9]{4}))?").search
+CRE_SHARE_LINK_search2 = re_compile(r"(?P<share_code>[a-z0-9]+)(?:-(?P<receive_code>[a-z0-9]{4}))?").search
+
+
+class SharePayload(TypedDict):
+    share_code: str
+    receive_code: None | str
+
+
+def get_status(e: BaseException, /) -> None | int:
+    """获取 HTTP 请求异常的状态码（如果有的话）
+    """
+    status = (
+        getattr(e, "status", None) or 
+        getattr(e, "code", None) or 
+        getattr(e, "status_code", None)
+    )
+    if status is None and hasattr(e, "response"):
+        response = e.response
+        status = (
+            getattr(response, "status", None) or 
+            getattr(response, "code", None) or 
+            getattr(response, "status_code", None)
+        )
+    return status
+
+
+def is_timeouterror(exc: BaseException) -> bool:
+    """判断是不是超时异常
+    """
+    exctype = type(exc)
+    if issubclass(exctype, TimeoutError):
+        return True
+    for exctype in exctype.mro():
+        if "Timeout" in exctype.__name__:
+            return True
+    return False
+
+
+def posix_escape_name(name: str, /, repl: str = "|") -> str:
+    """把文件名中的 "/" 转换为另一个字符（默认为 "|"）
+
+    :param name: 文件名
+    :param repl: 替换为的目标字符
+
+    :return: 替换后的名字
+    """
+    return name.replace("/", repl)
+
+
+def reduce_image_url_layers(url: str, /, size: str | int = "") -> str:
+    """从图片的缩略图链接中提取信息，以减少一次 302 访问
+    """
+    if not url.startswith(("http://thumb.115.com/", "https://thumb.115.com/")):
+        return url
+    urlp = urlsplit(url)
+    sha1, _, size0 = urlp.path.rsplit("/")[-1].partition("_")
+    if size == "":
+        size = size0 or "0"
+    return f"https://imgjump.115.com/?sha1={sha1}&{urlp.query}&size={size}"
+
+
+def share_extract_payload(link: str, /) -> SharePayload:
+    """从链接中提取 share_code 和 receive_code
+
+    .. hint::
+        `link` 支持 3 种形式（圆括号中的字符表示可有可无）：
+
+        1. http(s)://115.com/s/{share_code}?password={receive_code}(#) 或 http(s)://share.115.com/{share_code}?password={receive_code}(#)
+        2. (/){share_code}-{receive_code}(/)
+        3. {share_code}
+    """
+    m = CRE_SHARE_LINK_search1(link)
+    if m is None:
+        m = CRE_SHARE_LINK_search2(link)
+    if m is None:
+        raise ValueError("not a valid 115 share link")
+    return cast(SharePayload, m.groupdict())
+
+
+def unescape_115_charref(s: str, /) -> str:
+    """对 115 的字符引用进行解码
+
+    :example:
+
+        .. code:: python
+
+            unescape_115_charref("[\x02128074]0号：优质资源") == "👊0号：优质资源"
+    """
+    return CRE_115_CHARREF_sub(lambda a: chr(int(a[1])), s)
+

p115client/tool/xys.py

@@ -2,45 +2,156 @@
 # encoding: utf-8
 
 __author__ = "ChenyangGao <https://chenyanggao.github.io>"
-__all__ = ["wish_make", "wish_answer", "wish_list", "wish_aid_list", "wish_adopt"]
+__all__ = [
+    "wish_info", "wish_make", "wish_answer", "wish_adopt", 
+    "wish_del", "wish_iter", "wish_aid_iter", 
+]
 
-from collections.abc import Iterable
+from collections.abc import AsyncIterator, Coroutine, Iterable, Iterator
+from typing import overload, Any, Literal
 
+from iterutils import run_gen_step, run_gen_step_iter, YieldFrom
 from p115client import check_response, P115Client
+from p115client.type import P115StrID
 
 
+@overload
+def wish_info(
+    client: str | P115Client, 
+    wish_id: str, 
+    *, 
+    async_: Literal[False] = False, 
+    **request_kwargs, 
+) -> dict:
+    ...
+@overload
+def wish_info(
+    client: str | P115Client, 
+    wish_id: str, 
+    *, 
+    async_: Literal[True], 
+    **request_kwargs, 
+) -> Coroutine[Any, Any, dict]:
+    ...
+def wish_info(
+    client: str | P115Client, 
+    wish_id: str, 
+    *, 
+    async_: Literal[False, True] = False, 
+    **request_kwargs, 
+) -> dict | Coroutine[Any, Any, dict]:
+    """许愿树活动：许愿信息
+
+    :param client: 115 客户端或 cookies
+    :param wish_id: 许愿 id
+    :param async_: 是否异步
+    :param request_kwargs: 其它请求参数
+
+    :return: 许愿信息
+    """
+    if isinstance(client, str):
+        client = P115Client(client)
+    def gen_step():
+        resp = yield client.act_xys_get_desire_info(
+            wish_id, 
+            async_=async_, 
+            **request_kwargs, 
+        )
+        check_response(resp)
+        return resp["data"]
+    return run_gen_step(gen_step, async_=async_)
+
+
+@overload
+def wish_make(
+    client: str | P115Client, 
+    content: str = "随便许个愿", 
+    size: int = 5, 
+    *, 
+    async_: Literal[False] = False, 
+    **request_kwargs, 
+) -> P115StrID:
+    ...
+@overload
+def wish_make(
+    client: str | P115Client, 
+    content: str = "随便许个愿", 
+    size: int = 5, 
+    *, 
+    async_: Literal[True], 
+    **request_kwargs, 
+) -> Coroutine[Any, Any, P115StrID]:
+    ...
 def wish_make(
     client: str | P115Client, 
     content: str = "随便许个愿", 
     size: int = 5, 
-) -> str:
+    *, 
+    async_: Literal[False, True] = False, 
+    **request_kwargs, 
+) -> P115StrID | Coroutine[Any, Any, P115StrID]:
     """许愿树活动：创建许愿（许愿创建后需要等审核）
 
     :param client: 115 客户端或 cookies
     :param content: 许愿内容
     :param size: 答谢空间大小，单位是 GB
+    :param async_: 是否异步
+    :param request_kwargs: 其它请求参数
 
     :return: 许愿 id
     """
     if isinstance(client, str):
         client = P115Client(client)
-    return check_response(client.act_xys_wish(
-        {"rewardSpace": size, "content": content}
-    ))["data"]["xys_id"]
+    def gen_step():
+        resp = yield client.act_xys_wish(
+            {"rewardSpace": size, "content": content}, 
+            async_=async_, 
+            **request_kwargs, 
+        )
+        check_response(resp)
+        return P115StrID(resp["data"]["xys_id"], resp["data"])
+    return run_gen_step(gen_step, async_=async_)
 
 
+@overload
 def wish_answer(
     client: str | P115Client, 
     wish_id: str, 
     content: str = "帮你助个愿", 
     file_ids: int | str | Iterable[int | str] = "", 
-) -> str:
+    *, 
+    async_: Literal[False] = False, 
+    **request_kwargs, 
+) -> P115StrID:
+    ...
+@overload
+def wish_answer(
+    client: str | P115Client, 
+    wish_id: str, 
+    content: str = "帮你助个愿", 
+    file_ids: int | str | Iterable[int | str] = "", 
+    *, 
+    async_: Literal[True], 
+    **request_kwargs, 
+) -> Coroutine[Any, Any, P115StrID]:
+    ...
+def wish_answer(
+    client: str | P115Client, 
+    wish_id: str, 
+    content: str = "帮你助个愿", 
+    file_ids: int | str | Iterable[int | str] = "", 
+    *, 
+    async_: Literal[False, True] = False, 
+    **request_kwargs, 
+) -> P115StrID | Coroutine[Any, Any, P115StrID]:
     """许愿树活动：创建助愿（助愿创建后需要等审核）
 
     :param client: 115 客户端或 cookies
     :param wish_id: 许愿 id
     :param content: 助愿内容
     :param file_ids: 文件在你的网盘的 id，多个用逗号 "," 隔开
+    :param async_: 是否异步
+    :param request_kwargs: 其它请求参数
 
     :return: 助愿 id
     """
@@ -48,78 +159,234 @@ def wish_answer(
         client = P115Client(client)
     if not isinstance(file_ids, (int, str)):
         file_ids = ",".join(map(str, file_ids))
-    check_response(client.act_xys_get_desire_info(wish_id))
-    return check_response(
-        client.act_xys_aid_desire({"id": wish_id, "content": content, "file_ids": file_ids}
-    ))["data"]["aid_id"]
+    def gen_step():
+        resp = yield client.act_xys_aid_desire(
+            {"id": wish_id, "content": content, "file_ids": file_ids}, 
+            async_=async_, 
+            **request_kwargs, 
+        )
+        check_response(resp)
+        return P115StrID(resp["data"]["aid_id"], resp["data"])
+    return run_gen_step(gen_step, async_=async_)
 
 
-def wish_list(
+@overload
+def wish_adopt(
     client: str | P115Client, 
-    type: int = 0, 
-) -> list[dict]:
-    """许愿树活动：我的许愿列表
+    wish_id: str, 
+    aid_id: int | str, 
+    to_cid: int = 0, 
+    *, 
+    async_: Literal[False] = False, 
+    **request_kwargs, 
+) -> dict:
+    ...
+@overload
+def wish_adopt(
+    client: str | P115Client, 
+    wish_id: str, 
+    aid_id: int | str, 
+    to_cid: int = 0, 
+    *, 
+    async_: Literal[True], 
+    **request_kwargs, 
+) -> Coroutine[Any, Any, dict]:
+    ...
+def wish_adopt(
+    client: str | P115Client, 
+    wish_id: str, 
+    aid_id: int | str, 
+    to_cid: int = 0, 
+    *, 
+    async_: Literal[False, True] = False, 
+    **request_kwargs, 
+) -> dict | Coroutine[Any, Any, dict]:
+    """许愿树活动：采纳助愿
 
     :param client: 115 客户端或 cookies
-    :param type: 类型
-        - 0: 全部
-        - 1: 进行中
-        - 2: 已实现
+    :param wish_id: 许愿 id
+    :param aid_id: 助愿 id
+    :param to_cid: 助愿的分享文件保存到你的网盘中目录的 id
+    :param async_: 是否异步
+    :param request_kwargs: 其它请求参数
 
-    :return: 许愿列表
+    :return: 接口的返回信息
     """
     if isinstance(client, str):
         client = P115Client(client)
-    payload: dict = {"type": type, "limit": 1000, "page": 1}
-    ls = adds = check_response(client.act_xys_my_desire(payload))["data"]["list"]
-    while len(adds) == 1000:
-        payload["page"] += 1
-        adds = check_response(client.act_xys_my_desire(payload))["data"]["list"]
-        ls.extend(adds)
-    return ls
+    return check_response(client.act_xys_adopt(
+        {"did": wish_id, "aid": aid_id, "to_cid": to_cid}, 
+        async_=async_, 
+        **request_kwargs, 
+    ))
 
 
-def wish_aid_list(
+@overload
+def wish_del(
     client: str | P115Client, 
-    wish_id: str, 
-) -> list[dict]:
-    """许愿树活动：许愿的助愿列表
+    wish_id: str | Iterable[str], 
+    *, 
+    async_: Literal[False] = False, 
+    **request_kwargs, 
+) -> dict:
+    ...
+@overload
+def wish_del(
+    client: str | P115Client, 
+    wish_id: str | Iterable[str], 
+    *, 
+    async_: Literal[True], 
+    **request_kwargs, 
+) -> Coroutine[Any, Any, dict]:
+    ...
+def wish_del(
+    client: str | P115Client, 
+    wish_id: str | Iterable[str], 
+    *, 
+    async_: Literal[False, True] = False, 
+    **request_kwargs, 
+) -> dict | Coroutine[Any, Any, dict]:
+    """许愿树活动：许愿信息
 
     :param client: 115 客户端或 cookies
     :param wish_id: 许愿 id
+    :param async_: 是否异步
+    :param request_kwargs: 其它请求参数
 
-    :return: 助愿列表
+    :return: 接口的返回信息
     """
     if isinstance(client, str):
         client = P115Client(client)
-    payload: dict = {"id": wish_id, "limit": 1000, "page": 1}
-    ls = adds = check_response(client.act_xys_desire_aid_list(payload))["data"]["list"]
-    while len(adds) == 1000:
-        payload["page"] += 1
-        adds = check_response(client.act_xys_desire_aid_list(payload))["data"]["list"]
-        ls.extend(adds)
-    return ls
+    if not isinstance(wish_id, str):
+        wish_id = ",".join(wish_id)
+    return check_response(client.act_xys_wish_del(
+        wish_id, 
+        async_=async_, 
+        **request_kwargs, 
+    ))
 
 
-def wish_adopt(
+@overload
+def wish_iter(
+    client: str | P115Client, 
+    type: int = 0, 
+    page_size: int = 1_000, 
+    *, 
+    async_: Literal[False] = False, 
+    **request_kwargs, 
+) -> Iterator[dict]:
+    ...
+@overload
+def wish_iter(
+    client: str | P115Client, 
+    type: int = 0, 
+    page_size: int = 1_000, 
+    *, 
+    async_: Literal[True], 
+    **request_kwargs, 
+) -> AsyncIterator[dict]:
+    ...
+def wish_iter(
+    client: str | P115Client, 
+    type: int = 0, 
+    page_size: int = 1_000, 
+    *, 
+    async_: Literal[False, True] = False, 
+    **request_kwargs, 
+) -> Iterator[dict] | AsyncIterator[dict]:
+    """许愿树活动：罗列我的许愿列表
+
+    :param client: 115 客户端或 cookies
+    :param type: 类型
+
+        - 0: 全部
+        - 1: 进行中
+        - 2: 已实现
+
+    :param page_size: 分页大小
+    :param async_: 是否异步
+    :param request_kwargs: 其它请求参数
+
+    :return: 迭代器，逐个返回许愿许愿信息
+    """
+    if isinstance(client, str):
+        client = P115Client(client)
+    if page_size <= 0:
+        page_size = 1_000
+    def gen_step():
+        payload: dict = {"type": type, "limit": page_size, "page": 1}
+        while True:
+            resp = yield client.act_xys_my_desire(
+                payload, 
+                async_=async_, 
+                **request_kwargs, 
+            )
+            check_response(resp)
+            ls = resp["data"]["list"]
+            yield YieldFrom(ls, identity=True)
+            if not ls:
+                break
+            payload["page"] += 1
+    return run_gen_step_iter(gen_step, async_=async_)
+
+
+@overload
+def wish_aid_iter(
     client: str | P115Client, 
     wish_id: str, 
-    aid_id: int | str, 
-    to_cid: int = 0, 
-) -> dict:
-    """许愿树活动：采纳助愿
+    page_size: int = 1_000, 
+    *, 
+    async_: Literal[False] = False, 
+    **request_kwargs, 
+) -> Iterator[dict]:
+    ...
+@overload
+def wish_aid_iter(
+    client: str | P115Client, 
+    wish_id: str, 
+    page_size: int = 1_000, 
+    *, 
+    async_: Literal[True], 
+    **request_kwargs, 
+) -> AsyncIterator[dict]:
+    ...
+def wish_aid_iter(
+    client: str | P115Client, 
+    wish_id: str, 
+    page_size: int = 1_000, 
+    *, 
+    async_: Literal[False, True] = False, 
+    **request_kwargs, 
+) -> Iterator[dict] | AsyncIterator[dict]:
+    """许愿树活动：许愿的助愿列表
 
     :param client: 115 客户端或 cookies
     :param wish_id: 许愿 id
-    :param aid_id: 助愿 id
-    :param to_cid: 助愿的分享文件保存到你的网盘中目录的 id
+    :param page_size: 分页大小
+    :param async_: 是否异步
+    :param request_kwargs: 其它请求参数
 
-    :return: 返回信息
+    :return: 迭代器，逐个返回助愿信息
     """
     if isinstance(client, str):
         client = P115Client(client)
-    return check_response(client.act_xys_adopt({"did": wish_id, "aid": aid_id, "to_cid": to_cid}))
+    if page_size <= 0:
+        page_size = 1_000
+    def gen_step():
+        payload: dict = {"id": wish_id, "limit": page_size, "page": 1}
+        while True:
+            resp = yield client.act_xys_desire_aid_list(
+                payload, 
+                async_=async_, 
+                **request_kwargs, 
+            )
+            check_response(resp)
+            ls = resp["data"]["list"]
+            yield YieldFrom(ls, identity=True)
+            if not ls:
+                break
+            payload["page"] += 1
+    return run_gen_step_iter(gen_step, async_=async_)
 
-# TODO: 再实现一个漂流瓶
-# TODO: 支持异步
 
+# TODO: 再实现一个漂流瓶

p115client/type.py

@@ -2,7 +2,10 @@
 # encoding: utf-8
 
 __author__ = "ChenyangGao <https://chenyanggao.github.io>"
-__all__ = ["MultipartResumeData", "P115Cookies", "P115DictAttrLikeMixin", "P115DictAttrLike", "P115URL"]
+__all__ = [
+    "MultipartResumeData", "P115Cookies", "P115DictAttrLikeMixin", "P115DictAttrLike", 
+    "P115ID", "P115StrID", "P115URL", 
+]
 
 from collections.abc import Callable
 from functools import cached_property
@@ -199,6 +202,18 @@ class P115DictAttrLike(P115DictAttrLikeMixin):
         return type(name, (base, cls), ns)
 
 
+class P115ID(P115DictAttrLike, int):
+    """整数 id 的封装
+    """
+    def __str__(self, /) -> str:
+        return int.__repr__(self)
+
+
+class P115StrID(P115DictAttrLike, str):
+    """字符串 id 的封装
+    """
+
+
 class P115URL(P115DictAttrLike, str):
     """下载链接的封装
     """

{p115client-0.0.5.9.3.dist-info → p115client-0.0.5.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: p115client
-Version: 0.0.5.9.3
+Version: 0.0.5.10
 Summary: Python 115 webdisk client.
 Home-page: https://github.com/ChenyangGao/p115client
 License: MIT
@@ -108,7 +108,7 @@ client = P115Client(Path("~/115-cookies.txt").expanduser(), check_for_relogin=Tr
 
 如果你有一个申请通过的开放接口的应用，则可以创建开放接口的客户端实例
 
-你可以直接从一个 `P115Client` 实例拿到授权（自动扫码登录并授权）
+你可以直接从一个 `P115Client` 实例拿到授权（自动扫码登录并授权），如果不提供 `app_id`，则使用默认值
 
 ```python
 app_id = <开放接口应用的 AppID>
@@ -143,7 +143,7 @@ from p115client import P115Client, P115OpenClient
 from pathlib import Path
 
 client = P115Client(Path("~/115-cookies.txt").expanduser(), check_for_relogin=True)
-client_open = client.login_another_open(app_id)
+client_open = client.login_another_open()
 ```
 
 ### 2. 接口调用