reviewboard.hostingsvcs.errors¶

Errors for hosting service operations.

exception HostingServiceError(message: str, http_code: Optional[int] = None, help_link: Optional[str] = None, help_link_text: Optional[str] = None)[source]¶

Bases: Exception

Base class for errors related to a hosting service.

__init__(message: str, http_code: Optional[int] = None, help_link: Optional[str] = None, help_link_text: Optional[str] = None) → None[source]¶

Initialize the error.

Parameters:

• message (str) – The error message.

• http_code (int, optional) – An optional HTTP status code for the error.

• help_link (str, optional) – An optional URL for further information on the error.

• help_link_text (str, optional) –

  A label for the optional URL for further information on the error.

  This must be provided if help_link is set.

Raises:

ValueError – help_link was provided but help_link_text was not.

http_code: Optional[int]¶

The optional HTTP status code for the error.

help_link: Optional[str]¶

An optional URL for further information on the error.

help_link_text: Optional[str]¶

A label for the optional URL for further information on the error.

This will always be provided if help_link is set.

__annotations__ = {'help_link': 'Optional[str]', 'help_link_text': 'Optional[str]', 'http_code': 'Optional[int]'}¶

exception HostingServiceAPIError(msg: Optional[str] = None, http_code: Optional[int] = None, rsp: Optional[Dict] = None)[source]¶

Bases: HostingServiceError

An API error from a hosting service.

This represents an error from the hosting service’s API. It contains the error message, HTTP code, and the parsed response payload.

HostingServiceAPIError instances can be further turned into other error types, or raised directly, if the error message is suitable for display.

http_code¶

The HTTP code for the error.

Type:

int

rsp¶

The parsed payload for the error, if available.

Type:

object

__init__(msg: Optional[str] = None, http_code: Optional[int] = None, rsp: Optional[Dict] = None) → None[source]¶

Initialize the error.

Parameters:

• msg (unicode, optional) – The error message from the service.

• http_code (int, optional) – The HTTP code for the error.

• rsp (object, optional) – The parsed payload for the error.

http_code: Optional[int]¶

The HTTP status code for the error, if available.

rsp: Optional[Dict]¶

The parsed payload for the error, if available.

__annotations__ = {'help_link': 'Optional[str]', 'help_link_text': 'Optional[str]', 'http_code': 'Optional[int]', 'rsp': 'Optional[Dict]'}¶

exception RepositoryError(message: str, http_code: Optional[int] = None, help_link: Optional[str] = None, help_link_text: Optional[str] = None)[source]¶

Bases: HostingServiceError

An error validating, configuring or using a repository.

http_code: Optional[int]¶

The optional HTTP status code for the error.

help_link: Optional[str]¶

An optional URL for further information on the error.

help_link_text: Optional[str]¶

A label for the optional URL for further information on the error.

This will always be provided if help_link is set.

exception AuthorizationError(message: str, http_code: Optional[int] = None, help_link: Optional[str] = None, help_link_text: Optional[str] = None)[source]¶

Bases: HostingServiceError

An error authorizing an account with a hosting service.

http_code: Optional[int]¶

The optional HTTP status code for the error.

help_link: Optional[str]¶

An optional URL for further information on the error.

help_link_text: Optional[str]¶

A label for the optional URL for further information on the error.

This will always be provided if help_link is set.

exception MissingHostingServiceError(hosting_service_id: str, repository: Optional[str] = None)[source]¶

Bases: HostingServiceError

Indicates that the hosting service could not be loaded.

__annotations__ = {'hosting_service_id': 'str'}¶

__init__(hosting_service_id: str, repository: Optional[str] = None) → None[source]¶

Initialize the error.

Parameters:

• hosting_service_id (str) – The ID of the hosting service that cannot be loaded.

• repository (str, optional) – The name of the repository that is loading the hosting service.

hosting_service_id: str¶

The ID of the hosting service associated with this error.

Type:

str

exception TwoFactorAuthCodeRequiredError(message: str, http_code: Optional[int] = None, help_link: Optional[str] = None, help_link_text: Optional[str] = None)[source]¶

Bases: AuthorizationError

Response from a service indicating a two-factor auth code is required.

Some services will indicate, after an authorization attempt, that a two-factor authorization code must be provided to complete authorization. Services can raise this error, along with a helpful message, to inform the user and the repository form of this.

http_code: Optional[int]¶

The optional HTTP status code for the error.

help_link: Optional[str]¶

An optional URL for further information on the error.

help_link_text: Optional[str]¶

A label for the optional URL for further information on the error.

This will always be provided if help_link is set.

exception InvalidPlanError(plan: str)[source]¶

Bases: HostingServiceError

Indicates an invalid plan name was used.

http_code: Optional[int]¶

The optional HTTP status code for the error.

help_link: Optional[str]¶

An optional URL for further information on the error.

help_link_text: Optional[str]¶

A label for the optional URL for further information on the error.

This will always be provided if help_link is set.

__init__(plan: str) → None[source]¶

Initialize the error.

Parameters:

plan (str) – The ID of the plan.

exception SSHKeyAssociationError(message: str, http_code: Optional[int] = None, help_link: Optional[str] = None, help_link_text: Optional[str] = None)[source]¶

Bases: HostingServiceError

An error associating an SSH key with an account on a hosting service.

http_code: Optional[int]¶

The optional HTTP status code for the error.

help_link: Optional[str]¶

An optional URL for further information on the error.

help_link_text: Optional[str]¶

A label for the optional URL for further information on the error.

This will always be provided if help_link is set.