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