跳转至

utils.session

请求 Session 管理

ApiConfig

Bases: TypedDict

API 配置

Session 

Session(*, credential: Credential | None = None, enable_sign: bool = False, http2: bool = True, **kwargs)

Bases: AsyncClient

Session 类,用于管理 QQ 音乐的登录态和 API 请求

参数 描述
credential

全局凭证,每个请求都将使用.

类型： Credential | None 默认： None

enable_sign

是否启用加密接口

类型： bool 默认： False

源代码位于： qqmusic_api/utils/session.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
def __init__(
    self,
    *,
    credential: Credential | None = None,
    enable_sign: bool = False,
    http2: bool = True,
    **kwargs,
) -> None:
    super().__init__(**kwargs, http2=http2)
    self.credential = credential
    self.headers.update(
        {
            "User-Agent": self.UA_DEFAULT,
            "Referer": self.HOST,
        }
    )
    self.api_config = ApiConfig(
        version="13.2.5.8",
        version_code=13020508,
        enable_sign=enable_sign,
        endpoint="https://u.y.qq.com/cgi-bin/musicu.fcg",
        enc_endpoint="https://u.y.qq.com/cgi-bin/musics.fcg",
    )
    self.qimei = get_qimei(self.api_config["version"])["q36"]

get_session 

get_session() -> Session

获取当前上下文的 Session

源代码位于： qqmusic_api/utils/session.py 
76
77
78
79
80
81
82
83
def get_session() -> Session:
    """获取当前上下文的 Session"""
    session = _session_context.get()
    if session is None:
        logger.info("创建新的默认Session")
        session = Session()
        _session_context.set(session)
    return session

set_session 

set_session(session: Session) -> None

设置当前上下文的 Session

源代码位于： qqmusic_api/utils/session.py 
86
87
88
89
def set_session(session: Session) -> None:
    """设置当前上下文的 Session"""
    logger.info("设置新的Session到上下文")
    _session_context.set(session)

clear_session 

clear_session() -> None

清除当前上下文的 Session

源代码位于： qqmusic_api/utils/session.py 
92
93
94
95
96
97
98
99
def clear_session() -> None:
    """清除当前上下文的 Session"""
    logger.info("清除当前上下文的Session")
    try:
        _session_context.set(None)
    except LookupError:
        logger.warning("尝试清除不存在的Session上下文")
        pass