Merge pull request #404 from Nemo2011/dev

.github/CODING.md

@@ -8,9 +8,11 @@
 
 **入门示例：我要贡献一个 API !**
 
-首先你需要写入你的 API，找到 `bilibili_api/data/api` 目录，会有许多的 `json` 文件，你需要找到对应的 `json` 文件介入你的 API。举个例子：你的 API 如果和用户有关，请写入 `user.json` 文件中。<br>
+首先你需要写入你的 API，找到 `bilibili_api/data/api` 目录，会有许多的 `json` 文件，你需要找到对应的 `json` 文件介入你的 API。举个例子：你的 API 如果和用户有关，请写入 `user.json` 文件中。
+
 每一个 `json` 文件会根据 API 的作用大致分类，你只要找到对应的分类就可以了。一般 `json` 文件将分为两个分类：`info` (有关获取信息的 API) 和 `operate` (有关操作用户相关信息的 API)。当然有的时候部分 API 也会被归类到另外一个分类，如 `video.json` 中有一个分类就存放着有关弹幕的 API (`danmaku`)。除非有大量与某个东西相关的 API (如视频 API 有许多是和弹幕有关的)，否则千万不要创建在 `info` 和 `operate` 以外的新的分类。<br>
-~~当然有的文件因为懒什么分类都没有弄，在 API 非常少的时候你可以这么做，但是不推荐。~~<br><br>
+~~当然有的文件因为懒什么分类都没有弄，在 API 非常少的时候你可以这么做，但是不推荐。~~
+
 然后你就可以进行编写了。首先找到对应的文件 (如和视频相关的 API 的具体实现要写在 `video.py` 中)，然后 (在一个类里面 ( 有的时候不用写在一个类里面 )) 新建一个异步函数，一定要记得完善参数类型和返回值类型。( 建议让你的 IDE 打开检查 `typing` 的模式，就例如 `Visual Studio Code` 里面将 `python.analysis.typeCheckingMode` 设置为 `basic` 或 `strict`)。接着你需要编写注释，像下面那样子编写：
 
 ``` python
@@ -27,7 +29,11 @@ async def get_user_real_name(self, uid: int, credential: Union[Credential, None]
     """
 ```
 
-首先你要写上函数的用途，然后要写好参数的说明：名称 + 类型 + 用途。其中类型如果是多个的话，那么可以用 `|` 分隔而不是用 `Union` (写代码的时候务必要用 `Union`，需要支持 `Python3.8`)，如果你的 API 需要登录的话，你要加上 `credential` 参数，类型是 `Credential | None`，描述可以用 `凭据类。`。(凭据类能传入 cookies 以保证能正常访问需要登录的 API，这里就做到了登录的作用 ) 最后要把返回值写好，一般情况下 API 返回的结果类型都是 `dict`，这个时候你的返回值说明就可以用 `调用 API 返回的结果`。<br>
+首先你要写上函数的用途，然后要写好参数的说明：名称 + 类型 + 用途。其中类型如果是多个的话，那么写注释时可以用 `|` 分隔而不是用 `Union`，但写代码的时候务必要用 `Union`，需要支持 `Python3.8`。
+
+如果你的 API 需要登录的话，你要加上 `credential` 参数，类型是 `Credential | None`，描述可以用 `凭据类。`。(凭据类能传入 cookies 以保证能正常访问需要登录的 API，这里就做到了登录的作用 ) 
+
+最后要把返回值写好，一般情况下 API 返回的结果类型都是 `dict`，这个时候你的返回值说明就可以用 `调用 API 返回的结果`。<br>
 然后就是函数的主体了，你可以按照下面的写法来写：
 
 ``` python
@@ -40,14 +46,22 @@ async def ...(...) -> dict:
     params = {
         ...
     }
-    return await request("GET", api["url"], params=params, credential=credential)
+    return await Api(**api, credential=credential).update_params(**params).result
 ```
 
