Project

General

Profile

1
# Exception handling
2

    
3
import copy
4
import atexit
5
import sys
6
import traceback
7

    
8
import format
9
import strings
10
import term
11
import util
12

    
13
def raise_(e): raise e
14

    
15
def sys_traceback():
16
    '''Note that Python tracebacks seems to have a bug that truncates them to
17
    only a few stack frames. See <http://bugs.python.org/issue7378>.'''
18
    return sys.exc_info()[2]
19
        # can't just return pointer to traceback because it will change :-(
20

    
21
def has_tracebacks(e): return hasattr(e, 'tracebacks')
22

    
23
def add_traceback(e):
24
    '''Adds current traceback to an exception if it doesn't already have one'''
25
    traceback_ = sys_traceback() # get first in case later code throws exception
26
    if not has_tracebacks(e): e.tracebacks = []
27
    if util.list_get(e.tracebacks, 0) == traceback_: return
28
    e.tracebacks.insert(0, traceback_) # tracebacks have most recent call last
29

    
30
def get_traceback_str(traceback_):
31
    return ''.join(traceback.format_exception(None, None, traceback_)[:-1])
32
        # remove final "None" line ("exception name")
33

    
34
def get_e_tracebacks_str(e):
35
    try: tracebacks = e.tracebacks
36
    except AttributeError: return ''
37
    return ''.join(get_traceback_str(t) for t in tracebacks)
38

    
39
def add_msg(e, msg): e.args = (strings.ensure_newl(strings.ustr(e))+msg,)
40

    
41
def repl_msg(e, **repls): e.args = (strings.ustr(e) % repls,)
42

    
43
def e_ct_exit_status(e_ct): return min(e_ct, 255)
44

    
45
class ExceptionWithCause(Exception):
46
    def __init__(self, msg, cause=None, cause_newline=False):
47
        add_traceback(self)
48
        if cause != None:
49
            if cause_newline: msg += '\ncause'
50
            msg += ': '+str_(cause)
51
        Exception.__init__(self, msg)
52

    
53
def str_(e):
54
    return u''.join(traceback.format_exception_only(type(e), e)).rstrip()
55

    
56
def print_ex(e, emph=True, detail=True, plain=False):
57
    if plain:
58
        emph = False
59
        detail = False
60
    
61
    msg = str_(e)+'\n'
62
    if detail: msg += get_e_tracebacks_str(e)
63
    if emph:
64
        first_line, nl, rest = msg.partition('\n')
65
        msg = term.error(first_line)+nl+rest
66
    sys.stderr.write(msg)
67

    
68
class ExTracker:
69
    def __init__(self):
70
        self.e_ct = 0
71
    
72
    def msg(self): return 'Encountered '+str(self.e_ct)+' error(s)'
73
    
74
    def track(self, e, **format):
75
        self.e_ct += 1
76
        print_ex(e, **format)
77
    
78
    def exit(self):
79
        if self.e_ct > 0: raise SystemExit(e_ct_exit_status(self.e_ct))
80

    
81
class ExPercentTracker(ExTracker):
82
    def __init__(self, iter_text='iteration'):
83
        ExTracker.__init__(self)
84
        self.iter_text = iter_text
85
        self.iter_ct = None
86
        self.err_iter_ct = None
87
        self.last_iter_num = None
88
    
89
    def add_iters(self, iter_ct):
90
        if self.iter_ct == None: self.iter_ct = 0
91
        self.iter_ct += iter_ct
92
    
93
    def track(self, e, iter_num=None, **format):
94
        if iter_num != None:
95
            if iter_num != self.last_iter_num: # a new iter produced an error
96
                if self.err_iter_ct == None: self.err_iter_ct = 0
97
                self.err_iter_ct += 1
98
                self.last_iter_num = iter_num
99
        ExTracker.track(self, e, **format)
100
    
101
    def msg(self):
102
        msg = ExTracker.msg(self)
103
        iter_text_plural = self.iter_text+'(s)'
104
        numerator = self.e_ct
105
        if self.err_iter_ct != None:
106
            msg += ' in '+format.int2str(self.err_iter_ct)
107
            numerator = self.err_iter_ct
108
        if self.iter_ct != None and self.iter_ct > 0:
109
            msg += ('/'+format.int2str(self.iter_ct)+' '+iter_text_plural+' = '
110
            +format.to_percent(float(numerator)/self.iter_ct))
111
        return msg
(12-12/34)