rbtools.api.errors¶

Error classes and codes for API communication.

Functions

create_api_error(http_status, *args, **kwargs)

Create an error instance.

Exceptions

`APIError`([http_status, error_code, rsp, message])	An error communicating with the API.
`AuthorizationError`([http_status, ...])	Authorization error when communicating with the API.
`BadRequestError`([http_status, error_code, ...])	Bad request data made to an API.
`CacheError`	An exception for caching errors.
`ServerInterfaceError`(msg, args, *kwargs)	A non-API error when communicating with a server.
`ServerInterfaceSSLError`(*, host, port, ...)	An error communicating over SSL or verifying an SSL certificate.

exception rbtools.api.errors.APIError(http_status: Optional[int] = None, error_code: Optional[int] = None, rsp: Optional[Dict] = None, message: Optional[str] = None, *args, **kwargs)[source]¶

Bases: Exception

An error communicating with the API.

error_code¶

The API error code. This may be None.

Type:: int

http_status¶

The HTTP status code.

Type:: int

message¶

The error message from the API response. This may be None.

New in version 3.1.

Type:: str

rsp¶

The API response payload. This may be None.

Type:: dict

default_message: str = 'An error occurred when communicating with Review Board.'¶

The default error message used if a specific error is not available.

New in version 3.1.

Type:: str

__init__(http_status: Optional[int] = None, error_code: Optional[int] = None, rsp: Optional[Dict] = None, message: Optional[str] = None, *args, **kwargs) → None[source]¶

Initialize the error.

Parameters:

http_status (int, optional) –
The HTTP status code associated with this error.

Changed in version 3.1: This is now optional.
error_code (int, optional) –
The API error code associated with this error.

Changed in version 3.1: This is now optional.
rsp (dict, optional) – The API response payload. This may be None for non-API Error payloads.
message (str, optional) –
A specific error message to use. This will take precedence over any errors in rsp.

New in version 3.1.
*args (tuple) – Extra positional arguments to pass to the base constructor.
**kwargs (dict) – Extra keyword arguments to pass to the base constructor.

__str__() → str[source]¶

Return a string representation of the error.

The explicit message passed to the constructor will be used if provided. If not provided, this will fall back to the message in the rsp payload, or to default_message.

If an API error code is available, it will be included in the message. If one is not provided, but an HTTP status is available, then it will be included instead.

Returns:: The error message.
Return type:: str

exception rbtools.api.errors.AuthorizationError(http_status: Optional[int] = None, error_code: Optional[int] = None, rsp: Optional[Dict] = None, message: Optional[str] = None, *args, **kwargs)[source]¶

Bases: APIError

Authorization error when communicating with the API.

default_message: str = 'Error authenticating to Review Board.'¶

The default error message used if a specific error is not available.

New in version 3.1.

Type:: str

exception rbtools.api.errors.BadRequestError(http_status: Optional[int] = None, error_code: Optional[int] = None, rsp: Optional[Dict] = None, message: Optional[str] = None, *args, **kwargs)[source]¶

Bases: APIError

Bad request data made to an API.

default_message: str = 'Missing or invalid data was sent to Review Board.'¶

The default error message used if a specific error is not available.

New in version 3.1.

Type:: str

__str__() → str[source]¶

Return a string representation of the error.

If the payload contains a list of fields, the error associated with each field will be included.

Returns:: The error message.
Return type:: str

exception rbtools.api.errors.CacheError[source]¶

Bases: Exception

An exception for caching errors.

exception rbtools.api.errors.ServerInterfaceError(msg: str, *args, **kwargs)[source]¶

Bases: Exception

A non-API error when communicating with a server.

__init__(msg: str, *args, **kwargs) → None[source]¶

Initialize the error.

Parameters:

msg (str) – The error’s message.
*args (tuple) – Positional arguments to pass through to the base class.
**kwargs (dict) – Keyword arguments to pass through to the base class.

__str__() → str[source]¶

Return the error message as a unicode string.

Returns:: The error message as a unicode string.
Return type:: str

exception rbtools.api.errors.ServerInterfaceSSLError(*, host: str, port: int, ssl_error: SSLError, ssl_context: SSLContext)[source]¶

Bases: ServerInterfaceError

An error communicating over SSL or verifying an SSL certificate.

This class wraps a ssl.SSLError or subclass, and attempts to generate a helpful error message with instructions for resolving most common SSL-related issues.

New in version 4.1.

__init__(*, host: str, port: int, ssl_error: SSLError, ssl_context: SSLContext) → None[source]¶

Initialize the error.

Parameters:

host (str) – The hostname RBTools attempted to connect to.
port (int) – The port RBTools attempted to connect to.
ssl_error (ssl.SSLError) – The original SSL error.
ssl_context (ssl.SSLContext) – The original SSL context.

host: str¶: The hostname RBTools attempted to connect to.

port: int¶: The port RBTools attempted to connect to.

ssl_error: SSLError¶: The original SSL error.

ssl_context: SSLContext¶

rbtools.api.errors.create_api_error(http_status: int, *args, **kwargs) → APIError[source]¶

Create an error instance.

Parameters:

http_status (int) – The HTTP status code.
*args (tuple) – Positional arguments to pass through to the error class.
**kwargs (dict) – Keyword arguments to pass through to the error class.

Returns:

The error instance.

Return type:

APIError