انتقل إلى المحتوى

مرجع ل hub_sdk/helpers/error_handler.py

ملاحظه

هذا الملف متاح في https://github.com/ultralytics/hub-SDK / نقطة / الرئيسية /hub_sdk / المساعدين / error_handler.py. إذا اكتشفت مشكلة ، فيرجى المساعدة في إصلاحها من خلال المساهمة في طلب 🛠️ سحب. شكرا لك 🙏!



hub_sdk.helpers.error_handler.ErrorHandler

يمثل معالج أخطاء لإدارة رموز حالة HTTP ورسائل الخطأ.

سمات:

اسم نوع وصف
status_code int

رمز حالة HTTP المقترن بالخطأ.

message (str, None)

رسالة خطأ اختيارية توفر تفاصيل إضافية. الإعدادات الافتراضية إلى لا شيء.

شفرة المصدر في hub_sdk/helpers/error_handler.py
 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 2930 31 32 33343536373839404142 43 44 45 46 47 48 49 50 51 52 53 5455 56 575859 60 61 62 63 64 6566 676869707172 73 74 75 76 77 78 79808182 838485868788
class ErrorHandler:
    """
    Represents an error handler for managing HTTP status codes and error messages.

    Attributes:
        status_code (int): The HTTP status code associated with the error.
        message (str, None): An optional error message providing additional details.
            Defaults to None.
    """

    def __init__(self, status_code: int, message: Optional[str] = None):
        """
        Initialize the ErrorHandler object with a given status code.

        Args:
            status_code (int): The HTTP status code representing the error.
            message (str, optional): An optional error message providing additional details.
        """
        self.status_code = status_code
        self.message = message

    def handle(self) -> str:
        """
        Handle the error based on the provided status code.

        Returns:
            (str): A message describing the error.
        """
        error_handlers = {
            401: self.handle_unauthorized,
            404: self.handle_not_found,
            500: self.handle_internal_server_error,
        }

        handler = error_handlers.get(self.status_code, self.get_default_message)
        return handler()

    def handle_unauthorized(self) -> str:
        """
        Handle an unauthorized error (HTTP 401).

        Returns:
            (str): An error message indicating unauthorized access.
        """
        return "Unauthorized: Please check your credentials."

    def handle_not_found(self) -> str:
        """
        Handle a resource not found error (HTTP 404).

        Returns:
            (str): An error message indicating that the requested resource was not found.
        """
        return "Resource not found."

    def handle_internal_server_error(self) -> str:
        """
        Handle an internal server error (HTTP 500).

        Returns:
            (str): An error message indicating an internal server error.
        """
        return "Internal server error."

    def handle_unknown_error(self) -> str:
        """
        Handle an unknown error.

        Returns:
            (str): An error message indicating that an unknown error occurred.
        """
        return "Unknown error occurred."

    def get_default_message(self) -> str:
        """
        Get the default error message for a given HTTP status code.

        Returns:
            (str): The default error message associated with the provided status code.
                 If no message is found, it falls back to handling an unknown error.
        """
        return http.client.responses.get(self.status_code, self.handle_unknown_error())

__init__(status_code, message=None)

تهيئة كائن ErrorHandler برمز حالة معين.

البارامترات:

اسم نوع وصف افتراضي
status_code int

رمز حالة HTTP الذي يمثل الخطأ.

مطلوب
message str

رسالة خطأ اختيارية توفر تفاصيل إضافية.

None
شفرة المصدر في hub_sdk/helpers/error_handler.py
def __init__(self, status_code: int, message: Optional[str] = None):
    """
    Initialize the ErrorHandler object with a given status code.

    Args:
        status_code (int): The HTTP status code representing the error.
        message (str, optional): An optional error message providing additional details.
    """
    self.status_code = status_code
    self.message = message

get_default_message()

احصل على رسالة الخطأ الافتراضية لرمز حالة HTTP معين.

ارجاع:

نوع وصف
str

رسالة الخطأ الافتراضية المقترنة برمز الحالة المقدم. إذا لم يتم العثور على رسالة ، فإنها تعود إلى معالجة خطأ غير معروف.

شفرة المصدر في hub_sdk/helpers/error_handler.py
def get_default_message(self) -> str:
    """
    Get the default error message for a given HTTP status code.

    Returns:
        (str): The default error message associated with the provided status code.
             If no message is found, it falls back to handling an unknown error.
    """
    return http.client.responses.get(self.status_code, self.handle_unknown_error())

handle()

تعامل مع الخطأ بناء على رمز الحالة المقدم.

ارجاع:

نوع وصف
str

رسالة تصف الخطأ.

شفرة المصدر في hub_sdk/helpers/error_handler.py
28 2930 31 32 33 34 35 36 37 38394041 42
def handle(self) -> str:
    """
    Handle the error based on the provided status code.

    Returns:
        (str): A message describing the error.
    """
    error_handlers = {
        401: self.handle_unauthorized,
        404: self.handle_not_found,
        500: self.handle_internal_server_error,
    }

    handler = error_handlers.get(self.status_code, self.get_default_message)
    return handler()

handle_internal_server_error()

معالجة خطأ خادم داخلي (HTTP 500).

ارجاع:

نوع وصف
str

رسالة خطأ تشير إلى خطأ داخلي في الخادم.

شفرة المصدر في hub_sdk/helpers/error_handler.py
62 63 64 65666768 69
def handle_internal_server_error(self) -> str:
    """
    Handle an internal server error (HTTP 500).

    Returns:
        (str): An error message indicating an internal server error.
    """
    return "Internal server error."

handle_not_found()

معالجة خطأ لم يتم العثور على مورد (HTTP 404).

ارجاع:

نوع وصف
str

رسالة خطأ تشير إلى أنه لم يتم العثور على المورد المطلوب.

شفرة المصدر في hub_sdk/helpers/error_handler.py
def handle_not_found(self) -> str:
    """
    Handle a resource not found error (HTTP 404).

    Returns:
        (str): An error message indicating that the requested resource was not found.
    """
    return "Resource not found."

handle_unauthorized()

معالجة خطأ غير مصرح به (HTTP 401).

ارجاع:

نوع وصف
str

رسالة خطأ تشير إلى الوصول غير المصرح به.

شفرة المصدر في hub_sdk/helpers/error_handler.py
def handle_unauthorized(self) -> str:
    """
    Handle an unauthorized error (HTTP 401).

    Returns:
        (str): An error message indicating unauthorized access.
    """
    return "Unauthorized: Please check your credentials."

handle_unknown_error()

تعامل مع خطأ غير معروف.

ارجاع:

نوع وصف
str

رسالة خطأ تشير إلى حدوث خطأ غير معروف.

شفرة المصدر في hub_sdk/helpers/error_handler.py
71 72 73 74757677 78
def handle_unknown_error(self) -> str:
    """
    Handle an unknown error.

    Returns:
        (str): An error message indicating that an unknown error occurred.
    """
    return "Unknown error occurred."