|
1 | | -class BaseUrlMissingError(Exception): |
2 | | - def __init__( |
3 | | - self, |
4 | | - message="Authentication required. Please run \033[1muipath auth\033[22m.", |
5 | | - ): |
| 1 | +"""Custom exceptions for the UiPath SDK. |
| 2 | +
|
| 3 | +This module defines a hierarchy of custom exceptions used throughout the SDK |
| 4 | +to provide more specific error handling and better error messages. |
| 5 | +""" |
| 6 | + |
| 7 | +from typing import Any, Optional |
| 8 | + |
| 9 | + |
| 10 | +class UiPathError(Exception): |
| 11 | + """Base exception class for all UiPath SDK errors. |
| 12 | +
|
| 13 | + All custom exceptions in the SDK should inherit from this class. |
| 14 | +
|
| 15 | + Attributes: |
| 16 | + message: A human-readable error message |
| 17 | + details: Optional additional error details |
| 18 | + """ |
| 19 | + |
| 20 | + def __init__(self, message: str, details: Optional[Any] = None) -> None: |
6 | 21 | self.message = message |
| 22 | + self.details = details |
| 23 | + |
7 | 24 | super().__init__(self.message) |
8 | 25 |
|
9 | 26 |
|
10 | | -class SecretMissingError(Exception): |
| 27 | +class ConfigurationError(UiPathError): |
| 28 | + """Base class for configuration-related errors.""" |
| 29 | + |
| 30 | + pass |
| 31 | + |
| 32 | + |
| 33 | +class BaseUrlMissingError(ConfigurationError): |
| 34 | + """Raised when the base URL is not configured.""" |
| 35 | + |
11 | 36 | def __init__( |
12 | 37 | self, |
13 | | - message="Authentication required. Please run \033[1muipath auth\033[22m.", |
14 | | - ): |
15 | | - self.message = message |
16 | | - super().__init__(self.message) |
| 38 | + message: str = "Authentication required. Please run \033[1muipath auth\033[22m.", |
| 39 | + ) -> None: |
| 40 | + super().__init__(message) |
| 41 | + |
| 42 | + |
| 43 | +class AccessTokenMissingError(ConfigurationError): |
| 44 | + """Raised when the access token is not configured.""" |
| 45 | + |
| 46 | + def __init__( |
| 47 | + self, |
| 48 | + message: str = "Authentication required. Please run \033[1muipath auth\033[22m.", |
| 49 | + ) -> None: |
| 50 | + super().__init__(message) |
| 51 | + |
| 52 | + |
| 53 | +class APIError(UiPathError): |
| 54 | + """Base class for API-related errors. |
| 55 | +
|
| 56 | + Attributes: |
| 57 | + status_code: The HTTP status code of the failed request |
| 58 | + response_body: The response body from the failed request |
| 59 | + """ |
| 60 | + |
| 61 | + def __init__( |
| 62 | + self, |
| 63 | + message: str, |
| 64 | + status_code: Optional[int] = None, |
| 65 | + response_body: Optional[str] = None, |
| 66 | + ) -> None: |
| 67 | + self.status_code = status_code |
| 68 | + self.response_body = response_body |
| 69 | + super().__init__( |
| 70 | + message, |
| 71 | + details={"status_code": status_code, "response_body": response_body}, |
| 72 | + ) |
| 73 | + |
| 74 | + |
| 75 | +class BadRequestError(APIError): |
| 76 | + """Raised when the API request is malformed (400).""" |
| 77 | + |
| 78 | + def __init__(self, response_body: str, message: str | None = None) -> None: |
| 79 | + if message is None: |
| 80 | + message = "Bad request" |
| 81 | + super().__init__(message, status_code=400, response_body=response_body) |
| 82 | + |
| 83 | + |
| 84 | +class UnauthorizedError(APIError): |
| 85 | + """Raised when authentication fails (401).""" |
| 86 | + |
| 87 | + def __init__(self, response_body: str, message: str | None = None) -> None: |
| 88 | + if message is None: |
| 89 | + message = "Unauthorized" |
| 90 | + super().__init__(message, status_code=401, response_body=response_body) |
| 91 | + |
| 92 | + |
| 93 | +class ForbiddenError(APIError): |
| 94 | + """Raised when the user doesn't have permission (403).""" |
| 95 | + |
| 96 | + def __init__(self, response_body: str, message: str | None = None) -> None: |
| 97 | + if message is None: |
| 98 | + message = "Forbidden" |
| 99 | + super().__init__(message, status_code=403, response_body=response_body) |
| 100 | + |
| 101 | + |
| 102 | +class NotFoundError(APIError): |
| 103 | + """Raised when the requested resource is not found (404).""" |
| 104 | + |
| 105 | + def __init__(self, response_body: str, message: str | None = None) -> None: |
| 106 | + if message is None: |
| 107 | + message = "Not found" |
| 108 | + super().__init__(message, status_code=404, response_body=response_body) |
| 109 | + |
| 110 | + |
| 111 | +class ConflictError(APIError): |
| 112 | + """Raised when the request cannot be processed due to a conflict (409).""" |
| 113 | + |
| 114 | + def __init__(self, response_body: str, message: str | None = None) -> None: |
| 115 | + if message is None: |
| 116 | + message = "Conflict" |
| 117 | + super().__init__(message, status_code=409, response_body=response_body) |
| 118 | + |
| 119 | + |
| 120 | +class RateLimitError(APIError): |
| 121 | + """Raised when the API rate limit is exceeded (429).""" |
| 122 | + |
| 123 | + def __init__(self, response_body: str, message: str | None = None) -> None: |
| 124 | + if message is None: |
| 125 | + message = "Rate limit exceeded" |
| 126 | + super().__init__(message, status_code=429, response_body=response_body) |
| 127 | + |
| 128 | + |
| 129 | +class ServerError(APIError): |
| 130 | + """Raised when the API server encounters an error (5xx).""" |
| 131 | + |
| 132 | + def __init__(self, response_body: str, message: str | None = None) -> None: |
| 133 | + if message is None: |
| 134 | + message = "Server error" |
| 135 | + super().__init__(message, status_code=500, response_body=response_body) |
0 commit comments