Class UserException

wal_e/exception.py:6–45

Superclass intended for user-visible errors Instead of stacktraces, these will be prettyprinted. The suggested error message guidelines are the same as for the PostgreSQL project: http://developer.postgresql.org/pgdocs/postgres/error-style-guide.html If it is necessary t

class UserException(Exception):
    """
    Superclass intended for user-visible errors

    Instead of stacktraces, these will be prettyprinted.  The
    suggested error message guidelines are the same as for the
    PostgreSQL project:

    http://developer.postgresql.org/pgdocs/postgres/error-style-guide.html

    If it is necessary to trap these exceptions, use a subclass.

    >>> raise UserException(msg='foo', detail='bar')
    Traceback (most recent call last):
        ...
    UserException: ERROR: MSG: foo
    DETAIL: bar
    STRUCTURED: time=... pid=...
    >>> raise UserException(msg='foo', detail='bar', hint='hello')
    Traceback (most recent call last):
        ...
    UserException: ERROR: MSG: foo
    DETAIL: bar
    HINT: hello
    STRUCTURED: time=... pid=...
    """

    def __init__(self, msg=None, detail=None, hint=None):
        # msg uses a keyword argument with a default to make the
        # multiprocessing module happy, as it seems to set them after
        # the fact.  Realistically, one should *always* be setting msg
        # when used in normal code though.
        self.msg = msg
        self.detail = detail
        self.hint = hint
        self.severity = ERROR

    def __str__(self):
        return "{0}: {1}".format(getLevelName(self.severity),
                WalELogger.fmt_logline(self.msg, self.detail, self.hint))


class UserCritical(UserException):