基类客户端

所有类型的服务客户端均支持由 BaseClient 提供的底层 API 。

class arkid_client.base.BaseClient(base_url: str, service: str, environment: str = None, base_path: str = None, authorizer: object = None, app_name: str = None, http_timeout: float = None, *args, **kwargs)

简单的基类客户端，可处理 ArkID REST APIs 返回的错误信息。 封装 requests.Session 对象为一个简化的接口， 该接口不公开来自请求的任何内容。 注意：强烈建议您不要尝试直接实例化 BaseClient

Parameters

base_url (str)

ArkID 服务端的根地址，用户无需进行任何有关 ArkID 服务端的地址配置操作， 只需在初始化 BaseClient 实例时传入 base_url 参数即可

authorizer (ArkIDAuthorizer)

authorizer 认证授权器用于生成 HTTP 请求的头部认证信息

app_name (str)

(可选)用于标识调用方，往往指代正在使用 ArkID SDK 进行开发的项目。 此参数与客户端的任何操作无关。仅仅作为请求头部 User-Agent 的一部分发送给 ArkID 团队，以方便调试出现的问题。

http_timeout (float)

HTTP 连接响应的等待时间（单位：s）。默认 60 。 如果传入的值为 -1 ，代表请求发送后将无限期挂起。

所有其它的初始化参数用于子类内部使用

set_app_name(app_name: str)

设置一个应用名称（用户代理）并发送给 ArkID 服务端。

注意：建议应用开发者提供一个应用名称给 ArkID 团队，以便在可能的情况下促进与 ArkID 的交互问题的解决。

get(path: str, params: dict = None, headers: dict = None, response_class: object = None, retry_401: bool = True)

以 GET 方式向指定地址发送 HTTP 请求。

Parameters

path (string)

请求的路径，有无正斜杠均可

params (dict)

编码为 Query String 的参数

headers (dict)

添加到请求中的 HTTP 标头

response_class (class)

响应对象的类型，由客户端的 default_response_class 重写

retry_401 (bool)

如果响应码为 401 并且 self.authorizer 支持重试， 那么会自动进行新的认证。

返回:ArkIDHTTPResponse object

post(path: str, json_body: dict = None, params: dict = None, headers: dict = None, text_body: dict = None, response_class: object = None, retry_401: bool = True)

以 POST 方式向指定地址发送 HTTP 请求。

Parameters

path (string)

请求的路径，有无正斜杠均可

params (dict)

编码为 Query String 的参数

headers (dict)

添加到请求中的 HTTP 标头

json_body (dict)

请求体中通过 JSON 编码的数据

text_body (string or dict)

用作请求主体的原始字符串，或是以 HTTP 形式编码的字典数据

response_class (class)

响应对象的类型，由客户端的 default_response_class 重写

retry_401 (bool)

如果响应码为 401 并且 self.authorizer 支持重试， 那么会自动进行新的认证。

返回:ArkIDHTTPResponse object

delete(path: str, params: dict = None, headers: dict = None, response_class: object = None, retry_401: bool = True)

以 DELETE 方式向指定地址发送 HTTP 请求。

Parameters

path (string)

请求的路径，有无正斜杠均可

params (dict)

编码为 Query String 的参数

headers (dict)

添加到请求中的 HTTP 标头

response_class (class)

响应对象的类型，由客户端的 default_response_class 重写

retry_401 (bool)

如果响应码为 401 并且 self.authorizer 支持重试， 那么会自动进行新的认证。

返回:ArkIDHTTPResponse object

put(path: str, json_body: dict = None, params: dict = None, headers: dict = None, text_body: dict = None, response_class: object = None, retry_401: bool = True)

以 PUT 方式向指定地址发送 HTTP 请求。

Parameters

path (string)

请求的路径，有无正斜杠均可

params (dict)

编码为 Query String 的参数

headers (dict)

添加到请求中的 HTTP 标头

json_body (dict)

请求体中通过 JSON 编码的数据

text_body (string or dict)

用作请求主体的原始字符串，或是以 HTTP 形式编码的字典数据

response_class (class)

响应对象的类型，由客户端的 default_response_class 重写

retry_401 (bool)

如果响应码为 401 并且 self.authorizer 支持重试， 那么会自动进行新的认证。

返回:ArkIDHTTPResponse object

patch(path: str, json_body: dict = None, params: dict = None, headers: dict = None, text_body: dict = None, response_class: object = None, retry_401: bool = True)

以 PATCH 方式向指定地址发送 HTTP 请求。

Parameters

path (string)

请求的路径，有无正斜杠均可

params (dict)

编码为 Query String 的参数

headers (dict)

添加到请求中的 HTTP 标头

json_body (dict)

请求体中通过 JSON 编码的数据

text_body (string or dict)

用作请求主体的原始字符串，或是以 HTTP 形式编码的字典数据

response_class (class)

响应对象的类型，由客户端的 default_response_class 重写

retry_401 (bool)

如果响应码为 401 并且 self.authorizer 支持重试， 那么会自动进行新的认证。

返回:ArkIDHTTPResponse object