Ссылка для 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
Представляет собой API-клиент для выполнения запросов к указанному базовому URL.
Атрибуты:
Имя | Тип | Описание |
---|---|---|
base_url |
str
|
Базовый URL-адрес для API. |
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
|
Базовый URL-адрес для API. |
требуется |
headers |
dict
|
Заголовки, которые должны быть включены в каждый запрос. |
None
|
Исходный код в hub_sdk/base/api_client.py
delete(endpoint, params=None)
Сделай запрос DELETE к API.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
endpoint |
str
|
Конечная точка, которую нужно добавить к базовому URL для запроса. |
требуется |
params |
dict
|
Параметры, которые нужно включить в запрос. |
None
|
Возвращается:
Тип | Описание |
---|---|
Optional[Response]
|
Объект ответа от HTTP DELETE-запроса или None, если он завершился неудачей. |
Исходный код в hub_sdk/base/api_client.py
get(endpoint, params=None)
Сделай GET-запрос к API.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
endpoint |
str
|
Конечная точка, которую нужно добавить к базовому URL для запроса. |
требуется |
params |
dict
|
Параметры запроса. |
None
|
Возвращается:
Тип | Описание |
---|---|
Optional[Response]
|
Объект ответа от HTTP GET-запроса, None, если он завершился неудачей. |
Исходный код в hub_sdk/base/api_client.py
patch(endpoint, data=None, json=None)
Сделай PATCH-запрос к API.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
endpoint |
str
|
Конечная точка, которую нужно добавить к базовому URL для запроса. |
требуется |
data |
dict
|
Данные, которые будут отправлены в теле запроса. |
None
|
json |
dict
|
JSON-данные, которые будут отправлены в теле запроса. |
None
|
Возвращается:
Тип | Описание |
---|---|
Optional[Response]
|
Объект ответа от HTTP PATCH-запроса или None, если он завершился неудачей. |
Исходный код в hub_sdk/base/api_client.py
post(endpoint, data=None, json=None, files=None, stream=False)
Сделай POST-запрос к API.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
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)
Сделай PUT-запрос к API.
Параметры:
Имя | Тип | Описание | По умолчанию |
---|---|---|---|
endpoint |
str
|
Конечная точка, которую нужно добавить к базовому URL для запроса. |
требуется |
data |
Optional[Dict]
|
Данные, которые будут отправлены в теле запроса. |
None
|
json |
Optional[Dict]
|
JSON-данные, которые будут отправлены в теле запроса |
None
|
Возвращается:
Тип | Описание |
---|---|
Optional[Response]
|
Объект ответа на запрос HTTP PUT. |