Zum Inhalt springen

Referenz fĂźr hub_sdk/helpers/error_handler.py

Hinweis

Diese Datei ist verfügbar unter https://github.com/ultralytics/ hub-sdk/blob/main/ hub_sdk/helpers/error_handler .py. Wenn du ein Problem entdeckst, hilf bitte mit, es zu beheben, indem du einen Pull Request 🛠️ einreichst. Vielen Dank 🙏!



hub_sdk.helpers.error_handler.ErrorHandler

Stellt einen Error-Handler fĂźr die Verwaltung von HTTP-Statuscodes und Fehlermeldungen dar.

Attribute:

Name Typ Beschreibung
status_code int

Der HTTP-Statuscode, der mit dem Fehler verbunden ist.

message (str, None)

Eine optionale Fehlermeldung mit zusätzlichen Details. Der Standardwert ist Keine.

Quellcode in hub_sdk/helpers/error_handler.py
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)

Initialisiere das ErrorHandler-Objekt mit einem bestimmten Statuscode.

Parameter:

Name Typ Beschreibung Standard
status_code int

Der HTTP-Statuscode, der den Fehler angibt.

erforderlich
message str

Eine optionale Fehlermeldung mit zusätzlichen Details.

None
Quellcode in 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()

Ermittelt die Standardfehlermeldung fĂźr einen bestimmten HTTP-Statuscode.

Retouren:

Typ Beschreibung
str

Die Standardfehlermeldung, die mit dem angegebenen Statuscode verbunden ist. Wenn keine Meldung gefunden wird, wird ein unbekannter Fehler behandelt.

Quellcode in 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()

Bearbeite den Fehler anhand des angegebenen Statuscodes.

Retouren:

Typ Beschreibung
str

Eine Meldung, die den Fehler beschreibt.

Quellcode in hub_sdk/helpers/error_handler.py
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()

Behandle einen internen Serverfehler (HTTP 500).

Retouren:

Typ Beschreibung
str

Eine Fehlermeldung, die auf einen internen Serverfehler hinweist.

Quellcode in hub_sdk/helpers/error_handler.py
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()

Behandle einen Fehler bei einer nicht gefundenen Ressource (HTTP 404).

Retouren:

Typ Beschreibung
str

Eine Fehlermeldung, die anzeigt, dass die angeforderte Ressource nicht gefunden wurde.

Quellcode in 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()

Behandle einen nicht autorisierten Fehler (HTTP 401).

Retouren:

Typ Beschreibung
str

Eine Fehlermeldung, die auf einen nicht autorisierten Zugriff hinweist.

Quellcode in 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()

Behandle einen unbekannten Fehler.

Retouren:

Typ Beschreibung
str

Eine Fehlermeldung, die anzeigt, dass ein unbekannter Fehler aufgetreten ist.

Quellcode in hub_sdk/helpers/error_handler.py
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."