Referentie voor hub_sdk/base/api_client.py
Opmerking
Dit bestand is beschikbaar op https://github.com/ultralytics/hub-sdk/blob/main/hub_sdk/base/api_client .py. Als je een probleem ziet, help het dan oplossen door een Pull Request π οΈ bij te dragen. Bedankt π!
hub_sdk.base.api_client.APIClientError
Basis: Exception
Aangepaste uitzonderingsklasse voor API clientfouten.
Kenmerken:
Naam | Type | Beschrijving |
---|---|---|
message |
str
|
Een menselijk leesbare foutmelding. |
status_code |
int
|
De HTTP-statuscode die bij de fout hoort, indien beschikbaar. |
Broncode in hub_sdk/base/api_client.py
__init__(message, status_code=None)
Initialiseer de instantie APIClientError.
Parameters:
Naam | Type | Beschrijving | Standaard |
---|---|---|---|
message |
str
|
Een menselijk leesbare foutmelding. |
vereist |
status_code |
int
|
De HTTP-statuscode die bij de fout hoort, indien beschikbaar. |
None
|
Broncode in hub_sdk/base/api_client.py
hub_sdk.base.api_client.APIClient
Vertegenwoordigt een API client voor het doen van verzoeken naar een gespecificeerde basis URL.
Kenmerken:
Naam | Type | Beschrijving |
---|---|---|
base_url |
str
|
De basis URL voor de API. |
headers |
(dict, None)
|
Koppen die in elk verzoek moeten worden opgenomen. |
logger |
Logger
|
Een instantie van de logger voor logboekdoeleinden. |
Broncode in 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)
Initialiseer een instantie van de APIClient klasse.
Parameters:
Naam | Type | Beschrijving | Standaard |
---|---|---|---|
base_url |
str
|
De basis URL voor de API. |
vereist |
headers |
dict
|
Koppen die in elk verzoek moeten worden opgenomen. |
None
|
Broncode in hub_sdk/base/api_client.py
delete(endpoint, params=None)
Doe een DELETE verzoek naar de API.
Parameters:
Naam | Type | Beschrijving | Standaard |
---|---|---|---|
endpoint |
str
|
Het eindpunt om toe te voegen aan de basis URL voor het verzoek. |
vereist |
params |
dict
|
Parameters om op te nemen in het verzoek. |
None
|
Retourneert:
Type | Beschrijving |
---|---|
Optional[Response]
|
Het antwoordobject van het HTTP DELETE verzoek, of geen als het mislukt. |
Broncode in hub_sdk/base/api_client.py
get(endpoint, params=None)
Doe een GET-verzoek naar de API.
Parameters:
Naam | Type | Beschrijving | Standaard |
---|---|---|---|
endpoint |
str
|
Het eindpunt om toe te voegen aan de basis URL voor het verzoek. |
vereist |
params |
dict
|
Query parameters voor het verzoek. |
None
|
Retourneert:
Type | Beschrijving |
---|---|
Optional[Response]
|
Het antwoordobject van het HTTP GET verzoek, geen als het mislukt. |
Broncode in hub_sdk/base/api_client.py
patch(endpoint, data=None, json=None)
Doe een PATCH-verzoek aan de API.
Parameters:
Naam | Type | Beschrijving | Standaard |
---|---|---|---|
endpoint |
str
|
Het eindpunt om toe te voegen aan de basis URL voor het verzoek. |
vereist |
data |
dict
|
Gegevens die moeten worden verzonden in de body van het verzoek. |
None
|
json |
dict
|
JSON gegevens die moeten worden verzonden in de body van het verzoek. |
None
|
Retourneert:
Type | Beschrijving |
---|---|
Optional[Response]
|
Het antwoordobject van het HTTP PATCH verzoek, of Geen als het mislukt. |
Broncode in hub_sdk/base/api_client.py
post(endpoint, data=None, json=None, files=None, stream=False)
Doe een POST-verzoek naar de API.
Parameters:
Naam | Type | Beschrijving | Standaard |
---|---|---|---|
endpoint |
str
|
Het eindpunt om toe te voegen aan de basis URL voor het verzoek. |
vereist |
data |
dict
|
Gegevens die moeten worden verzonden in de body van het verzoek. |
None
|
json |
dict
|
JSON gegevens die moeten worden verzonden in de body van het verzoek. |
None
|
files |
dict
|
Eventuele bestanden die bij het verzoek moeten worden gevoegd. |
None
|
stream |
bool
|
Als dit waar is, wordt de inhoud van het antwoord gestreamd. |
False
|
Retourneert:
Type | Beschrijving |
---|---|
Optional[Response]
|
Het antwoordobject van het HTTP POST verzoek. |
Broncode in hub_sdk/base/api_client.py
put(endpoint, data=None, json=None)
Doe een PUT verzoek naar de API.
Parameters:
Naam | Type | Beschrijving | Standaard |
---|---|---|---|
endpoint |
str
|
Het eindpunt om toe te voegen aan de basis URL voor het verzoek. |
vereist |
data |
Optional[Dict]
|
Gegevens die moeten worden verzonden in de body van het verzoek. |
None
|
json |
Optional[Dict]
|
JSON-gegevens die moeten worden verzonden in de body van het verzoek |
None
|
Retourneert:
Type | Beschrijving |
---|---|
Optional[Response]
|
Het antwoordobject van het HTTP PUT verzoek. |