Referans için hub_sdk/base/api_client.py
Not
Bu dosya https://github.com/ultralytics/hub-sdk/blob/main/hub_sdk/base/api_client .py adresinde mevcuttur. Bir sorun tespit ederseniz, lütfen bir Çekme İsteği 🛠️ ile katkıda bulunarak düzeltmeye yardımcı olun. Teşekkürler 🙏!
hub_sdk.base.api_client.APIClientError
Üsler: Exception
API istemci hataları için özel istisna sınıfı.
Nitelikler:
İsim | Tip | Açıklama |
---|---|---|
message |
str
|
İnsan tarafından okunabilir bir hata mesajı. |
status_code |
int
|
Varsa, hatayla ilişkili HTTP durum kodu. |
Kaynak kodu hub_sdk/base/api_client.py
__init__(message, status_code=None)
APIClientError örneğini başlatın.
Parametreler:
İsim | Tip | Açıklama | Varsayılan |
---|---|---|---|
message |
str
|
İnsan tarafından okunabilir bir hata mesajı. |
gerekli |
status_code |
int
|
Varsa, hatayla ilişkili HTTP durum kodu. |
None
|
Kaynak kodu hub_sdk/base/api_client.py
hub_sdk.base.api_client.APIClient
Belirtilen bir temel URL'ye istekte bulunmak için bir API istemcisini temsil eder.
Nitelikler:
İsim | Tip | Açıklama |
---|---|---|
base_url |
str
|
API için temel URL. |
headers |
(dict, None)
|
Her talebe eklenecek başlıklar. |
logger |
Logger
|
Günlük tutma amaçlı bir logger örneği. |
Kaynak kodu 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 sınıfının bir örneğini başlatın.
Parametreler:
İsim | Tip | Açıklama | Varsayılan |
---|---|---|---|
base_url |
str
|
API için temel URL. |
gerekli |
headers |
dict
|
Her talebe eklenecek başlıklar. |
None
|
Kaynak kodu hub_sdk/base/api_client.py
delete(endpoint, params=None)
API'ye bir DELETE isteği yapın.
Parametreler:
İsim | Tip | Açıklama | Varsayılan |
---|---|---|---|
endpoint |
str
|
İstek için temel URL'ye eklenecek uç nokta. |
gerekli |
params |
dict
|
İsteğe dahil edilecek parametreler. |
None
|
İade:
Tip | Açıklama |
---|---|
Optional[Response]
|
HTTP DELETE isteğinden gelen yanıt nesnesi veya başarısız olursa None. |
Kaynak kodu hub_sdk/base/api_client.py
get(endpoint, params=None)
API'ye bir GET isteği yapın.
Parametreler:
İsim | Tip | Açıklama | Varsayılan |
---|---|---|---|
endpoint |
str
|
İstek için temel URL'ye eklenecek uç nokta. |
gerekli |
params |
dict
|
İstek için sorgu parametreleri. |
None
|
İade:
Tip | Açıklama |
---|---|
Optional[Response]
|
HTTP GET isteğinden gelen yanıt nesnesi, başarısız olursa None. |
Kaynak kodu hub_sdk/base/api_client.py
patch(endpoint, data=None, json=None)
API'ye bir PATCH isteği yapın.
Parametreler:
İsim | Tip | Açıklama | Varsayılan |
---|---|---|---|
endpoint |
str
|
İstek için temel URL'ye eklenecek uç nokta. |
gerekli |
data |
dict
|
İstek gövdesinde gönderilecek veriler. |
None
|
json |
dict
|
İsteğin gövdesinde gönderilecek JSON verileri. |
None
|
İade:
Tip | Açıklama |
---|---|
Optional[Response]
|
HTTP PATCH isteğinden gelen yanıt nesnesi veya başarısız olursa None. |
Kaynak kodu hub_sdk/base/api_client.py
post(endpoint, data=None, json=None, files=None, stream=False)
API'ye bir POST isteği yapın.
Parametreler:
İsim | Tip | Açıklama | Varsayılan |
---|---|---|---|
endpoint |
str
|
İstek için temel URL'ye eklenecek uç nokta. |
gerekli |
data |
dict
|
İstek gövdesinde gönderilecek veriler. |
None
|
json |
dict
|
İsteğin gövdesinde gönderilecek JSON verileri. |
None
|
files |
dict
|
Varsa, talebe dahil edilecek dosyalar. |
None
|
stream |
bool
|
True ise, yanıt içeriği akışa alınacaktır. |
False
|
İade:
Tip | Açıklama |
---|---|
Optional[Response]
|
HTTP POST isteğinden gelen yanıt nesnesi. |
Kaynak kodu hub_sdk/base/api_client.py
put(endpoint, data=None, json=None)
API'ye bir PUT isteği yapın.
Parametreler:
İsim | Tip | Açıklama | Varsayılan |
---|---|---|---|
endpoint |
str
|
İstek için temel URL'ye eklenecek uç nokta. |
gerekli |
data |
Optional[Dict]
|
İstek gövdesinde gönderilecek veriler. |
None
|
json |
Optional[Dict]
|
İstek gövdesinde gönderilecek JSON verileri |
None
|
İade:
Tip | Açıklama |
---|---|
Optional[Response]
|
HTTP PUT isteğinden gelen yanıt nesnesi. |