コンテンツへスキップ

参考 hub_sdk/helpers/error_handler.py

備考

このファイルはhttps://github.com/ultralytics/hub-sdk/blob/main/ hub_sdk/helpers/error_handler .py にあります。もし問題を発見したら、Pull Request🛠️ を投稿して修正にご協力ください。ありがとうございました!



hub_sdk.helpers.error_handler.ErrorHandler

HTTP ステータスコードとエラーメッセージを管理するエラーハンドラを表します。

属性:

名称 タイプ 説明
status_code int

エラーに関連するHTTPステータスコード。

message (str, None)

オプションのエラー・メッセージ。 デフォルトは None です。

ソースコード 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)

指定されたステータスコードで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
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
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
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."