Exceptions

General Exceptions

exception arya_api_framework.errors.FrameworkException

The core exception for all exceptions used in the API framework.

exception arya_api_framework.errors.MISSING

Raised when something is missing.

This often serves as an alternative to a None value when that may actually carry meaning.

exception arya_api_framework.errors.ValidationError

Raised when validating a variable’s type.

Client Exceptions

exception arya_api_framework.errors.ClientError

The parent exception for any client-specific errors.

exception arya_api_framework.errors.AsyncClientError
This exception inherits from ClientError.

The parent exception for any async client-specific errors.

exception arya_api_framework.errors.SyncClientError
This exception inherits from ClientError.

The parent exception for any sync client-specific errors.

Request Exceptions

exception arya_api_framework.errors.ResponseParseError(raw_response)
This exception inherits from ClientError.

The exception for failure to parse the response to request.

This is usually raised if the response body was not readable by json.loads().

raw_response

The raw response that was unable to be parsed.

Type

Union[str, bytes]

Attributes
exception arya_api_framework.errors.HTTPError(response)

The base exception for any request errors.

See HTTP Status Codes for information about HTTP status codes.

status_code

The status code of the error.

Type

int

response

The response that was received that raised the error.

Type

Union[str, bytes, dict, list, BaseModel]

Attributes
exception arya_api_framework.errors.HTTPRedirect(response)
This exception inherits from HTTPError.

Raised for any 3xx Redirection responses.

These codes indicate that further action needs to be taken by the user in order to fulfill the request.

See 3xx Redirect for information about 3xx responses.

Attributes
exception arya_api_framework.errors.HTTPClientError(response)
This exception inherits from HTTPError.

Raised for any 4xx Client Error responses.

These codes occur when an error has occurred as a result of the client application or user input, such as a malformed request.

See 4xx Client Error for information about 4xx responses.

Attributes
exception arya_api_framework.errors.HTTPServerError(response)
This exception inherits from HTTPError.

Raised for any 5xx Server Error responses.

These codes occur when the server is aware that is has made an error, or is incapable of performing the request.

See 5xx Server Error for information about 5xx responses.

Attributes

300 Errors

exception arya_api_framework.errors.HTTPMultipleChoices(response)
This exception inherits from HTTPRedirect.

300 Multiple Choices

Attributes
exception arya_api_framework.errors.HTTPMovedPermanently(response)
This exception inherits from HTTPRedirect.

301 Moved Permanently

Attributes
exception arya_api_framework.errors.HTTPFound(response)
This exception inherits from HTTPRedirect.

302 Found

Attributes
exception arya_api_framework.errors.HTTPSeeOther(response)
This exception inherits from HTTPRedirect.

303 See Other

Attributes
exception arya_api_framework.errors.HTTPNotModified(response)
This exception inherits from HTTPRedirect.

304 Not Modified

Attributes
exception arya_api_framework.errors.HTTPUseProxy(response)
This exception inherits from HTTPRedirect.

305 Use Proxy

Attributes
exception arya_api_framework.errors.HTTPReserved(response)
This exception inherits from HTTPRedirect.

306 (Unused)

Attributes
exception arya_api_framework.errors.HTTPTemporaryRedirect(response)
This exception inherits from HTTPRedirect.

307 Temporary Redirect

Attributes
exception arya_api_framework.errors.HTTPPermanentRedirect(response)
This exception inherits from HTTPRedirect.

308 Permanent Redirect

Attributes

400 Errors

exception arya_api_framework.errors.HTTPBadRequest(response)
This exception inherits from HTTPClientError.

400 Bad Request

Attributes
exception arya_api_framework.errors.HTTPUnauthorized(response)
This exception inherits from HTTPClientError.

401 Unauthorized

Attributes
exception arya_api_framework.errors.HTTPPaymentRequired(response)
This exception inherits from HTTPClientError.

402 Payment Required

Attributes
exception arya_api_framework.errors.HTTPForbidden(response)
This exception inherits from HTTPClientError.

403 Forbidden

Attributes
exception arya_api_framework.errors.HTTPNotFound(response)
This exception inherits from HTTPClientError.

404 Not Found

Attributes
exception arya_api_framework.errors.HTTPMethodNotAllowed(response)
This exception inherits from HTTPClientError.

405 Method Not Allowed

Attributes
exception arya_api_framework.errors.HTTPNotAcceptable(response)
This exception inherits from HTTPClientError.

406 Not Acceptable

Attributes
exception arya_api_framework.errors.HTTPProxyAuthenticationRequired(response)
This exception inherits from HTTPClientError.

407 Proxy Authentication Required

Attributes
exception arya_api_framework.errors.HTTPRequestTimeout(response)
This exception inherits from HTTPClientError.

