Version: 1.2.0

ramrod.errors Module

exception ramrod.errors.UnknownVersionError

Bases: exceptions.Exception

Raised when an input document does not contain a version attribute and the user has not specified a document version.

exception ramrod.errors.UpdateError(message=None, disallowed=None, duplicates=None)

Bases: exceptions.Exception

Raised when non-translatable fields are encountered during the update process..

message

The error message.

disallowed

A list of nodes found in the input document that cannot be translated during the update process.

duplicates

A dictionary of nodes found in the input document that contain the same id attribute value.

exception ramrod.errors.InvalidVersionError(message=None, node=None, expected=None, found=None)

Bases: exceptions.Exception

Raised when an input document’s version attribute does not align with the expected version number for a given _BaseUpdater implementation.

message

The error message.

node

The node containing an incompatible version number.

expected

The version that was expected.

found

The version that was found on the node.