跳转至

HelperApi

modules.helper.HelperApi 

HelperApi(client: Client)

Bases: ApiModule

辅助功能 API.

Source code in qqmusic_api/modules/_base.py 
35
36
37
def __init__(self, client: "Client") -> None:
    self._client = client
    self._session = client._session

init_upload 

init_upload(
    bus_id: BUSINESS_TYPE,
    files: list[InitUploadFileDict],
    *,
    credential: Credential | None = None,
)

初始化 COS 上传以获取临时凭证.

Tips

具备 cos-python-sdk-v5 高级接口所需的所有权限.

PARAMETER DESCRIPTION
bus_id

业务 ID, 例如 "songlist", "avatar" 等.

TYPE: BUSINESS_TYPE

files

待上传文件信息列表, 每项需包含 "FileSha1", "FileName", "FileSize".

TYPE: list[InitUploadFileDict]

credential

请求凭证.

TYPE: Credential | None DEFAULT: None

Source code in qqmusic_api/modules/helper.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
def init_upload(
    self,
    bus_id: BUSINESS_TYPE,
    files: list[InitUploadFileDict],
    *,
    credential: Credential | None = None,
):
    """初始化 COS 上传以获取临时凭证.

    Tips:
        具备 `cos-python-sdk-v5` 高级接口所需的所有权限.

    Args:
        bus_id: 业务 ID, 例如 "songlist", "avatar" 等.
        files: 待上传文件信息列表, 每项需包含 "FileSha1", "FileName", "FileSize".
        credential: 请求凭证.
    """
    return self._build_cgi(
        module="music.filesys.FileSystem",
        method="InitUpload",
        param={
            "BusID": bus_id,
            "Files": files,
        },
        preserve_bool=False,
        sign=True,
        require_login=True,
        credential=credential,
        response_model=InitUploadResponse,
    )

finish_upload 

finish_upload(
    bus_id: BUSINESS_TYPE,
    results: list[FinishUploadResultDict],
    *,
    credential: Credential | None = None,
)

完成 COS 上传并通知服务器验证.

PARAMETER DESCRIPTION
bus_id

业务 ID.

TYPE: BUSINESS_TYPE

results

上传结果列表, 每项需包含 Storage 字典等信息.

TYPE: list[FinishUploadResultDict]

credential

请求凭证.

TYPE: Credential | None DEFAULT: None

Source code in qqmusic_api/modules/helper.py 
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
def finish_upload(
    self,
    bus_id: BUSINESS_TYPE,
    results: list[FinishUploadResultDict],
    *,
    credential: Credential | None = None,
):
    """完成 COS 上传并通知服务器验证.

    Args:
        bus_id: 业务 ID.
        results: 上传结果列表, 每项需包含 Storage 字典等信息.
        credential: 请求凭证.
    """
    return self._build_cgi(
        module="music.filesys.FileSystem",
        method="FinishUpload",
        param={
            "BusID": bus_id,
            "Results": results,
        },
        preserve_bool=False,
        sign=True,
        require_login=True,
        credential=credential,
        response_model=FinishUploadResponse,
    )