rbtools.clients.errors¶

Error definitions for SCMClient implementations.

Exceptions

`AmendError`	An error for when amending a commit fails.
`AuthenticationError`	An error for when authentication fails.
`CreateCommitError`	The creation of a commit has failed or was aborted.
`EmptyChangeError`()	An error for when there are no changed files.
`InvalidRevisionSpecError`	An error for when the specified revisions are invalid.
`MergeError`	An error for when merging two branches fails.
`MinimumVersionError`	An error for when software doesn't meet version requirements.
`OptionsCheckError`	An error for when command line options are used incorrectly.
`PushError`	An error for when pushing a branch to upstream fails.
`SCMClientDependencyError`([missing_exes, ...])	One or more required dependencies are missing.
`SCMClientNotFoundError`(scmclient_id)	An error indicating a specified SCMClient could not be found.
`SCMError`	A generic error from an SCM.
`TooManyRevisionsError`()	An error for when too many revisions were specified.

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

Bases: Exception

An error for when amending a commit fails.

__firstlineno__ = 32¶

__static_attributes__ = ()¶

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

Bases: Exception

An error for when authentication fails.

__firstlineno__ = 16¶

__static_attributes__ = ()¶

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

Bases: Exception

The creation of a commit has failed or was aborted.

__firstlineno__ = 20¶

__static_attributes__ = ()¶

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

Bases: Exception

An error for when there are no changed files.

__annotations_cache__ = {}¶

__firstlineno__ = 57¶

__init__()[source]¶: Initialize the error.

__static_attributes__ = ()¶

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

Bases: Exception

An error for when the specified revisions are invalid.

__firstlineno__ = 40¶

__static_attributes__ = ()¶

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

Bases: Exception

An error for when merging two branches fails.

__firstlineno__ = 24¶

__static_attributes__ = ()¶

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

Bases: Exception

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

__firstlineno__ = 44¶

__static_attributes__ = ()¶

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

Bases: Exception

An error for when command line options are used incorrectly.

__firstlineno__ = 36¶

__static_attributes__ = ()¶

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

Bases: Exception

An error for when pushing a branch to upstream fails.

__firstlineno__ = 28¶

__static_attributes__ = ()¶

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

Bases: SCMError

One or more required dependencies are missing.

Added 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

MissingItem: TypeAlias = str | tuple[str, ...]¶

A type alias for a missing dependency.

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

MissingList¶

A type alias for a list of missing dependencies.

alias of Sequence[str | tuple[str, …]]

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, …]

__firstlineno__ = 66¶

__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.

__static_attributes__ = ('missing_exes', 'missing_modules')¶

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

Bases: Exception

An error indicating a specified SCMClient could not be found.

Added in version 4.0.

scmclient_id¶

The ID of the SCMClient that could not be found.

Type:: str

__annotations_cache__ = {}¶

__firstlineno__ = 182¶

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

Initialize the error.

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

__static_attributes__ = ('scmclient_id',)¶

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

Bases: Exception

A generic error from an SCM.

__annotations_cache__ = {}¶

__firstlineno__ = 12¶

__static_attributes__ = ()¶

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

Bases: InvalidRevisionSpecError

An error for when too many revisions were specified.

__annotations_cache__ = {}¶

__firstlineno__ = 48¶

__init__()[source]¶: Initialize the error.

__static_attributes__ = ()¶