rbtools.clients.errors¶

Error definitions for SCMClient implementations.

Exceptions

exception rbtools.clients.errors.SCMError[source]¶

Bases: Exception

A generic error from an SCM.

exception rbtools.clients.errors.AuthenticationError[source]¶

Bases: Exception

An error for when authentication fails.

exception rbtools.clients.errors.CreateCommitError[source]¶

Bases: Exception

The creation of a commit has failed or was aborted.

exception rbtools.clients.errors.MergeError[source]¶

Bases: Exception

An error for when merging two branches fails.

exception rbtools.clients.errors.PushError[source]¶

Bases: Exception

An error for when pushing a branch to upstream fails.

exception rbtools.clients.errors.AmendError[source]¶

Bases: Exception

An error for when amending a commit fails.

exception rbtools.clients.errors.OptionsCheckError[source]¶

Bases: Exception

An error for when command line options are used incorrectly.

exception rbtools.clients.errors.InvalidRevisionSpecError[source]¶

Bases: Exception

An error for when the specified revisions are invalid.

exception rbtools.clients.errors.MinimumVersionError[source]¶

Bases: Exception

An error for when software doesn’t meet version requirements.

exception rbtools.clients.errors.TooManyRevisionsError[source]¶

Bases: InvalidRevisionSpecError

An error for when too many revisions were specified.

__init__()[source]¶

Initialize the error.

exception rbtools.clients.errors.EmptyChangeError[source]¶

Bases: Exception

An error for when there are no changed files.

__init__()[source]¶

Initialize the error.

exception rbtools.clients.errors.SCMClientDependencyError(missing_exes: MissingList = [], missing_modules: MissingList = [])[source]¶

Bases: SCMError

One or more required dependencies are missing.

New in version 4.0.

missing_exes¶

A list of missing executable dependencies.

Each item can be a string representing the name of the tool, or a tuple of possible interchangeable names.

Type:

list

missing_modules¶

A list of missing Python module dependencies.

Each item can be a string representing the name of the module, or a tuple of possible interchangeable module names.

Type:

list

MissingOneOfDep¶

A type alias for a tuple of missing interchangeable dependencies.

Any item in the list would have satisfied the dependency check.

The tuple is presented in search order.

alias of Tuple[str, …]

MissingItem¶

A type alias for a missing dependency.

This can be a string naming the dependency, or a tuple of interchangeable dependencies.

alias of Union[str, Tuple[str, …]]

MissingList¶

A type alias for a list of missing dependencies.

alias of List[Union[str, Tuple[str, …]]]

__init__(missing_exes: MissingList = [], missing_modules: MissingList = []) → None[source]¶

Initialize the error.

Parameters:

• missing_exes (list, optional) –

  A list of missing executable dependencies.

  Each item can be a string representing the name of the tool, or a tuple of possible interchangeable names.

• missing_modules (list, optional) –

  A list of missing Python module dependencies.

  Each item can be a string representing the name of the module, or a tuple of possible interchangeable module names.

exception rbtools.clients.errors.SCMClientNotFoundError(scmclient_id: str)[source]¶

Bases: Exception

An error indicating a specified SCMClient could not be found.

New in version 4.0.

scmclient_id¶

The ID of the SCMClient that could not be found.

Type:

str

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

Initialize the error.

Parameters:

scmclient_id (str) – The ID of the SCMClient that could not be found.