exceptions

Custom exceptions for BumpVersion.

Classes¶

BadInputError(message: str, ctx: Optional[Context] = None)

User input was bad.

BumpVersionError(
    message: str, ctx: Optional[Context] = None
)

Bases: UsageError

Custom base class for all BumpVersion exception types.

ConfigurationError(
    message: str, ctx: Optional[Context] = None
)

A configuration key-value is missing or in the wrong type.

DirtyWorkingDirectoryError(
    message: str, ctx: Optional[Context] = None
)

The working directory is dirty, and it is not allowed.

FormattingError(
    message: str, ctx: Optional[Context] = None
)

We are unable to represent a version required by a format.

HookError(message: str, ctx: Optional[Context] = None)

A hook failed.

InvalidVersionPartError(
    message: str, ctx: Optional[Context] = None
)

The specified part (e.g. ‘bugfix’) was not found.

MissingValueError(
    message: str, ctx: Optional[Context] = None
)

A part required for a version format is empty.

SignedTagsError(
    message: str, ctx: Optional[Context] = None
)

The VCS does not support signed tags.

VersionNotFoundError(
    message: str, ctx: Optional[Context] = None
)

A version number was not found in a source file.