snowmobile.core.errors

snowmobile exception classes.

Module Contents

exception snowmobile.core.errors.Error(msg: Optional[str] = None, errno: Optional[int] = None, nm: Optional[str] = None, to_raise: Optional[bool] = False)

Bases: Exception

Base Generic exception class.

Parameters

• msg (Optional[str]) – Error message.

• errno (Optional[int]) – Error number.

• nm (Optional[str]) – Globally unique name for an exception being raised; used for InternalExceptions and statement names when QA failures occur.

• to_raise (Optional[bool]) – Indicates that the exception should be raised before exiting the current context.

tmstmp

Unix instantiation timestamp of the exception (in seconds).

Type

int

raised

Indicator of whether or not the instance has already been raised; used for exception chaining from Statement -> Script.

Type

bool

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

escalate(self)

Raises error.

static format_error_args(prefix: Optional[str] = None, sep: Optional[str] = None, lines: Optional[int] = None, _filter: bool = True, **kwargs: Dict[str, str]) → str

Formats a dictionary of arguments into an aligned/indented error msg.

Placed below primary msg such that a primary msg of ‘This is a __ error.’ combined with the returned value from this method provided with kwargs={‘argument-description1’: ‘argument-value’, ‘arg2-desc’: ‘arg2-value’} would produce the following error message:

``` This is a ClassName error.

argument-description: argument-value

arg2-desc: arg2-value

```

Parameters

• prefix (str) – Character to prefix bullets with; defaults to ‘ ‘.

• sep (str) – Character to separate arguments/values with; defaults to ‘:’.

• lines (int) – Number of lines to include between arguments; defaults to 1.

• _filter (bool) – Indicator of whether to filter out key/value pairs that contain empty values; defaults to True.

• **kwargs – Argument keys and values to be converted into a list.

Returns (str):

Formatted arguments as a string.

exception snowmobile.core.errors.InternalError(msg: Optional[str] = None, errno: Optional[int] = None, nm: Optional[str] = None, to_raise: Optional[bool] = False)

Bases: snowmobile.core.errors.Error

Exceptions raised from an internal state that should not exist.

Debugging/testing Exceptions only.

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

exception snowmobile.core.errors.StatementInternalError(msg: Optional[str] = None, errno: Optional[int] = None, nm: Optional[str] = None, to_raise: Optional[bool] = False)

Bases: snowmobile.core.errors.InternalError

Statement-specific internal errors.

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

exception snowmobile.core.errors.StatementPostProcessingError(msg: Optional[str] = None, errno: Optional[int] = None, to_raise: Optional[bool] = False)

Bases: snowmobile.core.errors.Error

Exceptions encountered in post-processing invoked by s.process().

Indicates a non-database error occurred in .process() method of a derived Statement class.

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

exception snowmobile.core.errors.QAFailure(nm: str, msg: str, idx: int, desc: Optional[str] = None, errno: Optional[int] = None, to_raise: Optional[bool] = False)

Bases: snowmobile.core.errors.Error

Boolean eval of a statement’s outcome attribute is False.

Indicates the logic invoked by the .process() method completed successfully and has set the outcome attribute to False.

Parameters

• nm (str) – Name name of QA statement.

• desc (str) – Object-specific exception message to display.

• idx (int) – Index of the statement that failed its QA check.

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

exception snowmobile.core.errors.QAEmptyFailure(nm: str, msg: str, idx: int, desc: Optional[str] = None, errno: Optional[int] = None, to_raise: Optional[bool] = False)

Bases: snowmobile.core.errors.QAFailure

Empty specific failure.

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

exception snowmobile.core.errors.QADiffFailure(nm: str, msg: str, idx: int, desc: Optional[str] = None, errno: Optional[int] = None, to_raise: Optional[bool] = False)

Bases: snowmobile.core.errors.QAFailure

Diff specific failure.

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

exception snowmobile.core.errors.SnowFrameInternalError(msg: Optional[str] = None, errno: Optional[int] = None, nm: Optional[str] = None, to_raise: Optional[bool] = False)

Bases: snowmobile.core.errors.InternalError

class:~snowmobile.core.snowframe.SnowFrame specific internal error.

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

exception snowmobile.core.errors.StatementNotFoundError(nm: str, statements: List[str] = None, msg: Optional[str] = None, errno: Optional[int] = None, to_raise: Optional[bool] = False)

Bases: snowmobile.core.errors.Error

Invalid statement name or index has been pr.

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

exception snowmobile.core.errors.DuplicateTagError(nm: str, msg: Optional[str] = None, errno: Optional[int] = None, to_raise: Optional[bool] = False)

Bases: snowmobile.core.errors.Error

Duplicate statement name specified within a script.

Is only raised if a duplicate statement name exists and a method is invoked that tries to access statement(s) by their name as opposed to index position.

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

exception snowmobile.core.errors.LoadingInternalError(msg: Optional[str] = None, errno: Optional[int] = None, nm: Optional[str] = None, to_raise: Optional[bool] = False)

Bases: snowmobile.core.errors.InternalError

Exception boundaries for Table.

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

exception snowmobile.core.errors.ExistingTableError(msg: Optional[str] = None, errno: Optional[int] = None, nm: Optional[str] = None, to_raise: Optional[bool] = False)

Bases: snowmobile.core.errors.Error

Table exists and if_exists=Fail

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

exception snowmobile.core.errors.ColumnMismatchError(msg: Optional[str] = None, errno: Optional[int] = None, nm: Optional[str] = None, to_raise: Optional[bool] = False)

Bases: snowmobile.core.errors.Error

Columns do not match and if_exists!=’replace’

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

exception snowmobile.core.errors.FileFormatNameError(nm: str, statements: List[str] = None, msg: Optional[str] = None, errno: Optional[int] = None, to_raise: Optional[bool] = False)

Bases: snowmobile.core.errors.StatementNotFoundError

The name of the provided file format is invalid.

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

exception snowmobile.core.errors.InvalidTagsError(msg: Optional[str] = None, errno: Optional[int] = None, nm: Optional[str] = None, to_raise: Optional[bool] = False)

Bases: snowmobile.core.errors.Error

Error to be raised when a given statement wrap is not valid.

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

exception snowmobile.core.errors.SnowflakeObjectNotFound(msg: Optional[str] = None, errno: Optional[int] = None, nm: Optional[str] = None, to_raise: Optional[bool] = False)

Bases: snowmobile.core.errors.Error

Error to be raised when a schema object is not found by snowmobile.core.sql.

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

snowmobile.core.errors.db_errors

snowmobile.core.errors.snowmobile_errors