qqmusic-api-python 0.2.1__tar.gz → 0.3.0__tar.gz

{qqmusic_api_python-0.2.1 → qqmusic_api_python-0.3.0}/.gitignore

@@ -133,6 +133,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+.vscode/
 
 # Spyder project settings
 .spyderproject

{qqmusic_api_python-0.2.1 → qqmusic_api_python-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qqmusic-api-python
-Version: 0.2.1
+Version: 0.3.0
 Summary: QQ音乐API封装库
 Project-URL: homepage, https://luren-dc.github.io/QQMusicApi/
 Project-URL: repository, https://github.com/luren-dc/QQMusicApi
@@ -21,7 +21,8 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.10
-Requires-Dist: cryptography<44.0.1,>=44.0.0
+Requires-Dist: aiocache>=0.12.3
+Requires-Dist: cryptography<44.0.2,>=44.0.1
 Requires-Dist: httpx>=0.27.0
 Requires-Dist: typing-extensions>=4.12.2
 Description-Content-Type: text/markdown
@@ -94,6 +95,12 @@ async def main():
 asyncio.run(main())
 ```
 
+## Web API
+```
+docker build . -t qq-music-api
+docker run -d -p 8000:8000 qq-music-api
+```
+
 ## Licence
 
 本项目基于 **[MIT License](https://github.com/luren-dc/QQMusicApi?tab=MIT-1-ov-file)** 许可证发行。

{qqmusic_api_python-0.2.1 → qqmusic_api_python-0.3.0}/README.md

@@ -66,6 +66,12 @@ async def main():
 asyncio.run(main())
 ```
 
+## Web API
+```
+docker build . -t qq-music-api
+docker run -d -p 8000:8000 qq-music-api
+```
+
 ## Licence
 
 本项目基于 **[MIT License](https://github.com/luren-dc/QQMusicApi?tab=MIT-1-ov-file)** 许可证发行。

{qqmusic_api_python-0.2.1 → qqmusic_api_python-0.3.0}/pyproject.toml

@@ -5,9 +5,10 @@ authors = [
   { name = "Luren", email = "68656403+luren-dc@users.noreply.github.com" },
 ]
 dependencies = [
-  "cryptography>=44.0.0,<44.0.1",
+  "cryptography>=44.0.1,<44.0.2",
   "typing-extensions>=4.12.2",
   "httpx>=0.27.0",
+  "aiocache>=0.12.3",
 ]
 requires-python = ">=3.10"
 readme = "README.md"
@@ -67,6 +68,10 @@ docs = [
   "docstring-inheritance>=2.2.1",
   "griffe-modernized-annotations>=1.0.8",
 ]
+web = [
+    "fastapi>=0.115.8",
+    "uvicorn>=0.34.0",
+]
 
 [tool.commitizen]
 name = "cz_gitmoji"

qqmusic_api_python-0.3.0/qqmusic_api/__init__.py

@@ -0,0 +1,27 @@
+import logging
+
+from . import album, login, lyric, mv, search, singer, song, songlist, top, user
+from .utils.credential import Credential
+from .utils.session import Session, get_session, set_session
+
+__version__ = "0.3.0"
+
+logger = logging.getLogger("qqmusicapi")
+
+
+__all__ = [
+    "Credential",
+    "Session",
+    "album",
+    "get_session",
+    "login",
+    "lyric",
+    "mv",
+    "search",
+    "set_session",
+    "singer",
+    "song",
+    "songlist",
+    "top",
+    "user",
+]

qqmusic_api_python-0.3.0/qqmusic_api/album.py

@@ -0,0 +1,58 @@
+"""专辑相关 API"""
+
+from typing import Any, Literal
+
+from .utils.network import NO_PROCESSOR, api_request
+
+
+def get_cover(mid: str, size: Literal[150, 300, 500, 800] = 300) -> str:
+    """获取专辑封面链接
+
+    Args:
+        mid: 专辑 mid
+        size: 封面大小
+
+    Returns:
+        封面链接
+    """
+    if size not in [150, 300, 500, 800]:
+        raise ValueError("not supported size")
+    return f"https://y.gtimg.cn/music/photo_new/T002R{size}x{size}M000{mid}.jpg"
+
+
+@api_request("music.musichallAlbum.AlbumInfoServer", "GetAlbumDetail")
+async def get_detail(value: str | int):
+    """获取专辑详细信息
+
+    Args:
+        value: 专辑 id 或 mid
+    """
+    if isinstance(value, int):
+        return {"albumId": value}, NO_PROCESSOR
+
+    return {"albumMId": value}, NO_PROCESSOR
+
+
+@api_request("music.musichallAlbum.AlbumSongList", "GetAlbumSongList")
+async def get_song(value: str | int, num: int = 10, page: int = 1):
+    """获取专辑歌曲
+
+    Args:
+        value: 专辑 id 或 mid
+        num: 返回数量
+        page: 页码
+    """
+    params: dict[str, Any] = {
+        "begin": num * (page - 1),
+        "num": num,
+    }
+
+    def _processor(data: dict[str, Any]) -> list[dict[str, Any]]:
+        return [song["songInfo"] for song in data["songList"]]
+
+    if isinstance(value, int):
+        params["albumId"] = value
+    else:
+        params["albumMid"] = value
+
+    return params, _processor

qqmusic_api_python-0.3.0/qqmusic_api/login.py

@@ -0,0 +1,440 @@
+"""登录相关 API"""
+
+import mimetypes
+import random
+import re
+from dataclasses import dataclass
+from enum import Enum
+from pathlib import Path
+from time import time
+from typing import Any
+from uuid import uuid4
+
+import httpx
+
+from .exceptions.api_exception import CredentialExpiredError, LoginError
+from .utils.common import hash33
+from .utils.credential import Credential
+from .utils.network import ApiRequest
+from .utils.session import get_session
+
+
+async def check_expired(credential: Credential) -> bool:
+    """检查凭据是否过期
+
+    Args:
+        credential: 用户凭证
+    """
+    api = ApiRequest(
+        "music.UserInfo.userInfoServer",
+        "GetLoginUserInfo",
+        params={},
+        credential=credential,
+        cacheable=False,
+    )
+
+    try:
+        await api()
+        return False
+    except CredentialExpiredError:
+        return True
+
+
+async def refresh_cookies(credential: Credential) -> bool:
+    """刷新 Cookies
+
+    Note:
+        刷新无效 cookie 需要 `refresh_key` 和 `refresh_token` 字段
+
+    Args:
+        credential: 用户凭证
+
+    Returns:
+        是否刷新成功
+    """
+    params = {
+        "refresh_key": credential.refresh_key,
+        "refresh_token": credential.refresh_token,
+        "musickey": credential.musickey,
+        "musicid": credential.musicid,
+    }
+
+    api = ApiRequest[[], dict[str, Any]](
+        "music.login.LoginServer",
+        "Login",
+        common={"tmeLoginType": str(credential.login_type)},
+        params=params,
+        credential=credential,
+        cacheable=False,
+    )
+
+    try:
+        resp = await api()
+        c = credential.from_cookies_dict(resp)
+        credential.__dict__.update(c.__dict__)
+        return True
+    except CredentialExpiredError:
+        return False
+
+
+class QRCodeLoginEvents(Enum):
+    """二维码登录状态
+
+    + SCAN: 等待扫描二维码
+    + CONF: 已扫码未确认登录
+    + TIMEOUT: 二维码已过期
+    + DONE: 扫码成功
+    + REFUSE: 拒绝登录
+    + OTHER: 未知情况
+    """
+
+    DONE = (0, 405)
+    SCAN = (66, 408)
+    CONF = (67, 404)
+    TIMEOUT = (65, None)
+    REFUSE = (68, 403)
+    OTHER = (None, None)
+
+    @classmethod
+    def get_by_value(cls, value: int):
+        """根据传入的值查找对应的枚举成员"""
+        for member in cls:
+            if value in member.value:
+                return member
+        return cls.OTHER
+
+    ""
+
+
+class PhoneLoginEvents(Enum):
+    """手机登录状态
+
+    + SEND: 发送成功
+    + CAPTCHA: 需要滑块验证
+    + FREQUENCY: 频繁操作
+    + OTHER: 未知情况
+    """
+
+    SEND = 0
+    CAPTCHA = 20276
+    FREQUENCY = 100001
+    OTHER = None
+
+
+class QRLoginType(Enum):
+    """登录类型
+
+    + QQ: QQ登录
+    + WX: 微信登录
+    """
+
+    QQ = "qq"
+    WX = "wx"
+
+
+@dataclass()
+class QR:
+    """二维码
+
+    Attributes:
+        data: 二维码图像数据
+        qr_type: 二维码类型
+        mimetype: 二维码图像类型
+        identitfier: 标识符
+    """
+
+    data: bytes
+    qr_type: QRLoginType
+    mimetype: str
+    identifier: str
+
+    def save(self, path: Path | str = "."):
+        """保存二维码
+
+        Args:
+            path: 保存文件夹
+        """
+        if not self.data:
+            return None
+        path = Path(path)
+        path.mkdir(parents=True, exist_ok=True)
+        file_path = (
+            path
+            / f"{self.qr_type.value}-{uuid4()}{mimetypes.guess_extension(self.mimetype) if self.mimetype else None or '.png'}"
+        )
+        file_path.write_bytes(self.data)
+        return file_path
+
+
+async def get_qrcode(login_type: QRLoginType) -> QR:
+    """获取登录二维码"""
+    if login_type == QRLoginType.WX:
+        return await _get_wx_qr()
+    return await _get_qq_qr()
+
+
+async def _get_qq_qr() -> QR:
+    res = await get_session().get(
+        "https://ssl.ptlogin2.qq.com/ptqrshow",
+        params={
+            "appid": "716027609",
+            "e": "2",
+            "l": "M",
+            "s": "3",
+            "d": "72",
+            "v": "4",
+            "t": str(random.random()),
+            "daid": "383",
+            "pt_3rd_aid": "100497308",
+        },
+        headers={"Referer": "https://xui.ptlogin2.qq.com/"},
+    )
+    qrsig = res.cookies.get("qrsig")
+    if not qrsig:
+        raise LoginError("[QQLogin] 获取二维码失败")
+    return QR(res.read(), QRLoginType.QQ, "image/png", qrsig)
+
+
+async def _get_wx_qr() -> QR:
+    session = get_session()
+    res = await session.get(
+        "https://open.weixin.qq.com/connect/qrconnect",
+        params={
+            "appid": "wx48db31d50e334801",
+            "redirect_uri": "https://y.qq.com/portal/wx_redirect.html?login_type=2&surl=https://y.qq.com/",
+            "response_type": "code",
+            "scope": "snsapi_login",
+            "state": "STATE",
+            "href": "https://y.qq.com/mediastyle/music_v17/src/css/popup_wechat.css#wechat_redirect",
+        },
+    )
+    uuid = re.findall(r"uuid=(.+?)\"", res.text)[0]
+    if not uuid:
+        raise LoginError("[WXLogin] 获取 uuid 失败")
+    qrcode_data = (
+        await session.get(
+            f"https://open.weixin.qq.com/connect/qrcode/{uuid}",
+            headers={"Referer": "https://open.weixin.qq.com/connect/qrconnect"},
+        )
+    ).read()
+    return QR(qrcode_data, QRLoginType.WX, "image/jpeg", uuid)
+
+
+async def check_qrcode(qrcode: QR) -> tuple[QRCodeLoginEvents, Credential | None]:
+    """检查二维码状态"""
+    if qrcode.qr_type == QRLoginType.WX:
+        return await _check_wx_qr(qrcode)
+    return await _check_qq_qr(qrcode)
+
+
+async def _check_qq_qr(qrcode: QR) -> tuple[QRCodeLoginEvents, Credential | None]:
+    qrsig = qrcode.identifier
+    try:
+        resp = await get_session().get(
+            "https://ssl.ptlogin2.qq.com/ptqrlogin",
+            params={
+                "u1": "https://graph.qq.com/oauth2.0/login_jump",
+                "ptqrtoken": hash33(qrsig),
+                "ptredirect": "0",
+                "h": "1",
+                "t": "1",
+                "g": "1",
+                "from_ui": "1",
+                "ptlang": "2052",
+                "action": f"0-0-{time() * 1000}",
+                "js_ver": "20102616",
+                "js_type": "1",
+                "pt_uistyle": "40",
+                "aid": "716027609",
+                "daid": "383",
+                "pt_3rd_aid": "100497308",
+                "has_onekey": "1",
+            },
+            headers={"Referer": "https://xui.ptlogin2.qq.com/", "Cookie": f"qrsig={qrsig}"},
+        )
+    except httpx.HTTPStatusError:
+        raise LoginError("[QQLogin] 无效 qrsig")
+
+    match = re.search(r"ptuiCB\((.*?)\)", resp.text)
+    if not match:
+        raise LoginError("[QQLogin] 获取二维码状态失败")
+
+    data = [p.strip("'") for p in match.group(1).split(",")]
+    code_str = data[0]
+    if code_str.isdigit():
+        event = QRCodeLoginEvents.get_by_value(int(code_str))
+        if event == QRCodeLoginEvents.DONE:
+            sigx = re.findall(r"&ptsigx=(.+?)&s_url", data[2])[0]
+            uin = re.findall(r"&uin=(.+?)&service", data[2])[0]
+            return event, await _authorize_qq_qr(uin, sigx)
+        return event, None
+
+    return QRCodeLoginEvents.OTHER, None
+
+
+async def _check_wx_qr(qrcode: QR) -> tuple[QRCodeLoginEvents, Credential | None]:
+    uuid = qrcode.identifier
+    try:
+        resp = await get_session().get(
+            "https://lp.open.weixin.qq.com/connect/l/qrconnect",
+            params={"uuid": uuid, "_": str(int(time()) * 1000)},
+            headers={"Referer": "https://open.weixin.qq.com/"},
+        )
+    except httpx.TimeoutException:
+        return QRCodeLoginEvents.SCAN, None
+
+    match = re.search(r"window\.wx_errcode=(\d+);window\.wx_code=\'([^\']*)\'", resp.text)
+    if not match:
+        raise LoginError("[WXLogin] 获取二维码状态失败")
+
+    wx_errcode = match.group(1)
+
+    if not wx_errcode.isdigit():
+        return QRCodeLoginEvents.OTHER, None
+
+    event = QRCodeLoginEvents.get_by_value(int(wx_errcode))
+
+    if event == QRCodeLoginEvents.DONE:
+        wx_code = match.group(2)
+        if not wx_code:
+            raise LoginError("[WXLogin] 获取 code 失败")
+
+        return event, await _authorize_wx_qr(wx_code)
+
+    return event, None
+
+
+async def _authorize_qq_qr(uin: str, sigx: str) -> Credential:
+    session = get_session()
+    resp = await session.get(
+        "https://ssl.ptlogin2.graph.qq.com/check_sig",
+        params={
+            "uin": uin,
+            "pttype": "1",
+            "service": "ptqrlogin",
+            "nodirect": "0",
+            "ptsigx": sigx,
+            "s_url": "https://graph.qq.com/oauth2.0/login_jump",
+            "ptlang": "2052",
+            "ptredirect": "100",
+            "aid": "716027609",
+            "daid": "383",
+            "j_later": "0",
+            "low_login_hour": "0",
+            "regmaster": "0",
+            "pt_login_type": "3",
+            "pt_aid": "0",
+            "pt_aaid": "16",
+            "pt_light": "0",
+            "pt_3rd_aid": "100497308",
+        },
+        headers={"Referer": "https://xui.ptlogin2.qq.com/"},
+    )
+
+    p_skey = resp.cookies.get("p_skey")
+
+    if not p_skey:
+        raise LoginError("[QQLogin] 获取 p_skey 失败")
+
+    resp = await session.post(
+        "https://graph.qq.com/oauth2.0/authorize",
+        data={
+            "response_type": "code",
+            "client_id": "100497308",
+            "redirect_uri": "https://y.qq.com/portal/wx_redirect.html?login_type=1&surl=https%3A%252F%252Fy.qq.com%252F",
+            "scope": "get_user_info,get_app_friends",
+            "state": "state",
+            "switch": "",
+            "from_ptlogin": "1",
+            "src": "1",
+            "update_auth": "1",
+            "openapi": "1010_1030",
+            "g_tk": hash33(p_skey, 5381),
+            "auth_time": str(int(time()) * 1000),
+            "ui": str(uuid4()),
+        },
+    )
+    location = resp.headers.get("Location", "")
+    try:
+        code = re.findall(r"(?<=code=)(.+?)(?=&)", location)[0]
+    except IndexError:
+        raise LoginError("[QQLogin] 获取 code 失败")
+    try:
+        api = ApiRequest[[], dict[str, Any]](
+            "music.login.LoginServer",
+            "Login",
+            common={"tmeLoginType": "2"},
+            params={"code": code},
+            cacheable=False,
+        )
+        return Credential.from_cookies_dict(await api())
+    except CredentialExpiredError:
+        raise LoginError("[QQLogin] 无法重复鉴权")
+
+
+async def _authorize_wx_qr(code: str) -> Credential:
+    try:
+        api = ApiRequest[[], dict[str, Any]](
+            "music.login.LoginServer",
+            "Login",
+            common={"tmeLoginType": "1"},
+            params={"code": code, "strAppid": "wx48db31d50e334801"},
+            cacheable=False,
+        )
+        return Credential.from_cookies_dict(await api())
+    except CredentialExpiredError:
+        raise LoginError("[WXLogin] 无法重复鉴权")
+
+
+async def send_authcode(phone: int, country_code: int = 86) -> tuple[PhoneLoginEvents, str | None]:
+    """发送验证码
+
+    Args:
+        phone: 手机号
+        country_code: 国家码
+    """
+    resp = await ApiRequest[[], dict[str, Any]](
+        "music.login.LoginServer",
+        "SendPhoneAuthCode",
+        common={"tmeLoginMethod": "3"},
+        params={
+            "tmeAppid": "qqmusic",
+            "phoneNo": str(phone),
+            "areaCode": str(country_code),
+        },
+        ignore_code=True,
+        cacheable=False,
+    )()
+
+    match resp["code"]:
+        case 20276:
+            return PhoneLoginEvents.CAPTCHA, resp["data"]["securityURL"]
+        case 100001:
+            return PhoneLoginEvents.FREQUENCY, None
+        case 0:
+            return PhoneLoginEvents.SEND, None
+    return PhoneLoginEvents.OTHER, resp["data"]["errMsg"]
+
+
+async def phone_authorize(phone: int, auth_code: int, country_code: int = 86) -> Credential:
+    """验证码鉴权
+
+    Args:
+        phone: 手机号
+        auth_code: 验证码
+        country_code: 国家码
+    """
+    resp = await ApiRequest[[], dict[str, Any]](
+        "music.login.LoginServer",
+        "Login",
+        common={"tmeLoginMethod": "3", "tmeLoginType": "0"},
+        params={"code": str(auth_code), "phoneNo": str(phone), "areaCode": str(country_code), "loginMode": 1},
+        ignore_code=True,
+        cacheable=False,
+    )()
+    match resp["code"]:
+        case 20271:
+            raise LoginError("[PhoneLogin] 验证码错误或已鉴权")
+        case 0:
+            return Credential.from_cookies_dict(resp["data"])
+    raise LoginError("[PhoneLogin] 未知原因导致鉴权失败")

qqmusic_api_python-0.3.0/qqmusic_api/lyric.py

@@ -0,0 +1,68 @@
+"""歌词 API"""
+
+import re
+from typing import Any
+
+from qqmusic_api.utils.network import api_request
+
+from .utils.common import qrc_decrypt
+
+QRC_PATTERN = re.compile(r'<Lyric_.* LyricType=".*" LyricContent="(?P<content>.*?)"/>', re.DOTALL)
+
+
+@api_request("music.musichallSong.PlayLyricInfo", "GetPlayLyricInfo")
+async def get_lyric(
+    value: str | int,
+    qrc: bool = False,
+    trans: bool = False,
+    roma: bool = False,
+):
+    """获取歌词
+
+    Args:
+        value: 歌曲 id 或 mid
+        qrc: 是否返回逐字歌词
+        trans: 是否返回翻译歌词
+        roma: 是否返回罗马歌词
+    """
+    params = {
+        "crypt": 1,
+        "ct": 11,
+        "cv": 13020508,
+        "lrc_t": 0,
+        "qrc": qrc,
+        "qrc_t": 0,
+        "roma": roma,
+        "roma_t": 0,
+        "trans": trans,
+        "trans_t": 0,
+        "type": 1,
+    }
+
+    if isinstance(value, int):
+        params["songId"] = value
+    else:
+        params["songMid"] = value
+
+    def _processor(data: dict[str, Any]):
+        lyric = qrc_decrypt(data["lyric"])
+        trans = qrc_decrypt(data["trans"])
+        roma = qrc_decrypt(data["roma"])
+
+        if lyric and qrc:
+            m_qrc = QRC_PATTERN.search(lyric)
+            if m_qrc and m_qrc.group("content"):
+                lyric = m_qrc.group("content")
+
+        if roma:
+            m_roma = QRC_PATTERN.search(roma)
+            if m_roma and m_roma.group("content"):
+                roma = m_roma.group("content")
+
+        return {
+            "lyric": lyric,
+            "trans": trans,
+            "roma": roma,
+        }
+
+    return params, _processor