参考资料 hub_sdk/base/api_client.py
备注
该文件可在https://github.com/ultralytics/hub-sdk/blob/main/hub_sdk/base/api_client.py 上获取。如果您发现问题,请通过提交 Pull Request🛠️ 帮助修复。谢谢🙏!
hub_sdk.base.api_client.APIClientError
垒球 Exception
用于 API 客户端错误的自定义异常类。
属性
名称 | 类型 | 说明 |
---|---|---|
message |
str
|
人可读的错误信息。 |
status_code |
int
|
与错误相关的 HTTP 状态代码(如果有)。 |
源代码 hub_sdk/base/api_client.py
__init__(message, status_code=None)
初始化 APIClientError 实例。
参数
名称 | 类型 | 说明 | 默认值 |
---|---|---|---|
message |
str
|
人可读的错误信息。 |
所需 |
status_code |
int
|
与错误相关的 HTTP 状态代码(如果有)。 |
None
|
源代码 hub_sdk/base/api_client.py
hub_sdk.base.api_client.APIClient
代表向指定基本 URL 发送请求的 API 客户端。
属性
名称 | 类型 | 说明 |
---|---|---|
base_url |
str
|
API 的基本 URL。 |
headers |
(dict, None)
|
每个请求中应包含的标题。 |
logger |
Logger
|
用于记录日志的日志记录器实例。 |
源代码 hub_sdk/base/api_client.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 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 |
|
__init__(base_url, headers=None)
初始化 APIClient 类的实例。
参数
名称 | 类型 | 说明 | 默认值 |
---|---|---|---|
base_url |
str
|
API 的基本 URL。 |
所需 |
headers |
dict
|
每个请求中应包含的标题。 |
None
|
源代码 hub_sdk/base/api_client.py
delete(endpoint, params=None)
向 API 发送 DELETE 请求。
参数
名称 | 类型 | 说明 | 默认值 |
---|---|---|---|
endpoint |
str
|
附加到基本 URL 的请求端点。 |
所需 |
params |
dict
|
包含在请求中的参数。 |
None
|
返回:
类型 | 说明 |
---|---|
Optional[Response]
|
HTTP DELETE 请求的响应对象,如果失败则为 "无"。 |
源代码 hub_sdk/base/api_client.py
get(endpoint, params=None)
向 API 发送 GET 请求。
参数
名称 | 类型 | 说明 | 默认值 |
---|---|---|---|
endpoint |
str
|
附加到基本 URL 的请求端点。 |
所需 |
params |
dict
|
请求的查询参数。 |
None
|
返回:
类型 | 说明 |
---|---|
Optional[Response]
|
HTTP GET 请求的响应对象,如果请求失败则为 "无"。 |
源代码 hub_sdk/base/api_client.py
patch(endpoint, data=None, json=None)
向 API 发送 PATCH 请求。
参数
名称 | 类型 | 说明 | 默认值 |
---|---|---|---|
endpoint |
str
|
附加到基本 URL 的请求端点。 |
所需 |
data |
dict
|
将在请求正文中发送的数据。 |
None
|
json |
dict
|
将在请求正文中发送的 JSON 数据。 |
None
|
返回:
类型 | 说明 |
---|---|
Optional[Response]
|
HTTP PATCH 请求的响应对象,如果失败则为 "无"。 |
源代码 hub_sdk/base/api_client.py
post(endpoint, data=None, json=None, files=None, stream=False)
向 API 发送 POST 请求。
参数
名称 | 类型 | 说明 | 默认值 |
---|---|---|---|
endpoint |
str
|
附加到基本 URL 的请求端点。 |
所需 |
data |
dict
|
将在请求正文中发送的数据。 |
None
|
json |
dict
|
将在请求正文中发送的 JSON 数据。 |
None
|
files |
dict
|
申请中应包含的文件(如果有)。 |
None
|
stream |
bool
|
如果为 True,响应内容将以流式传输。 |
False
|
返回:
类型 | 说明 |
---|---|
Optional[Response]
|
HTTP POST 请求的响应对象。 |
源代码 hub_sdk/base/api_client.py
put(endpoint, data=None, json=None)
向 API 发送 PUT 请求。
参数
名称 | 类型 | 说明 | 默认值 |
---|---|---|---|
endpoint |
str
|
附加到基本 URL 的请求端点。 |
所需 |
data |
Optional[Dict]
|
将在请求正文中发送的数据。 |
None
|
json |
Optional[Dict]
|
将在请求正文中发送的 JSON 数据 |
None
|
返回:
类型 | 说明 |
---|---|
Optional[Response]
|
HTTP PUT 请求的响应对象。 |