path (bytes or unicode) – The path the revision was for.
revision (bytes or unicode) – The revision that was invalid.
detail (unicode, optional) – Additional detail to display after the standard error message.

__annotations__ = {}¶

exception FileNotFoundError(path, revision=None, detail=None, base_commit_id=None, context=None)[source]¶

Bases: SCMError

An error indicating a file was not found in a repository.

base_commit_id¶

The optional ID of the base commit the file and revision belonged to.

Type:: unicode

context¶

Extra context used to help look up the file.

New in version 4.0.5.

Type:: reviewboard.scmtools.core.FileLookupContext, optional

detail¶

Additional details for the error message.

Type:: unicode

path¶

The path in the repository.

Type:: unicode

revision¶

The revision in the repository.

Type:: reviewboard.scmtools.core.Revision or unicode

__init__(path, revision=None, detail=None, base_commit_id=None, context=None)[source]¶

Initialize the error.

Parameters:

path (unicode) – The path in the repository.
revision (reviewboard.scmtools.core.Revision or unicode, optional) – The revision in the repository.
detail (unicode, optional) – Additional details for the error message.
base_commit_id (unicode, optional) – The optional ID of the base commit the file and revision belonged to.
context (reviewboard.scmtools.core.FileLookupContext, optional) –
Extra context used to help look up the file.

New in version 4.0.5.

__annotations__ = {}¶

exception RepositoryNotFoundError(msg=None, form_field_id=None)[source]¶

Bases: SCMError

An error indicating that a given path is not a valid repository.

Changed in version 4.0.11: Added form_field_id and an equivalent argument to the constructor.

form_field_id¶

The ID of the form field that this error corresponds to.

This may be None if this error isn’t about a specific field.

New in version 4.0.11.

Type:: unicode

__init__(msg=None, form_field_id=None)[source]¶

Initialize the error.

Changed in version 4.0.11: This now takes optional msg and form_field_id parameters.

Parameters:

msg (unicode, optional) – The optional custom message to display.
form_field_id (unicode, optional) – The optional ID of the form field that this error corresponds to.

__annotations__ = {}¶

exception AuthenticationError(allowed_types=[], msg=None, user_key=None)[source]¶

Bases: SSHAuthenticationError, SCMError

An error representing a failed authentication for a repository.

This takes a list of authentication types that are allowed. These are dependent on the backend, but are loosely based on SSH authentication mechanisms. Primarily, we respond to “password” and “publickey”.

This may also take the user’s SSH key that was tried, if any.

__annotations__ = {}¶

exception UnverifiedCertificateError(certificate: Certificate)[source]¶

Bases: ClassDeprecatedMixin, SCMError

An error representing an unverified SSL certificate.

Deprecated since version 6.0: This is deprecated in favor of reviewboard.certs.errors.CertificateVerificationError, and will be removed in Review Board 8.

__init__(certificate: Certificate) → None[source]¶

Initialize the error message.

Parameters:: certificate (reviewboard.scmtools.certs.Certificate) – The certificate this error pertains to.

__annotations__ = {'certificate': 'Certificate'}¶

certificate: Certificate¶

The certificate generating this error.

Type:: reviewboard.scmtools.certs.Certificate