Start defining custom errors in one place (#2122)

* Moved InferenceTimeoutError

* Moved text generation errors

---------

Co-authored-by: Lucain <lucainp@gmail.com>

src/huggingface_hub/errors.py

@@ -0,0 +1,38 @@
+"""Contains all custom errors."""
+
+from requests import HTTPError
+
+
+# INFERENCE CLIENT ERRORS
+
+
+class InferenceTimeoutError(HTTPError, TimeoutError):
+    """Error raised when a model is unavailable or the request times out."""
+
+
+# TEXT GENERATION ERRORS
+
+
+class TextGenerationError(HTTPError):
+    """Generic error raised if text-generation went wrong."""
+
+
+# Text Generation Inference Errors
+class ValidationError(TextGenerationError):
+    """Server-side validation error."""
+
+
+class GenerationError(TextGenerationError):
+    pass
+
+
+class OverloadedError(TextGenerationError):
+    pass
+
+
+class IncompleteGenerationError(TextGenerationError):
+    pass
+
+
+class UnknownError(TextGenerationError):
+    pass

src/huggingface_hub/inference/_client.py

@@ -53,10 +53,10 @@
 from requests.structures import CaseInsensitiveDict
 
 from huggingface_hub.constants import ALL_INFERENCE_API_FRAMEWORKS, INFERENCE_ENDPOINT, MAIN_INFERENCE_API_FRAMEWORKS
+from huggingface_hub.errors import InferenceTimeoutError
 from huggingface_hub.inference._common import (
     TASKS_EXPECTING_IMAGES,
     ContentT,
-    InferenceTimeoutError,
     ModelStatus,
     _b64_encode,
     _b64_to_image,

src/huggingface_hub/inference/_common.py

@@ -38,8 +38,6 @@
     overload,
 )
 
-from requests import HTTPError
-
 from ..constants import ENDPOINT
 from ..utils import (
     build_hf_headers,
@@ -99,10 +97,6 @@ class ModelStatus:
     framework: str
 
 
-class InferenceTimeoutError(HTTPError, TimeoutError):
-    """Error raised when a model is unavailable or the request times out."""
-
-
 ## IMPORT UTILS
 
 

src/huggingface_hub/inference/_generated/_async_client.py

@@ -39,10 +39,10 @@
 from requests.structures import CaseInsensitiveDict
 
 from huggingface_hub.constants import ALL_INFERENCE_API_FRAMEWORKS, INFERENCE_ENDPOINT, MAIN_INFERENCE_API_FRAMEWORKS
+from huggingface_hub.errors import InferenceTimeoutError
 from huggingface_hub.inference._common import (
     TASKS_EXPECTING_IMAGES,
     ContentT,
-    InferenceTimeoutError,
     ModelStatus,
     _async_stream_text_generation_response,
     _b64_encode,

src/huggingface_hub/inference/_text_generation.py

@@ -29,6 +29,15 @@
 
 from requests import HTTPError
 
+from huggingface_hub.errors import (
+    GenerationError,
+    IncompleteGenerationError,
+    OverloadedError,
+    TextGenerationError,
+    UnknownError,
+    ValidationError,
+)
+
 from ..utils import is_pydantic_available
 
 
@@ -487,31 +496,6 @@ def __post_init__(self):
 # ----------------------
 
 
-class TextGenerationError(HTTPError):
-    """Generic error raised if text-generation went wrong."""
-
-
-# Text Generation Inference Errors
-class ValidationError(TextGenerationError):
-    """Server-side validation error."""
-
-
-class GenerationError(TextGenerationError):
-    pass
-
-
-class OverloadedError(TextGenerationError):
-    pass
-
-
-class IncompleteGenerationError(TextGenerationError):
-    pass
-
-
-class UnknownError(TextGenerationError):
-    pass
-
-
 def raise_text_generation_error(http_error: HTTPError) -> NoReturn:
     """
     Try to parse text-generation-inference error message and raise HTTPError in any case.