Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 1 | """Extract, format and print information about Python stack traces.""" |
Guido van Rossum | 526beed | 1994-07-01 15:36:46 +0000 | [diff] [blame] | 2 | |
| 3 | import linecache |
Guido van Rossum | 526beed | 1994-07-01 15:36:46 +0000 | [diff] [blame] | 4 | import sys |
Guido van Rossum | c7acf2a | 1995-02-27 13:15:45 +0000 | [diff] [blame] | 5 | import types |
Guido van Rossum | 526beed | 1994-07-01 15:36:46 +0000 | [diff] [blame] | 6 | |
Skip Montanaro | 40fc160 | 2001-03-01 04:27:19 +0000 | [diff] [blame] | 7 | __all__ = ['extract_stack', 'extract_tb', 'format_exception', |
| 8 | 'format_exception_only', 'format_list', 'format_stack', |
Neil Schemenauer | f607fc5 | 2003-11-05 23:03:00 +0000 | [diff] [blame] | 9 | 'format_tb', 'print_exc', 'format_exc', 'print_exception', |
| 10 | 'print_last', 'print_stack', 'print_tb', 'tb_lineno'] |
Skip Montanaro | 40fc160 | 2001-03-01 04:27:19 +0000 | [diff] [blame] | 11 | |
Guido van Rossum | 194e20a | 1995-09-20 20:31:51 +0000 | [diff] [blame] | 12 | def _print(file, str='', terminator='\n'): |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 13 | file.write(str+terminator) |
Guido van Rossum | dcc057a | 1996-08-12 23:18:13 +0000 | [diff] [blame] | 14 | |
| 15 | |
| 16 | def print_list(extracted_list, file=None): |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 17 | """Print the list of tuples as returned by extract_tb() or |
| 18 | extract_stack() as a formatted stack trace to the given file.""" |
Raymond Hettinger | 10ff706 | 2002-06-02 03:04:52 +0000 | [diff] [blame] | 19 | if file is None: |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 20 | file = sys.stderr |
| 21 | for filename, lineno, name, line in extracted_list: |
| 22 | _print(file, |
| 23 | ' File "%s", line %d, in %s' % (filename,lineno,name)) |
| 24 | if line: |
Eric S. Raymond | ec3bbde | 2001-02-09 09:39:08 +0000 | [diff] [blame] | 25 | _print(file, ' %s' % line.strip()) |
Guido van Rossum | dcc057a | 1996-08-12 23:18:13 +0000 | [diff] [blame] | 26 | |
| 27 | def format_list(extracted_list): |
Jeremy Hylton | 69e9e8b | 2001-03-21 19:09:31 +0000 | [diff] [blame] | 28 | """Format a list of traceback entry tuples for printing. |
| 29 | |
| 30 | Given a list of tuples as returned by extract_tb() or |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 31 | extract_stack(), return a list of strings ready for printing. |
Jeremy Hylton | 69e9e8b | 2001-03-21 19:09:31 +0000 | [diff] [blame] | 32 | Each string in the resulting list corresponds to the item with the |
| 33 | same index in the argument list. Each string ends in a newline; |
| 34 | the strings may contain internal newlines as well, for those items |
| 35 | whose source text line is not None. |
| 36 | """ |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 37 | list = [] |
| 38 | for filename, lineno, name, line in extracted_list: |
| 39 | item = ' File "%s", line %d, in %s\n' % (filename,lineno,name) |
| 40 | if line: |
Eric S. Raymond | ec3bbde | 2001-02-09 09:39:08 +0000 | [diff] [blame] | 41 | item = item + ' %s\n' % line.strip() |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 42 | list.append(item) |
| 43 | return list |
| 44 | |
Guido van Rossum | 194e20a | 1995-09-20 20:31:51 +0000 | [diff] [blame] | 45 | |
| 46 | def print_tb(tb, limit=None, file=None): |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 47 | """Print up to 'limit' stack trace entries from the traceback 'tb'. |
Jeremy Hylton | 69e9e8b | 2001-03-21 19:09:31 +0000 | [diff] [blame] | 48 | |
| 49 | If 'limit' is omitted or None, all entries are printed. If 'file' |
| 50 | is omitted or None, the output goes to sys.stderr; otherwise |
| 51 | 'file' should be an open file or file-like object with a write() |
| 52 | method. |
| 53 | """ |
Raymond Hettinger | 10ff706 | 2002-06-02 03:04:52 +0000 | [diff] [blame] | 54 | if file is None: |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 55 | file = sys.stderr |
| 56 | if limit is None: |
| 57 | if hasattr(sys, 'tracebacklimit'): |
| 58 | limit = sys.tracebacklimit |
| 59 | n = 0 |
| 60 | while tb is not None and (limit is None or n < limit): |
| 61 | f = tb.tb_frame |
Michael W. Hudson | dd32a91 | 2002-08-15 14:59:02 +0000 | [diff] [blame] | 62 | lineno = tb.tb_lineno |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 63 | co = f.f_code |
| 64 | filename = co.co_filename |
| 65 | name = co.co_name |
| 66 | _print(file, |
| 67 | ' File "%s", line %d, in %s' % (filename,lineno,name)) |
Hye-Shik Chang | 182ac85 | 2004-10-26 09:16:42 +0000 | [diff] [blame] | 68 | linecache.checkcache(filename) |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 69 | line = linecache.getline(filename, lineno, f.f_globals) |
Eric S. Raymond | ec3bbde | 2001-02-09 09:39:08 +0000 | [diff] [blame] | 70 | if line: _print(file, ' ' + line.strip()) |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 71 | tb = tb.tb_next |
| 72 | n = n+1 |
Guido van Rossum | 526beed | 1994-07-01 15:36:46 +0000 | [diff] [blame] | 73 | |
Guido van Rossum | 28e99fe | 1995-08-04 04:30:30 +0000 | [diff] [blame] | 74 | def format_tb(tb, limit = None): |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 75 | """A shorthand for 'format_list(extract_stack(f, limit)).""" |
| 76 | return format_list(extract_tb(tb, limit)) |
Guido van Rossum | 28e99fe | 1995-08-04 04:30:30 +0000 | [diff] [blame] | 77 | |
Guido van Rossum | 526beed | 1994-07-01 15:36:46 +0000 | [diff] [blame] | 78 | def extract_tb(tb, limit = None): |
Jeremy Hylton | 69e9e8b | 2001-03-21 19:09:31 +0000 | [diff] [blame] | 79 | """Return list of up to limit pre-processed entries from traceback. |
| 80 | |
| 81 | This is useful for alternate formatting of stack traces. If |
| 82 | 'limit' is omitted or None, all entries are extracted. A |
| 83 | pre-processed stack trace entry is a quadruple (filename, line |
| 84 | number, function name, text) representing the information that is |
| 85 | usually printed for a stack trace. The text is a string with |
| 86 | leading and trailing whitespace stripped; if the source is not |
| 87 | available it is None. |
| 88 | """ |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 89 | if limit is None: |
| 90 | if hasattr(sys, 'tracebacklimit'): |
| 91 | limit = sys.tracebacklimit |
| 92 | list = [] |
| 93 | n = 0 |
| 94 | while tb is not None and (limit is None or n < limit): |
| 95 | f = tb.tb_frame |
Michael W. Hudson | dd32a91 | 2002-08-15 14:59:02 +0000 | [diff] [blame] | 96 | lineno = tb.tb_lineno |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 97 | co = f.f_code |
| 98 | filename = co.co_filename |
| 99 | name = co.co_name |
Hye-Shik Chang | 182ac85 | 2004-10-26 09:16:42 +0000 | [diff] [blame] | 100 | linecache.checkcache(filename) |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 101 | line = linecache.getline(filename, lineno, f.f_globals) |
Eric S. Raymond | ec3bbde | 2001-02-09 09:39:08 +0000 | [diff] [blame] | 102 | if line: line = line.strip() |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 103 | else: line = None |
| 104 | list.append((filename, lineno, name, line)) |
| 105 | tb = tb.tb_next |
| 106 | n = n+1 |
| 107 | return list |
Guido van Rossum | 526beed | 1994-07-01 15:36:46 +0000 | [diff] [blame] | 108 | |
Guido van Rossum | 28e99fe | 1995-08-04 04:30:30 +0000 | [diff] [blame] | 109 | |
Guido van Rossum | 194e20a | 1995-09-20 20:31:51 +0000 | [diff] [blame] | 110 | def print_exception(etype, value, tb, limit=None, file=None): |
Jeremy Hylton | 69e9e8b | 2001-03-21 19:09:31 +0000 | [diff] [blame] | 111 | """Print exception up to 'limit' stack trace entries from 'tb' to 'file'. |
| 112 | |
| 113 | This differs from print_tb() in the following ways: (1) if |
| 114 | traceback is not None, it prints a header "Traceback (most recent |
| 115 | call last):"; (2) it prints the exception type and value after the |
| 116 | stack trace; (3) if type is SyntaxError and value has the |
| 117 | appropriate format, it prints the line where the syntax error |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 118 | occurred with a caret on the next line indicating the approximate |
Jeremy Hylton | 69e9e8b | 2001-03-21 19:09:31 +0000 | [diff] [blame] | 119 | position of the error. |
| 120 | """ |
Raymond Hettinger | 10ff706 | 2002-06-02 03:04:52 +0000 | [diff] [blame] | 121 | if file is None: |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 122 | file = sys.stderr |
| 123 | if tb: |
| 124 | _print(file, 'Traceback (most recent call last):') |
| 125 | print_tb(tb, limit, file) |
| 126 | lines = format_exception_only(etype, value) |
| 127 | for line in lines[:-1]: |
| 128 | _print(file, line, ' ') |
| 129 | _print(file, lines[-1], '') |
Guido van Rossum | 28e99fe | 1995-08-04 04:30:30 +0000 | [diff] [blame] | 130 | |
| 131 | def format_exception(etype, value, tb, limit = None): |
Jeremy Hylton | 69e9e8b | 2001-03-21 19:09:31 +0000 | [diff] [blame] | 132 | """Format a stack trace and the exception information. |
| 133 | |
| 134 | The arguments have the same meaning as the corresponding arguments |
| 135 | to print_exception(). The return value is a list of strings, each |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 136 | ending in a newline and some containing internal newlines. When |
| 137 | these lines are concatenated and printed, exactly the same text is |
Jeremy Hylton | 69e9e8b | 2001-03-21 19:09:31 +0000 | [diff] [blame] | 138 | printed as does print_exception(). |
| 139 | """ |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 140 | if tb: |
| 141 | list = ['Traceback (most recent call last):\n'] |
| 142 | list = list + format_tb(tb, limit) |
| 143 | else: |
| 144 | list = [] |
| 145 | list = list + format_exception_only(etype, value) |
| 146 | return list |
Guido van Rossum | 28e99fe | 1995-08-04 04:30:30 +0000 | [diff] [blame] | 147 | |
| 148 | def format_exception_only(etype, value): |
Jeremy Hylton | 69e9e8b | 2001-03-21 19:09:31 +0000 | [diff] [blame] | 149 | """Format the exception part of a traceback. |
| 150 | |
| 151 | The arguments are the exception type and value such as given by |
| 152 | sys.last_type and sys.last_value. The return value is a list of |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 153 | strings, each ending in a newline. |
| 154 | |
| 155 | Normally, the list contains a single string; however, for |
| 156 | SyntaxError exceptions, it contains several lines that (when |
| 157 | printed) display detailed information about where the syntax |
| 158 | error occurred. |
| 159 | |
| 160 | The message indicating which exception occurred is always the last |
| 161 | string in the list. |
| 162 | |
Jeremy Hylton | 69e9e8b | 2001-03-21 19:09:31 +0000 | [diff] [blame] | 163 | """ |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 164 | |
| 165 | stype = etype.__name__ |
Guido van Rossum | 6a2a2a0 | 2006-08-26 20:37:44 +0000 | [diff] [blame] | 166 | smod = etype.__module__ |
| 167 | if smod not in ("exceptions", "__main__", "__builtin__"): |
| 168 | stype = smod + '.' + stype |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 169 | |
| 170 | if not issubclass(etype, SyntaxError): |
| 171 | return [_format_final_exc_line(stype, value)] |
| 172 | |
| 173 | # It was a syntax error; show exactly where the problem was found. |
| 174 | lines = [] |
| 175 | try: |
| 176 | msg, (filename, lineno, offset, badline) = value |
| 177 | except Exception: |
| 178 | pass |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 179 | else: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 180 | filename = filename or "<string>" |
| 181 | lines.append(' File "%s", line %d\n' % (filename, lineno)) |
| 182 | if badline is not None: |
| 183 | lines.append(' %s\n' % badline.strip()) |
| 184 | if offset is not None: |
| 185 | caretspace = badline[:offset].lstrip() |
| 186 | # non-space whitespace (likes tabs) must be kept for alignment |
| 187 | caretspace = ((c.isspace() and c or ' ') for c in caretspace) |
| 188 | # only three spaces to account for offset1 == pos 0 |
| 189 | lines.append(' %s^\n' % ''.join(caretspace)) |
| 190 | value = msg |
| 191 | |
| 192 | lines.append(_format_final_exc_line(stype, value)) |
| 193 | return lines |
| 194 | |
| 195 | def _format_final_exc_line(etype, value): |
| 196 | """Return a list of a single line -- normal case for format_exception_only""" |
| 197 | valuestr = _some_str(value) |
| 198 | if value is None or not valuestr: |
| 199 | line = "%s\n" % etype |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 200 | else: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 201 | line = "%s: %s\n" % (etype, valuestr) |
| 202 | return line |
Guido van Rossum | 28e99fe | 1995-08-04 04:30:30 +0000 | [diff] [blame] | 203 | |
Guido van Rossum | 2823f03 | 2000-08-22 02:04:46 +0000 | [diff] [blame] | 204 | def _some_str(value): |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 205 | try: |
| 206 | return str(value) |
| 207 | except: |
| 208 | return '<unprintable %s object>' % type(value).__name__ |
Guido van Rossum | 2823f03 | 2000-08-22 02:04:46 +0000 | [diff] [blame] | 209 | |
Guido van Rossum | 526beed | 1994-07-01 15:36:46 +0000 | [diff] [blame] | 210 | |
Guido van Rossum | 194e20a | 1995-09-20 20:31:51 +0000 | [diff] [blame] | 211 | def print_exc(limit=None, file=None): |
Neal Norwitz | ac3625f | 2006-03-17 05:49:33 +0000 | [diff] [blame] | 212 | """Shorthand for 'print_exception(*sys.exc_info(), limit, file)'.""" |
Raymond Hettinger | 10ff706 | 2002-06-02 03:04:52 +0000 | [diff] [blame] | 213 | if file is None: |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 214 | file = sys.stderr |
| 215 | try: |
| 216 | etype, value, tb = sys.exc_info() |
| 217 | print_exception(etype, value, tb, limit, file) |
| 218 | finally: |
| 219 | etype = value = tb = None |
Guido van Rossum | 526beed | 1994-07-01 15:36:46 +0000 | [diff] [blame] | 220 | |
Neil Schemenauer | f607fc5 | 2003-11-05 23:03:00 +0000 | [diff] [blame] | 221 | |
| 222 | def format_exc(limit=None): |
| 223 | """Like print_exc() but return a string.""" |
| 224 | try: |
| 225 | etype, value, tb = sys.exc_info() |
| 226 | return ''.join(format_exception(etype, value, tb, limit)) |
| 227 | finally: |
| 228 | etype = value = tb = None |
Tim Peters | 58eb11c | 2004-01-18 20:29:55 +0000 | [diff] [blame] | 229 | |
Neil Schemenauer | f607fc5 | 2003-11-05 23:03:00 +0000 | [diff] [blame] | 230 | |
Guido van Rossum | 194e20a | 1995-09-20 20:31:51 +0000 | [diff] [blame] | 231 | def print_last(limit=None, file=None): |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 232 | """This is a shorthand for 'print_exception(sys.last_type, |
| 233 | sys.last_value, sys.last_traceback, limit, file)'.""" |
Raymond Hettinger | 10ff706 | 2002-06-02 03:04:52 +0000 | [diff] [blame] | 234 | if file is None: |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 235 | file = sys.stderr |
| 236 | print_exception(sys.last_type, sys.last_value, sys.last_traceback, |
| 237 | limit, file) |
Guido van Rossum | dcc057a | 1996-08-12 23:18:13 +0000 | [diff] [blame] | 238 | |
| 239 | |
| 240 | def print_stack(f=None, limit=None, file=None): |
Jeremy Hylton | 69e9e8b | 2001-03-21 19:09:31 +0000 | [diff] [blame] | 241 | """Print a stack trace from its invocation point. |
Tim Peters | a19a168 | 2001-03-29 04:36:09 +0000 | [diff] [blame] | 242 | |
Jeremy Hylton | 69e9e8b | 2001-03-21 19:09:31 +0000 | [diff] [blame] | 243 | The optional 'f' argument can be used to specify an alternate |
| 244 | stack frame at which to start. The optional 'limit' and 'file' |
| 245 | arguments have the same meaning as for print_exception(). |
| 246 | """ |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 247 | if f is None: |
| 248 | try: |
| 249 | raise ZeroDivisionError |
| 250 | except ZeroDivisionError: |
| 251 | f = sys.exc_info()[2].tb_frame.f_back |
| 252 | print_list(extract_stack(f, limit), file) |
Guido van Rossum | dcc057a | 1996-08-12 23:18:13 +0000 | [diff] [blame] | 253 | |
| 254 | def format_stack(f=None, limit=None): |
Jeremy Hylton | 69e9e8b | 2001-03-21 19:09:31 +0000 | [diff] [blame] | 255 | """Shorthand for 'format_list(extract_stack(f, limit))'.""" |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 256 | if f is None: |
| 257 | try: |
| 258 | raise ZeroDivisionError |
| 259 | except ZeroDivisionError: |
| 260 | f = sys.exc_info()[2].tb_frame.f_back |
| 261 | return format_list(extract_stack(f, limit)) |
Guido van Rossum | dcc057a | 1996-08-12 23:18:13 +0000 | [diff] [blame] | 262 | |
| 263 | def extract_stack(f=None, limit = None): |
Jeremy Hylton | 69e9e8b | 2001-03-21 19:09:31 +0000 | [diff] [blame] | 264 | """Extract the raw traceback from the current stack frame. |
| 265 | |
| 266 | The return value has the same format as for extract_tb(). The |
| 267 | optional 'f' and 'limit' arguments have the same meaning as for |
| 268 | print_stack(). Each item in the list is a quadruple (filename, |
| 269 | line number, function name, text), and the entries are in order |
| 270 | from oldest to newest stack frame. |
| 271 | """ |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 272 | if f is None: |
| 273 | try: |
| 274 | raise ZeroDivisionError |
| 275 | except ZeroDivisionError: |
| 276 | f = sys.exc_info()[2].tb_frame.f_back |
| 277 | if limit is None: |
| 278 | if hasattr(sys, 'tracebacklimit'): |
| 279 | limit = sys.tracebacklimit |
| 280 | list = [] |
| 281 | n = 0 |
| 282 | while f is not None and (limit is None or n < limit): |
Michael W. Hudson | dd32a91 | 2002-08-15 14:59:02 +0000 | [diff] [blame] | 283 | lineno = f.f_lineno |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 284 | co = f.f_code |
| 285 | filename = co.co_filename |
| 286 | name = co.co_name |
Hye-Shik Chang | 182ac85 | 2004-10-26 09:16:42 +0000 | [diff] [blame] | 287 | linecache.checkcache(filename) |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 288 | line = linecache.getline(filename, lineno, f.f_globals) |
Eric S. Raymond | ec3bbde | 2001-02-09 09:39:08 +0000 | [diff] [blame] | 289 | if line: line = line.strip() |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 290 | else: line = None |
| 291 | list.append((filename, lineno, name, line)) |
| 292 | f = f.f_back |
| 293 | n = n+1 |
| 294 | list.reverse() |
| 295 | return list |
Guido van Rossum | 4752966 | 1997-09-26 22:43:02 +0000 | [diff] [blame] | 296 | |
Guido van Rossum | 4752966 | 1997-09-26 22:43:02 +0000 | [diff] [blame] | 297 | def tb_lineno(tb): |
Jeremy Hylton | 69e9e8b | 2001-03-21 19:09:31 +0000 | [diff] [blame] | 298 | """Calculate correct line number of traceback given in tb. |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 299 | |
Michael W. Hudson | dd32a91 | 2002-08-15 14:59:02 +0000 | [diff] [blame] | 300 | Obsolete in 2.3. |
Jeremy Hylton | 69e9e8b | 2001-03-21 19:09:31 +0000 | [diff] [blame] | 301 | """ |
Michael W. Hudson | dd32a91 | 2002-08-15 14:59:02 +0000 | [diff] [blame] | 302 | return tb.tb_lineno |