exceptions.py 3.53 KB
Newer Older
1
# coding=utf-8
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
# Copyright (c) 2015 Intel Corporation

# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:

# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

"""Exception and error classes for piglit, and exception handlers."""

from __future__ import print_function, absolute_import, division
import sys
import functools

28
from framework import compat
29

30 31 32 33
__all__ = [
    'PiglitInternalError',
    'PiglitFatalError',
    'PiglitException',
34
    'PiglitAbort',
35 36 37 38
    'handler',
]


39

40 41 42 43 44 45 46 47 48 49 50 51 52 53
def handler(func):
    """Decorator function for handling errors in an entry point.

    This will handle expected errors (PiglitFatalError), and unexpected errors,
    either PiglitInternalErrors or PiglitExceptions, as well as handling
    generic Exceptions

    """

    @functools.wraps(func)
    def _inner(*args, **kwargs):
        try:
            func(*args, **kwargs)
        except PiglitFatalError as e:
54
            print('Fatal Error: {}'.format(str(e)), file=sys.stderr)
55
            sys.exit(1)
56 57 58 59
        except PiglitAbort as e:
            print('Aborting Piglit execution: {}'.format(str(e)),
                  file=sys.stderr)
            sys.exit(3)
60 61 62
        except PiglitUserError as e:
            print('User error: {}'.format(str(e)), file=sys.stderr)
            sys.exit(1)
63 64 65 66

    return _inner


67
@compat.python_2_unicode_compatible
68 69 70 71 72 73 74
class PiglitException(Exception):
    """Class for non-error exceptions.

    These should *always* be caught. If this class (or any subclass) is
    uncaught that is a bug in piglit.

    """
75
    def __str__(self):
76
        return (u'An internal exception that should have been handled was not:'
77
                '\n{}'.format(super(PiglitException, self).__str__()))
78 79


80
@compat.python_2_unicode_compatible
81 82 83 84 85 86
class PiglitInternalError(Exception):
    """Class for errors in piglit.

    These should always be handled.

    """
87
    def __str__(self):
88
        return u'An internal error occurred:\n{}'.format(
89
            super(PiglitInternalError, self).__str__())
90 91 92 93 94 95 96 97 98


class PiglitFatalError(Exception):
    """Class for errors in piglit that cannot be recovered from.

    When this class (or a subclass) is raised it should be raised all the way
    to the top of the program where it exits.

    """
99 100


101 102 103 104 105 106 107 108
class PiglitUserError(Exception):
    """Class for user configuration errors.

    When this class (or a subclass) is raised it should be raised all the way
    to the top of the program where it exits.
    """


109 110 111 112 113 114 115
class PiglitAbort(Exception):
    """Class for non-errors that require piglit aborting.

    When this class (or a subclass) is raised it should be raised all the way
    to the top of the program where it exits.

    """