-首先如果函数要传入凭据类，那么你要添加 `credential = credential if credential else Credential()` 以确保 `credential` 参数不会是 `None` 类型，~~当然不这么做也不会报错，但是你好歹要走个形式啊！~~。接着我们声明 `api` 变量，它是字典 `API` 的一部分，这里的字典 `API` 就是你写入 API 的那个 `json` 文件的内容。所以你的 API 也在里面，你只需要补充好字典的键值就可以了。接着就是可选的 `params` 或 `data`，如果你的 API 需要传入参数的话不要忘记创建它们。最后你只需要返回已经封装好了的函数 `request` 得到的结果就可以了。`request` 函数的第一个参数是访问 `API` 的方法，一般是 `GET`/`POST`/`PUT`/`DELETE`/`PATCH`，第二个参数是 `API` 的链接，你只需要填入 `api["url"]` 就可以了 ( 前提是你的键值没有输错 )，下面的参数最好要指定名称传参，最后不要忘记了：如果这个接口需要登录，那么你得要把凭据类传入进去！( 如果你的函数是在一个类里面，通常每一个类都有一个属性 `credential`，就是创建这个类的时候会传入的，这个时候你只需要传入 `self.credential` 就可以了。当然参数里面不用再写 `credential` 参数了！！ )<br><br>
+1. 首先如果函数要传入凭据类，那么你应该创建变量 `credential = credential if credential else Credential()` 以确保 `credential` 参数不会是 `None` 类型，~~当然不这么做也不会报错，但是你好歹要走个形式啊！~~。
+
+2. 接着我们声明 `api` 变量，它是字典 `API` 的一部分，这里的字典 `API` 就是你写入 API 的那个 `json` 文件的内容。
+所以你的 API 也在里面，你只需要补充好字典的键值就可以了。接着就是可选的 `params` 或 `data`，如果你的 API 需要传入参数的话不要忘记传入它们。
+
+3. 最后你只需要返回已经封装好了的函数 `Api` 得到的结果就可以了。`Api` 函数的第一个参数是 `**api`，通常里面包括 HTTP 方法、URL 等信息，`params`/`data`/`headers`/`files`参数应该通过 `Api().update()`/`Api().update_headers()` 等传入。
+
+4. 不要忘记了：如果这个接口需要登录，那么你得把凭据类传入进去！( 如果你的函数是在一个类里面，通常每一个类都有一个属性 `credential`，就是创建这个类的时候会传入的，这个时候你只需要传入 `self.credential` 就可以了。当然参数里面不用再写 `credential` 参数了！！ )<br><br>
+
 恭喜你完成了代码的编写！你可以先进行一次新功能的提交：
 
 ``` bash
-$ git commit -am "feat(user.User): 新增一个狗都不用的接口"
+$ git commit -am "feat(user.User): 新增一个 ### 的接口"
 ```
 
 然后你还需要干两件事情：文档 & 测试。这里不详细说明了，因为这里不会提及除了写代码以外的任何事情。SO...
@@ -56,13 +70,7 @@ $ git commit -am "feat(user.User): 新增一个狗都不用的接口"
 
 当然，除了这个指南举的简单 API 样例，你还可以学习更加高级的功能，例如新建一个模块、事件监听器、`protobuf` 数据等等，这里~~因为懒~~先不写了，你可以查看这些功能的样例进行学习。
 
-所以做完功能不要忘记提交到线上仓库！ (**PR 记得向 `dev` 分之提交！！！**)
-
-<details>
-<summary>看不见我</summary>
+所以做完功能不要忘记提交到 Github 仓库！ 
 
-``` bash
-$ git push origin dev;git push origin dev;git push origin dev;git push origin dev;git push origin dev;git push origin dev;git push origin dev;git push origin dev;git push origin dev;git push origin dev;git push origin dev;git push origin dev;git push origin dev;git push origin dev;git push origin dev;git push origin dev;git push origin dev;git push origin dev;git push origin dev;git push origin dev;git push origin dev;git push origin dev;git push origin dev;git push origin dev;git push origin dev;
-```
+**PR 记得向 `dev` 分支提交！！！ `git push origin dev`**
 
-</details>

.github/ISSUE_TEMPLATE/documentation.md

@@ -1,7 +1,7 @@
 ---
 name: 文档勘误
 about: 使用该模板汇报文档错误
-title: "【文档】 这里填写标题"
+title: "[文档]  这里填写标题"
 labels: 'documentation'
 assignees: ''
 

.github/ISSUE_TEMPLATE/needs.md

@@ -1,7 +1,7 @@
 ---
 name: 提交需求
 about: 使用该模板进行提交需求
-title: "【需求】{这里填写标题}"
+title: "[需求] {这里填写标题}"
 labels: 'need'
 assignees: ''
 

.github/ISSUE_TEMPLATE/question.md

@@ -1,7 +1,7 @@
 ---
 name: 提出疑问
 about: 使用该模板进行提问
-title: "【提问】{这里填写标题}"
+title: "[提问] {这里填写标题}"
 labels: 'question'
 assignees: ''
 
@@ -13,6 +13,8 @@ assignees: ''
 
 **运行环境：** Windows / Linux / MacOS
 
+<!-- 务必提供模块版本并确保为最新版 -->
+
 ---
 
 在此处写正文

.github/ISSUE_TEMPLATE/suggestion.md

@@ -1,7 +1,7 @@
 ---
 name: 建言献策
 about: 使用该模板提建议
