client
core.client
API 客户端核心实现. 整合网络传输、鉴权与业务模块访问.
Client
Client(
credential: Credential | None = None,
*,
platform: Platform | None = None,
device_path: str | None = None,
rate: float | None = None,
capacity: float | None = None,
connect_retries: int | None = None,
proxies: ProxyType | None = None,
cert: TLSClientCertType | None = None,
hooks: AsyncHookType[PreparedRequest | Response]
| None = None,
verify: TLSVerifyType | None = None,
)
QQMusic API Client.
初始化客户端实例.
| PARAMETER | DESCRIPTION |
|---|---|
credential
|
全局默认凭证.
TYPE:
|
platform
|
全局默认请求平台.
TYPE:
|
device_path
|
设备信息文件路径.
TYPE:
|
rate
|
请求速率限制 (请求/秒). 默认为 10.
TYPE:
|
capacity
|
令牌桶容量, 允许的突发请求数. 默认为 50.
TYPE:
|
connect_retries
|
连接建立失败时的最大重试次数. 默认为 2.
TYPE:
|
proxies
|
代理配置, 详见 niquests 文档.
TYPE:
|
cert
|
TLS 客户端证书配置, 详见 niquests 文档.
TYPE:
|
verify
|
TLS 证书验证配置, 详见 niquests 文档.
TYPE:
|
hooks
|
请求/响应钩子, 详见 niquests 文档.
TYPE:
|
Source code in qqmusic_api/core/client.py
close
async
request
async
request(
method: str,
url: str,
credential: Credential | None = None,
platform: Platform | None = None,
*,
lazy: bool = False,
**kwargs: Any,
)
发送带有凭证和 User-Agent 的 HTTP 请求.
自动装配指定的客户端平台 User-Agent 及对应凭证的 Cookies.
| PARAMETER | DESCRIPTION |
|---|---|
method
|
HTTP 方法.
TYPE:
|
url
|
URL 地址.
TYPE:
|
credential
|
请求凭证.
TYPE:
|
platform
|
请求平台.
TYPE:
|
lazy
|
是否延迟发送请求.
TYPE:
|
**kwargs
|
其他参数.
TYPE:
|
Source code in qqmusic_api/core/client.py
request_api
async
request_api(
data: list[RequestItem],
comm: dict[str, Any] | None = None,
credential: Credential | None = None,
platform: Platform | None = None,
*,
override_comm: bool = False,
is_jce: bool = False,
lazy: bool = False,
sign: bool = False,
) -> Response
发送 API 请求.
Source code in qqmusic_api/core/client.py
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 | |
gather
async
gather(
requests: list[Request[RequestResultT]],
*,
batch_size: int = ...,
return_exceptions: Literal[False] = False,
) -> list[RequestResultT]
gather(
requests: list[Request[RequestResultT]],
*,
batch_size: int = ...,
return_exceptions: Literal[True],
) -> list[RequestResultT | Exception]
gather(
requests: list[Request[Any]],
*,
batch_size: int = 20,
return_exceptions: bool = False,
) -> list[Any]
并发执行多个请求描述符并按输入顺序返回解析结果.
可合并的请求会按协议、平台、公共参数和凭证分组, 每组按
batch_size 拆分为批量请求发送。响应解析失败时, 默认抛出
第一个异常; 当 return_exceptions 为 True 时, 异常会作为对应
位置的结果返回。
| PARAMETER | DESCRIPTION |
|---|---|
requests
|
待执行的请求描述符列表. |
batch_size
|
每个批量请求包含的最大请求数.
TYPE:
|
return_exceptions
|
是否将单项解析异常作为结果返回.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[Any]
|
与 |
| RAISES | DESCRIPTION |
|---|---|
ValueError
|
当 |
Source code in qqmusic_api/core/client.py
474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 | |
execute
async
execute(request: Request[RequestResultT]) -> RequestResultT
执行单个请求描述符并解析响应结果.
| PARAMETER | DESCRIPTION |
|---|---|
request
|
待执行的请求描述符.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
RequestResultT
|
解析后的响应数据或响应模型. |
| RAISES | DESCRIPTION |
|---|---|
ValueError
|
当响应为空、业务返回码非 0 或响应缺少 |