Referencia para hub_sdk/base/api_client.py
Nota
Este archivo está disponible en https://github.com/ultralytics/hub-sdk/blob/main/hub_sdk/base/api_client .py. Si detectas algún problema, por favor, ayuda a solucionarlo contribuyendo con una Pull Request 🛠️. ¡Gracias 🙏!
hub_sdk.base.api_client.APIClientError
Bases: Exception
Clase de excepción personalizada para los errores del cliente de la API.
Atributos:
Nombre | Tipo | Descripción |
---|---|---|
message |
str
|
Un mensaje de error legible por humanos. |
status_code |
int
|
El código de estado HTTP asociado al error, si está disponible. |
Código fuente en hub_sdk/base/api_client.py
__init__(message, status_code=None)
Inicializa la instancia APIClientError.
Parámetros:
Nombre | Tipo | Descripción | Por defecto |
---|---|---|---|
message |
str
|
Un mensaje de error legible por humanos. |
necesario |
status_code |
int
|
El código de estado HTTP asociado al error, si está disponible. |
None
|
Código fuente en hub_sdk/base/api_client.py
hub_sdk.base.api_client.APIClient
Representa un cliente API para realizar peticiones a una URL base especificada.
Atributos:
Nombre | Tipo | Descripción |
---|---|---|
base_url |
str
|
La URL base de la API. |
headers |
(dict, None)
|
Cabeceras que deben incluirse en cada solicitud. |
logger |
Logger
|
Una instancia del registrador para fines de registro. |
Código fuente en 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)
Inicializa una instancia de la clase APIClient.
Parámetros:
Nombre | Tipo | Descripción | Por defecto |
---|---|---|---|
base_url |
str
|
La URL base de la API. |
necesario |
headers |
dict
|
Cabeceras que deben incluirse en cada solicitud. |
None
|
Código fuente en hub_sdk/base/api_client.py
delete(endpoint, params=None)
Haz una petición DELETE a la API.
Parámetros:
Nombre | Tipo | Descripción | Por defecto |
---|---|---|---|
endpoint |
str
|
El punto final que se añadirá a la URL base de la petición. |
necesario |
params |
dict
|
Parámetros a incluir en la solicitud. |
None
|
Devuelve:
Tipo | Descripción |
---|---|
Optional[Response]
|
El objeto respuesta de la petición HTTP DELETE, o Ninguno si falla. |
Código fuente en hub_sdk/base/api_client.py
get(endpoint, params=None)
Haz una petición GET a la API.
Parámetros:
Nombre | Tipo | Descripción | Por defecto |
---|---|---|---|
endpoint |
str
|
El punto final que se añadirá a la URL base de la petición. |
necesario |
params |
dict
|
Parámetros de consulta para la solicitud. |
None
|
Devuelve:
Tipo | Descripción |
---|---|
Optional[Response]
|
El objeto respuesta de la petición HTTP GET, Ninguno si falla. |
Código fuente en hub_sdk/base/api_client.py
patch(endpoint, data=None, json=None)
Haz una solicitud PATCH a la API.
Parámetros:
Nombre | Tipo | Descripción | Por defecto |
---|---|---|---|
endpoint |
str
|
El punto final que se añadirá a la URL base de la petición. |
necesario |
data |
dict
|
Datos que se enviarán en el cuerpo de la petición. |
None
|
json |
dict
|
Datos JSON que se enviarán en el cuerpo de la petición. |
None
|
Devuelve:
Tipo | Descripción |
---|---|
Optional[Response]
|
El objeto respuesta de la petición HTTP PATCH, o Ninguno si falla. |
Código fuente en hub_sdk/base/api_client.py
post(endpoint, data=None, json=None, files=None, stream=False)
Haz una solicitud POST a la API.
Parámetros:
Nombre | Tipo | Descripción | Por defecto |
---|---|---|---|
endpoint |
str
|
El punto final que se añadirá a la URL base de la petición. |
necesario |
data |
dict
|
Datos que se enviarán en el cuerpo de la petición. |
None
|
json |
dict
|
Datos JSON que se enviarán en el cuerpo de la petición. |
None
|
files |
dict
|
Archivos que deben incluirse en la solicitud, si los hay. |
None
|
stream |
bool
|
Si es True, se transmitirá el contenido de la respuesta. |
False
|
Devuelve:
Tipo | Descripción |
---|---|
Optional[Response]
|
El objeto respuesta de la petición HTTP POST. |
Código fuente en hub_sdk/base/api_client.py
put(endpoint, data=None, json=None)
Haz una solicitud PUT a la API.
Parámetros:
Nombre | Tipo | Descripción | Por defecto |
---|---|---|---|
endpoint |
str
|
El punto final que se añadirá a la URL base de la petición. |
necesario |
data |
Optional[Dict]
|
Datos que se enviarán en el cuerpo de la petición. |
None
|
json |
Optional[Dict]
|
Datos JSON que se enviarán en el cuerpo de la petición |
None
|
Devuelve:
Tipo | Descripción |
---|---|
Optional[Response]
|
El objeto respuesta de la petición HTTP PUT. |