sequence.errors module#

Errors used by sequence.

exception sequence.errors.InvalidRowError(row: int, n_rows: int)[source]#

Bases: OutputValidationError

Raise this exception if a required variable is missing from an output file.

__str__() str[source]#

Return error message that includes the requested row.

exception sequence.errors.MissingRequiredVariable(name: str)[source]#

Bases: OutputValidationError

Raise this exception if a required variable is missing from an output file.

__str__() str[source]#

Return error message that includes the name of the missing variable.

exception sequence.errors.OutputValidationError[source]#

Bases: SequenceError

Raise this exception if there is something wrong with an output file.

exception sequence.errors.ParameterMismatchError(keys: Iterable[str])[source]#

Bases: SequenceError

Raise this exception if values from two configurations are mismatched.

__str__() str[source]#

Return an error message with the offending keys.

exception sequence.errors.SequenceError[source]#

Bases: Exception

All sequence errors should inherit from this class.

exception sequence.errors.ShelfEdgeError(msg: str)[source]#

Bases: SequenceError

Raise this exception is there was an errors locating the shelf edge.

__str__() str[source]#

Return an error message in human-readable form.

exception sequence.errors.ShorelineError(msg: str)[source]#

Bases: SequenceError

Raise this exception if there was an error locating the shoreline.

__str__() str[source]#

Return an error message in human-readable form.