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
execute
async
execute(request: BaseRequest[ResultT]) -> ResultT
执行单个请求描述符并解析响应结果.
| PARAMETER | DESCRIPTION |
|---|---|
request
|
请求描述符实例.
TYPE:
|
Source code in qqmusic_api/core/client.py
gather
async
gather(
requests: list[BaseRequest[ResultT]],
*,
batch_size: int = ...,
return_exceptions: Literal[False] = False,
) -> list[ResultT]
gather(
requests: list[BaseRequest[ResultT]],
*,
batch_size: int = ...,
return_exceptions: Literal[True],
) -> list[ResultT | Exception]
gather(
requests: list[BaseRequest[Any]],
*,
batch_size: int = 20,
return_exceptions: bool = False,
) -> list[Any]
并发执行多个请求描述符并按输入顺序返回解析结果.
CGI 请求会按可合并条件自动分组, 同一分组内的请求按 batch_size
批量合并为一次 CGI 多参数调用 (req_0, req_1, ...), 以减少网络往返;
不同分组之间并发执行. HTTP 请求不参与合并, 直接并发执行.
| PARAMETER | DESCRIPTION |
|---|---|
requests
|
待执行的请求描述符列表.
TYPE:
|
batch_size
|
单个 CGI 批量调用 (多参数合并) 包含的最大请求数; 仅对
TYPE:
|
return_exceptions
|
是否捕捉异常并作为结果返回而不抛出. 为 True 时,
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[Any]
|
与 |
list[Any]
|
True 时, 失败位置的结果为对应的异常对象. |
| RAISES | DESCRIPTION |
|---|---|
ValueError
|
当 |
ExceptionGroup
|
当 |
ApiDataError
|
当内部依赖的结果未能完整回填时抛出 (一般不应发生). |
Source code in qqmusic_api/core/client.py
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 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 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 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 | |