مرجع ل hub_sdk/base/api_client.py
ملاحظه
هذا الملف متاح في https://github.com/ultralytics/hub-sdk/blob/main/hub_sdk/base/api_client.py. إذا اكتشفت مشكلة ، فيرجى المساعدة في إصلاحها من خلال المساهمة في طلب 🛠️ سحب. شكرا لك 🙏!
hub_sdk.base.api_client.APIClientError
قواعد: Exception
فئة استثناء مخصصة لأخطاء عميل واجهة برمجة التطبيقات.
سمات:
اسم | نوع | وصف |
---|---|---|
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
يمثل عميل واجهة برمجة التطبيقات لتقديم طلبات إلى عنوان URL أساسي محدد.
سمات:
اسم | نوع | وصف |
---|---|---|
base_url |
str
|
عنوان URL الأساسي لواجهة برمجة التطبيقات. |
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 الأساسي لواجهة برمجة التطبيقات. |
مطلوب |
headers |
dict
|
الرؤوس التي سيتم تضمينها في كل طلب. |
None
|
شفرة المصدر في hub_sdk/base/api_client.py
delete(endpoint, params=None)
تقديم طلب حذف إلى واجهة برمجة التطبيقات.
البارامترات:
اسم | نوع | وصف | افتراضي |
---|---|---|---|
endpoint |
str
|
نقطة النهاية المراد إلحاقها بعنوان URL الأساسي للطلب. |
مطلوب |
params |
dict
|
المعلمات التي يجب تضمينها في الطلب. |
None
|
ارجاع:
نوع | وصف |
---|---|
Optional[Response]
|
كائن الاستجابة من طلب HTTP DELETE، أو لا شيء إذا فشل. |
شفرة المصدر في hub_sdk/base/api_client.py
get(endpoint, params=None)
تقديم طلب GET إلى واجهة برمجة التطبيقات.
البارامترات:
اسم | نوع | وصف | افتراضي |
---|---|---|---|
endpoint |
str
|
نقطة النهاية المراد إلحاقها بعنوان URL الأساسي للطلب. |
مطلوب |
params |
dict
|
معلمات الاستعلام للطلب. |
None
|
ارجاع:
نوع | وصف |
---|---|
Optional[Response]
|
كائن الاستجابة من طلب HTTP GET، لا شيء إذا فشل. |
شفرة المصدر في hub_sdk/base/api_client.py
patch(endpoint, data=None, json=None)
تقديم طلب تصحيح إلى واجهة برمجة التطبيقات.
البارامترات:
اسم | نوع | وصف | افتراضي |
---|---|---|---|
endpoint |
str
|
نقطة النهاية المراد إلحاقها بعنوان URL الأساسي للطلب. |
مطلوب |
data |
dict
|
البيانات المراد إرسالها في نص الطلب. |
None
|
json |
dict
|
يتم إرسال بيانات JSON في نص الطلب. |
None
|
ارجاع:
نوع | وصف |
---|---|
Optional[Response]
|
كائن الاستجابة من طلب تصحيح HTTP أو لا شيء إذا فشل. |
شفرة المصدر في hub_sdk/base/api_client.py
post(endpoint, data=None, json=None, files=None, stream=False)
تقديم طلب POST إلى واجهة برمجة التطبيقات.
البارامترات:
اسم | نوع | وصف | افتراضي |
---|---|---|---|
endpoint |
str
|
نقطة النهاية المراد إلحاقها بعنوان URL الأساسي للطلب. |
مطلوب |
data |
dict
|
البيانات المراد إرسالها في نص الطلب. |
None
|
json |
dict
|
يتم إرسال بيانات JSON في نص الطلب. |
None
|
files |
dict
|
الملفات المراد تضمينها في الطلب إن وجدت. |
None
|
stream |
bool
|
إذا كان هذا صحيحا ، بث محتوى الاستجابة. |
False
|
ارجاع:
نوع | وصف |
---|---|
Optional[Response]
|
كائن الاستجابة من طلب HTTP POST. |
شفرة المصدر في hub_sdk/base/api_client.py
put(endpoint, data=None, json=None)
تقديم طلب PUT إلى واجهة برمجة التطبيقات.
البارامترات:
اسم | نوع | وصف | افتراضي |
---|---|---|---|
endpoint |
str
|
نقطة النهاية المراد إلحاقها بعنوان URL الأساسي للطلب. |
مطلوب |
data |
Optional[Dict]
|
البيانات المراد إرسالها في نص الطلب. |
None
|
json |
Optional[Dict]
|
يتم إرسال بيانات JSON في نص الطلب |
None
|
ارجاع:
نوع | وصف |
---|---|
Optional[Response]
|
كائن الاستجابة من طلب HTTP PUT. |