Errors

Errors/Exceptions defined and used in OpenSCM.

exception openscm.errors.AdapterNeedsModuleError

Bases: Exception

Exception raised when an adapter needs a module that is not installed.

__init__()

Initialize self. See help(type(self)) for accurate signature.

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception openscm.errors.InsufficientDataError

Bases: ValueError

Exception raised when not enough data is available to convert from one timeseries to another (e.g. when the target timeseries is outside the range of the source timeseries) or when data is too short (fewer than 3 data points).

__init__()

Initialize self. See help(type(self)) for accurate signature.

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception openscm.errors.ParameterAggregationError

Bases: openscm.errors.ParameterError

Exception raised when a parameter is read from but has child parameters which cannot be aggregated (boolean or string parameters).

__init__()

Initialize self. See help(type(self)) for accurate signature.

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception openscm.errors.ParameterEmptyError

Bases: openscm.errors.ParameterError

Exception raised when trying to read when a parameter’s value hasn’t been set

__init__()

Initialize self. See help(type(self)) for accurate signature.

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception openscm.errors.ParameterError

Bases: Exception

Exception relating to a parameter. Used as super class.

__init__()

Initialize self. See help(type(self)) for accurate signature.

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception openscm.errors.ParameterReadError

Bases: openscm.errors.ParameterError

Exception raised when a parameter has been read from (raised, e.g., when attempting to create a child parameter).

__init__()

Initialize self. See help(type(self)) for accurate signature.

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception openscm.errors.ParameterReadonlyError

Bases: openscm.errors.ParameterError

Exception raised when a requested parameter is read-only.

This can happen, for instance, if a parameter’s parent parameter in the parameter hierarchy has already been requested as writable.

__init__()

Initialize self. See help(type(self)) for accurate signature.

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception openscm.errors.ParameterTypeError

Bases: openscm.errors.ParameterError

Exception raised when a parameter is of a different type than requested.

__init__()

Initialize self. See help(type(self)) for accurate signature.

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception openscm.errors.ParameterWrittenError

Bases: openscm.errors.ParameterError

Exception raised when a parameter has been written to (raised, e.g., when attempting to create a child parameter).

__init__()

Initialize self. See help(type(self)) for accurate signature.

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception openscm.errors.RegionAggregatedError

Bases: Exception

Exception raised when a region has already been read from in a region-aggregated way.

__init__()

Initialize self. See help(type(self)) for accurate signature.

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception openscm.errors.TimeseriesPointsValuesMismatchError

Bases: IndexError

Exception raised when the length of the values and of the time points of a timeseries mismatch (depending on the type of timeseries these must equal or deviate by one).

__init__()

Initialize self. See help(type(self)) for accurate signature.

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.