Skip to content

Reference for hub_sdk/helpers/error_handler.py

Note

This file is available at https://github.com/ultralytics/hub-sdk/blob/main/hub_sdk/helpers/error_handler.py. If you spot a problem please help fix it by contributing a Pull Request 🛠️. Thank you 🙏!


hub_sdk.helpers.error_handler.ErrorHandler

ErrorHandler(
    status_code: int,
    message: Optional[str] = None,
    headers: Optional[dict] = None,
)

Represents an error handler for managing HTTP status codes and error messages.

Attributes:

NameTypeDescription
status_codeint

The HTTP status code associated with the error.

message(str, None)

An optional error message providing additional details. Defaults to None.

headers(dict, None)

An optional dictionary providing response headers details. Defaults to None.

Parameters:

NameTypeDescriptionDefault
status_codeint

The HTTP status code representing the error.

required
messagestr

An optional error message providing additional details.

None
headers(dict, None)

An optional dictionary providing response headers details.

None
Source code in hub_sdk/helpers/error_handler.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
def __init__(
    self,
    status_code: int,
    message: Optional[str] = None,
    headers: Optional[dict] = 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.
        headers (dict, None): An optional dictionary providing response headers details.
    """
    self.status_code = status_code
    self.message = message
    self.headers = headers

get_default_message

get_default_message() -> str

Get the default error message for a given HTTP status code.

Returns:

TypeDescription
str

The default error message associated with the provided status code. If no message is found, it falls back to handling an unknown error.

Source code in hub_sdk/helpers/error_handler.py 
118
119
120
121
122
123
124
125
126
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

handle() -> str

Handle the error based on the provided status code.

Returns:

TypeDescription
str

A message describing the error.

Source code in hub_sdk/helpers/error_handler.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
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,
        429: self.handle_ratelimit_exceeded,
    }

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

handle_internal_server_error staticmethod 

handle_internal_server_error() -> str

Handle an internal server error (HTTP 500).

Returns:

TypeDescription
str

An error message indicating an internal server error.

Source code in hub_sdk/helpers/error_handler.py 
 98
 99
100
101
102
103
104
105
106
@staticmethod
def handle_internal_server_error() -> 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 staticmethod 

handle_not_found() -> str

Handle a resource not found error (HTTP 404).

Returns:

TypeDescription
str

An error message indicating that the requested resource was not found.

Source code in hub_sdk/helpers/error_handler.py 
88
89
90
91
92
93
94
95
96
@staticmethod
def handle_not_found() -> 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_ratelimit_exceeded

handle_ratelimit_exceeded() -> str

Handle rate limit exceeded error (HTTP 429).

Returns:

TypeDescription
str

An error message indicating rate limit exceeded.

Source code in hub_sdk/helpers/error_handler.py 
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
def handle_ratelimit_exceeded(self) -> str:
    """
    Handle rate limit exceeded error (HTTP 429).

    Returns:
        (str): An error message indicating rate limit exceeded.
    """
    error_msg = "Rate Limits Exceeded: Please try again later."

    if "X-RateLimit-Reset" in self.headers:
        rate_reset = self.headers.get("X-RateLimit-Reset")

        try:
            reset_time = datetime.datetime.fromtimestamp(int(rate_reset)).strftime("%Y-%m-%d %H:%M:%S")
        except ValueError:
            reset_time = "unknown"

        error_msg = (
            "You have exceeded the rate limits for this request. "
            f"You will be able to make requests again after {reset_time}."
        )
    return error_msg

handle_unauthorized staticmethod 

handle_unauthorized() -> str

Handle an unauthorized error (HTTP 401).

Returns:

TypeDescription
str

An error message indicating unauthorized access.

Source code in hub_sdk/helpers/error_handler.py 
55
56
57
58
59
60
61
62
63
@staticmethod
def handle_unauthorized() -> str:
    """
    Handle an unauthorized error (HTTP 401).

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

handle_unknown_error staticmethod 

handle_unknown_error() -> str

Handle an unknown error.

Returns:

TypeDescription
str

An error message indicating that an unknown error occurred.

Source code in hub_sdk/helpers/error_handler.py 
108
109
110
111
112
113
114
115
116
@staticmethod
def handle_unknown_error() -> str:
    """
    Handle an unknown error.

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