接口响应

如果没有另作说明,ArkID SDk 客户端的所有方法的返回值都是 ArkIDResponse 对象。 一些 ArkIDResponse 对象是可迭代的,在这些情况下, 它们的内容也是 ArkIDResponse 对象。

在调用ArkID 服务的接口时,使用的返回对象为 ArkIDResponse 的子类型 ArkIDHTTPResponse, 它丰富了一些自定义数据信息的细节。

泛型响应类

class arkid_client.response.ArkIDResponse(data, client=None)[源代码]

通用响应基类,只有一个简单的 data 成员。最常见的响应数据 是 JSON 字典。为了尽可能不去处理这种类型的反应, ArkIDResponse 对象支持通过字典的形式来直接访问响应内容,如果 data 不是字典结构, 将会抛出 TypeError 异常。

>>> print('"Response ID": response["id"]') # alias for response.data["id"]

ArkIDResponse 对象封装 HTTP 响应的数据给调用者, 大多数的操作都是基于与这些数据进行交互。

data

Python 形式的数据结构返回响应数据,通常是一个 dict 或者 list

get(*args, **kwargs)[源代码]

BaseResponse.get(...) 方法是 BaseResponse.data.get(...) 方法的别名

class arkid_client.response.ArkIDHTTPResponse(http_response, client=None)[源代码]

基类:arkid_client.response.ArkIDResponse

封装底层 HTTP 响应对象。如果响应数据类型是 JSON,则解析后的数据将在 data 中, 否则 data 将为 None ,并且 text 将被使用。

变量:
  • http_status – ArkID 服务端返回的 HTTP 响应的状态码 (int)
  • content_type – ArkID 服务端返回的 HTTP 响应的内容类型 (str)
data

Python 形式的数据结构返回响应数据,通常是一个 dict 或者 list

text

HTTP 响应数据的字符串形式