408 Request Timeout

Attributes
exception arya_api_framework.errors.HTTPConflict(response)
This exception inherits from HTTPClientError.

409 Conflict

Attributes
exception arya_api_framework.errors.HTTPGone(response)
This exception inherits from HTTPClientError.

410 Gone

Attributes
exception arya_api_framework.errors.HTTPLengthRequired(response)
This exception inherits from HTTPClientError.

411 Length Required

Attributes
exception arya_api_framework.errors.HTTPPreconditionFailed(response)
This exception inherits from HTTPClientError.

412 Precondition Failed

Attributes
exception arya_api_framework.errors.HTTPRequestEntityTooLarge(response)
This exception inherits from HTTPClientError.

413 Content Too Large

Attributes
exception arya_api_framework.errors.HTTPRequestUriTooLong(response)
This exception inherits from HTTPClientError.

414 URI Too Long

Attributes
exception arya_api_framework.errors.HTTPUnsupportedMediaType(response)
This exception inherits from HTTPClientError.

415 Unsupported Media Type

Attributes
exception arya_api_framework.errors.HTTPRequestedRangeNotSatisfiable(response)
This exception inherits from HTTPClientError.

416 Range Not Satisfiable

Attributes
exception arya_api_framework.errors.HTTPExpectationFailed(response)
This exception inherits from HTTPClientError.

417 Expectation Failed

Attributes
exception arya_api_framework.errors.HTTPImATeapot(response)
This exception inherits from HTTPClientError.

418 (Unused)

Attributes
exception arya_api_framework.errors.HTTPMisdirectedRequest(response)
This exception inherits from HTTPClientError.

421 Misdirected Request

Attributes
exception arya_api_framework.errors.HTTPUnprocessableEntity(response)
This exception inherits from HTTPClientError.

422 Unprocessable Content

Attributes
exception arya_api_framework.errors.HTTPFailedDependency(response)
This exception inherits from HTTPClientError.

424 Object Required

Attributes
exception arya_api_framework.errors.HTTPTooEarly(response)
This exception inherits from HTTPClientError.

425 Too Early

Attributes
exception arya_api_framework.errors.HTTPUpgradeRequired(response)
This exception inherits from HTTPClientError.

426 Upgrade Required

Attributes
exception arya_api_framework.errors.HTTPPreconditionRequired(response)
This exception inherits from HTTPClientError.

428 Precondition Required

Attributes
exception arya_api_framework.errors.HTTPTooManyRequests(response)
This exception inherits from HTTPClientError.

429 Too Many Requests

Attributes
exception arya_api_framework.errors.HTTPRequestHeaderFieldsTooLarge(response)
This exception inherits from HTTPClientError.

431 Request header Fields Too Large

Attributes
exception arya_api_framework.errors.HTTPUnavailableForLegalReasons(response)
This exception inherits from HTTPClientError.

451 Unavailable for Legal Reasons

Attributes

500 Errors

exception arya_api_framework.errors.HTTPInternalServerError(response)
This exception inherits from HTTPClientError.

500 Internal Server Error

Attributes
exception arya_api_framework.errors.HTTPNotImplemented(response)
This exception inherits from HTTPClientError.

501 Not Implemented

Attributes
exception arya_api_framework.errors.HTTPBadGateway(response)
This exception inherits from HTTPClientError.

502 Bad Gateway

Attributes
exception arya_api_framework.errors.HTTPServiceUnavailable(response)
This exception inherits from HTTPClientError.

503 Service Unavailable

Attributes
exception arya_api_framework.errors.HTTPGatewayTimeout(response)
This exception inherits from HTTPClientError.

504 Gateway Timeout

Attributes
exception arya_api_framework.errors.HTTPHttpServerVersionNotSupported(response)
This exception inherits from HTTPClientError.

505 HTTP Version Not Supported

Attributes
exception arya_api_framework.errors.HTTPVariantAlsoNegotiates(response)
This exception inherits from HTTPClientError.

506 Variant Also Negotiates

Attributes
exception arya_api_framework.errors.HTTPInsufficientStorage(response)
This exception inherits from HTTPClientError.

507 Insufficient Storage

Attributes
exception arya_api_framework.errors.HTTPLoopDetected(response)
This exception inherits from HTTPClientError.

508 Loop Detected

Attributes
exception arya_api_framework.errors.HTTPNotExtended(response)
This exception inherits from HTTPClientError.

510 Not Extended

Attributes
exception arya_api_framework.errors.HTTPNetworkAuthenticationRequired(response)
This exception inherits from HTTPClientError.

511 Network Authentication Required

Attributes

Exception Hierarchy