Référence pour hub_sdk/base/api_client.py
Note
Ce fichier est disponible Ă l'adresse https://github.com/ultralytics/hub-sdk/blob/main/hub_sdk/base/api_client .py. Si tu repĂšres un problĂšme, aide Ă le corriger en contribuant Ă une Pull Request đ ïž. Merci đ !
hub_sdk.base.api_client.APIClientError
Bases : Exception
Classe d'exception personnalisée pour les erreurs des clients de l'API.
Attributs :
Nom | Type | Description |
---|---|---|
message |
str
|
Un message d'erreur lisible par l'homme. |
status_code |
int
|
Le code d'état HTTP associé à l'erreur, s'il est disponible. |
Code source dans hub_sdk/base/api_client.py
__init__(message, status_code=None)
Initialise l'instance APIClientError.
ParamĂštres :
Nom | Type | Description | DĂ©faut |
---|---|---|---|
message |
str
|
Un message d'erreur lisible par l'homme. |
requis |
status_code |
int
|
Le code d'état HTTP associé à l'erreur, s'il est disponible. |
None
|
Code source dans hub_sdk/base/api_client.py
hub_sdk.base.api_client.APIClient
Représente un client API pour effectuer des demandes à une URL de base spécifiée.
Attributs :
Nom | Type | Description |
---|---|---|
base_url |
str
|
L'URL de base de l'API. |
headers |
(dict, None)
|
En-tĂȘtes Ă inclure dans chaque demande. |
logger |
Logger
|
Une instance du logger Ă des fins de journalisation. |
Code source dans 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)
Initialise une instance de la classe APIClient.
ParamĂštres :
Nom | Type | Description | DĂ©faut |
---|---|---|---|
base_url |
str
|
L'URL de base de l'API. |
requis |
headers |
dict
|
En-tĂȘtes Ă inclure dans chaque demande. |
None
|
Code source dans hub_sdk/base/api_client.py
delete(endpoint, params=None)
Fais une demande DELETE Ă l'API.
ParamĂštres :
Nom | Type | Description | DĂ©faut |
---|---|---|---|
endpoint |
str
|
Le point de terminaison Ă ajouter Ă l'URL de base de la demande. |
requis |
params |
dict
|
ParamĂštres Ă inclure dans la demande. |
None
|
Retourne :
Type | Description |
---|---|
Optional[Response]
|
L'objet de rĂ©ponse de la requĂȘte HTTP DELETE, ou Aucun en cas d'Ă©chec. |
Code source dans hub_sdk/base/api_client.py
get(endpoint, params=None)
Fais une demande GET Ă l'API.
ParamĂštres :
Nom | Type | Description | DĂ©faut |
---|---|---|---|
endpoint |
str
|
Le point de terminaison Ă ajouter Ă l'URL de base de la demande. |
requis |
params |
dict
|
ParamĂštres de requĂȘte pour la demande. |
None
|
Retourne :
Type | Description |
---|---|
Optional[Response]
|
L'objet de la rĂ©ponse Ă la requĂȘte HTTP GET, Aucun si elle Ă©choue. |
Code source dans hub_sdk/base/api_client.py
patch(endpoint, data=None, json=None)
Fais une demande de PATCH Ă l'API.
ParamĂštres :
Nom | Type | Description | DĂ©faut |
---|---|---|---|
endpoint |
str
|
Le point de terminaison Ă ajouter Ă l'URL de base de la demande. |
requis |
data |
dict
|
DonnĂ©es Ă envoyer dans le corps de la requĂȘte. |
None
|
json |
dict
|
DonnĂ©es JSON Ă envoyer dans le corps de la requĂȘte. |
None
|
Retourne :
Type | Description |
---|---|
Optional[Response]
|
L'objet de rĂ©ponse de la requĂȘte HTTP PATCH, ou Aucun si elle Ă©choue. |
Code source dans hub_sdk/base/api_client.py
post(endpoint, data=None, json=None, files=None, stream=False)
Fais une demande POST Ă l'API.
ParamĂštres :
Nom | Type | Description | DĂ©faut |
---|---|---|---|
endpoint |
str
|
Le point de terminaison Ă ajouter Ă l'URL de base de la demande. |
requis |
data |
dict
|
DonnĂ©es Ă envoyer dans le corps de la requĂȘte. |
None
|
json |
dict
|
DonnĂ©es JSON Ă envoyer dans le corps de la requĂȘte. |
None
|
files |
dict
|
Fichiers à inclure dans la demande, le cas échéant. |
None
|
stream |
bool
|
Si True, le contenu de la réponse sera diffusé en continu. |
False
|
Retourne :
Type | Description |
---|---|
Optional[Response]
|
L'objet de la rĂ©ponse Ă la requĂȘte HTTP POST. |
Code source dans hub_sdk/base/api_client.py
put(endpoint, data=None, json=None)
Fais une demande PUT Ă l'API.
ParamĂštres :
Nom | Type | Description | DĂ©faut |
---|---|---|---|
endpoint |
str
|
Le point de terminaison Ă ajouter Ă l'URL de base de la demande. |
requis |
data |
Optional[Dict]
|
DonnĂ©es Ă envoyer dans le corps de la requĂȘte. |
None
|
json |
Optional[Dict]
|
DonnĂ©es JSON Ă envoyer dans le corps de la requĂȘte |
None
|
Retourne :
Type | Description |
---|---|
Optional[Response]
|
L'objet de la rĂ©ponse Ă la requĂȘte HTTP PUT. |