-title: "【建议】{这里填写标题}"
+title: "[建议] {这里填写标题}"
 labels: '建议'
 assignees: 'enhancement'
 

.github/ISSUE_TEMPLATE/troubleshooting.md

@@ -1,7 +1,7 @@
 ---
 name: 漏洞反馈
 about: 使用该模板进行漏洞反馈
-title: "【漏洞】{这里填写标题}"
+title: "[漏洞] {这里填写标题}"
 labels: 'bug'
 assignees: ''
 
@@ -21,6 +21,8 @@ assignees: ''
 
 **报错信息：**
 
+<!-- 务必提供模块版本并确保为最新版 -->
+
 ```
 这里填写报错信息
 ```

CHANGELOGS/v15.md

@@ -1,3 +1,16 @@
+# 15.5.2 2023/7/25
+- fix: 修改新请求函数为 Api 方法 by @Drelf2018 in https://github.com/Nemo2011/bilibili-api/pull/364
+- fix: 尝试修复发送图片私信的问题 by @Drelf2018 in https://github.com/Nemo2011/bilibili-api/pull/367
+- fix: 修复 params 中有汉字时计算 w_rid 错误的漏洞以及弹幕用户名打码问题 by @Drelf2018 in https://github.com/Nemo2011/bilibili-api/pull/373
+- fix: update get_followings by @z0z0r4 in https://github.com/Nemo2011/bilibili-api/pull/381
+- rechore: login term and tk by @z0z0r4 in https://github.com/Nemo2011/bilibili-api/pull/383
+* fix: import by @Nemo2011 https://github.com/Nemo2011/bilibili-api/commit/dacefba0d909a5dbbc9213100267b84bc54581d5
+* style:  by @Nemo2011 https://github.com/Nemo2011/bilibili-api/commit/9ca10d2bb534a216e6dabadb1fb0c5093548b11d
+* feat: settings.wbi_retry_times by @Nemo2011 https://github.com/Nemo2011/bilibili-api/commit/54087564b9a68cac800664d00846abf35b3d204e
+* fix: testing & login by @Nemo2011 https://github.com/Nemo2011/bilibili-api/commit/b329fe6d16022981c89ffa2bec8738ce96881afd
+* fix: buvid3 by @z0z0r4 in https://github.com/Nemo2011/bilibili-api/pull/391
+* rechore: 将 `request` 换到 `Api` by @z0z0r4 https://github.com/Nemo2011/bilibili-api/pull/403
+
 # 15.5.1 2023/6/24
 
 - fix: credential 刷新异步问题 (https://github.com/Nemo2011/bilibili-api/issues/351) (https://github.com/Nemo2011/bilibili-api/issues/358)

bilibili_api/__init__.py

@@ -7,83 +7,83 @@
 import asyncio
 import platform
 
+from .utils.sync import sync
+from .credential import Credential
+from .utils.picture import Picture
+from .utils.short import get_real_url
+from .utils.parse_link import ResourceType, parse_link
+from .utils.aid_bvid_transformer import aid2bvid, bvid2aid
+from .utils.danmaku import DmMode, Danmaku, DmFontSize, SpecialDanmaku
+from .utils.network_httpx import (
+    HEADERS,
+    Api,
+    retry,
+    enc_wbi,
+    get_nav,
+    request,
+    check_valid,
+    get_session,
+    set_session,
+    get_mixin_key,
+)
+from .errors import (
+    LoginError,
+    ApiException,
+    ArgsException,
+    LiveException,
+    NetworkException,
+    ResponseException,
+    VideoUploadException,
+    ResponseCodeException,
+    DanmakuClosedException,
+    CredentialNoBuvid3Exception,
+    CredentialNoBiliJctException,
+    DynamicExceedImagesException,
+    CredentialNoSessdataException,
+    CredentialNoDedeUserIDException,
+)
 from . import (
-    album,
     app,
-    article,
-    article_category,
     ass,
-    audio,
-    bangumi,
-    black_room,
-    channel,
-    channel_series,
-    cheese,
-    client,
-    comment,
-    creative_center,
-    dynamic,
-    emoji,
-    favorite_list,
-    game,
-    homepage,
     hot,
-    interactive_video,
+    game,
     live,
-    live_area,
-    login,
-    login_func,
-    manga,
     note,
     rank,
+    user,
+    vote,
+    album,
+    audio,
+    emoji,
+    login,
+    manga,
+    topic,
+    video,
+    cheese,
+    client,
     search,
+    article,
+    bangumi,
+    channel,
+    comment,
+    dynamic,
     session,
+    homepage,
     settings,
-    topic,
-    user,
-    video,
+    live_area,
     video_tag,
-    video_uploader,
+    black_room,
+    login_func,
     video_zone,
-    vote,
-)
-from .errors import (
-    ApiException,
-    ArgsException,
-    CredentialNoBiliJctException,
-    CredentialNoBuvid3Exception,
-    CredentialNoDedeUserIDException,
-    CredentialNoSessdataException,
-    DanmakuClosedException,
-    DynamicExceedImagesException,
-    LiveException,
-    LoginError,
-    NetworkException,
-    ResponseCodeException,
-    ResponseException,
-    VideoUploadException,
-)
-from .credential import Credential
-from .utils.aid_bvid_transformer import aid2bvid, bvid2aid
-from .utils.danmaku import Danmaku, DmFontSize, DmMode, SpecialDanmaku
-from .utils.network_httpx import (
-    HEADERS,
-    Api,
-    check_valid,
-    enc_wbi,
-    get_mixin_key,
-    get_nav,
-    get_session,
-    request,
-    retry,
-    set_session,
+    favorite_list,
+    channel_series,
+    video_uploader,
+    creative_center,
+    article_category,
+    interactive_video,
 )
-from .utils.parse_link import ResourceType, parse_link
-from .utils.picture import Picture
-from .utils.short import get_real_url
-from .utils.sync import sync
 
-BILIBILI_API_VERSION = "15.5.1.b0"
+BILIBILI_API_VERSION = "15.5.2"
 
 # 如果系统为 Windows，则修改默认策略，以解决代理报错问题
 if "windows" in platform.system().lower():

bilibili_api/_pyinstaller/entry_points.py

@@ -1,5 +1,5 @@
-from typing import List
 import os
+from typing import List
 
 
 def get_hook_dirs() -> List[str]:

bilibili_api/_pyinstaller/hook-bilibili_api.py

@@ -1,4 +1,5 @@
-from PyInstaller.utils.hooks import collect_data_files
 from typing import List, Tuple
 
+from PyInstaller.utils.hooks import collect_data_files
+
 datas: List[Tuple[str, str]] = collect_data_files("bilibili_api")

bilibili_api/album.py

@@ -4,13 +4,14 @@
 相簿相关
 """
 
+import enum
 from typing import Any, List, Union, Optional
+
 from .utils.utils import get_api
-from .utils.network_httpx import request
-from .utils.credential import Credential
 from .utils.picture import Picture
 from .exceptions import ArgsException
-import enum
+from .utils.credential import Credential
+from .utils.network_httpx import Api
 
 API = get_api("album")
 
@@ -72,7 +73,7 @@ async def get_info(self) -> dict:
         """
         api = API["info"]["detail"]
         params = {"doc_id": self.get_doc_id()}
-        resp = await request("GET", api["url"], params=params)
+        resp = await Api(**api).update_params(**params).result
         self.__info = resp
         return resp
 
@@ -141,14 +142,14 @@ async def get_painter() -> dict:
         if order != AlbumOrder.RECOMMEND:
             raise ArgsException("摄影相簿暂不支持以热度/以时间排序。")
         params = {"type": order.value, "page_num": page_num, "page_size": page_size}
-        return await request("GET", api["url"], params=params, credential=credential)
+        return await Api(**api, credential=credential).update_params(**params).result
 
     async def get_photos() -> dict:
         api = API["info"]["homepage_photos_albums_list"]
         if order != AlbumOrder.RECOMMEND:
             raise ArgsException("摄影相簿暂不支持以热度/以时间排序。")
         params = {"type": order.value, "page_num": page_num, "page_size": page_size}
-        return await request("GET", api["url"], params=params, credential=credential)
+        return await Api(**api, credential=credential).update_params(**params).result
 
     if category == AlbumCategory.PAINTS:
         return await get_painter()
@@ -183,12 +184,12 @@ async def get_homepage_recommend_uppers(
     async def get_painters() -> dict:
         api = API["info"]["homepage_recommended_painters"]
         params = {"num": numbers}
-        return await request("GET", api["url"], params=params, credential=credential)
+        return await Api(**api, credential=credential).update_params(**params).result
 
     async def get_photos_uppers() -> dict:
         api = API["info"]["homepage_recommended_photos_uppers"]
         params = {"num": numbers}
-        return await request("GET", api["url"], params=params, credential=credential)
+        return await Api(**api, credential=credential).update_params(**params).result
 
     if category == AlbumCategory.PAINTS:
         return await get_painters()
@@ -234,4 +235,4 @@ async def get_user_albums(
         "page_num": page_num,
         "page_size": page_size,
     }
-    return await request("GET", api["url"], params=params, credential=credential)
+    return await Api(**api, credential=credential).update_params(**params).result