Mercurial > cpython-lru_cache-weakref
annotate Lib/cgitb.py @ 32527:0da660e05e69 legacy-trunk
"#if WITH_THREAD" is incorrect; must be #ifdef instead; WITH_THREAD
isn't always set to an integer value when it's defined.
| author | Tim Peters <tim.peters@gmail.com> |
|---|---|
| date | Wed, 07 Jul 2004 20:42:07 +0000 |
| parents | e1345ce275f7 |
| children | fef7911a5705 |
| rev | line source |
|---|---|
|
29511
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
1 """More comprehensive traceback formatting for Python scripts. |
| 19365 | 2 |
| 3 To enable this module, do: | |
| 4 | |
| 5 import cgitb; cgitb.enable() | |
| 6 | |
|
29511
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
7 at the top of your script. The optional arguments to enable() are: |
| 19365 | 8 |
| 9 display - if true, tracebacks are displayed in the web browser | |
| 10 logdir - if set, tracebacks are written to files in this directory | |
| 19421 | 11 context - number of lines of source code to show for each stack frame |
|
29668
36a17904a3ed
Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents:
29511
diff
changeset
|
12 format - 'text' or 'html' controls the output format |
| 19365 | 13 |
|
29511
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
14 By default, tracebacks are displayed but not saved, the context is 5 lines |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
15 and the output format is 'html' (for backwards compatibility with the |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
16 original use of this module) |
| 19365 | 17 |
| 18 Alternatively, if you have caught an exception and want cgitb to display it | |
|
29511
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
19 for you, call cgitb.handler(). The optional argument to handler() is a |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
20 3-item tuple (etype, evalue, etb) just like the value of sys.exc_info(). |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
21 The default handler displays output as HTML. |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
22 """ |
| 19365 | 23 |
| 24 __author__ = 'Ka-Ping Yee' | |
| 25 __version__ = '$Revision$' | |
| 26 | |
|
21194
1519d6faab15
Add "file" argument to Hook constructor.
Ka-Ping Yee <ping@zesty.ca>
parents:
19421
diff
changeset
|
27 import sys |
|
1519d6faab15
Add "file" argument to Hook constructor.
Ka-Ping Yee <ping@zesty.ca>
parents:
19421
diff
changeset
|
28 |
| 19365 | 29 def reset(): |
| 30 """Return a string that resets the CGI and browser to a known state.""" | |
| 31 return '''<!--: spam | |
| 32 Content-Type: text/html | |
| 33 | |
| 19421 | 34 <body bgcolor="#f0f0f8"><font color="#f0f0f8" size="-5"> --> |
| 35 <body bgcolor="#f0f0f8"><font color="#f0f0f8" size="-5"> --> --> | |
| 19365 | 36 </font> </font> </font> </script> </object> </blockquote> </pre> |
| 37 </table> </table> </table> </table> </table> </font> </font> </font>''' | |
| 38 | |
| 19421 | 39 __UNDEF__ = [] # a special sentinel object |
| 40 def small(text): return '<small>' + text + '</small>' | |
| 41 def strong(text): return '<strong>' + text + '</strong>' | |
| 42 def grey(text): return '<font color="#909090">' + text + '</font>' | |
| 43 | |
| 44 def lookup(name, frame, locals): | |
| 45 """Find the value for a given name in the given environment.""" | |
| 46 if name in locals: | |
| 47 return 'local', locals[name] | |
| 48 if name in frame.f_globals: | |
| 49 return 'global', frame.f_globals[name] | |
|
23998
dab8701bd3fa
Also look up variable names in __builtins__ if not found in globals.
Ka-Ping Yee <ping@zesty.ca>
parents:
21480
diff
changeset
|
50 if '__builtins__' in frame.f_globals: |
|
dab8701bd3fa
Also look up variable names in __builtins__ if not found in globals.
Ka-Ping Yee <ping@zesty.ca>
parents:
21480
diff
changeset
|
51 builtins = frame.f_globals['__builtins__'] |
|
dab8701bd3fa
Also look up variable names in __builtins__ if not found in globals.
Ka-Ping Yee <ping@zesty.ca>
parents:
21480
diff
changeset
|
52 if type(builtins) is type({}): |
|
dab8701bd3fa
Also look up variable names in __builtins__ if not found in globals.
Ka-Ping Yee <ping@zesty.ca>
parents:
21480
diff
changeset
|
53 if name in builtins: |
|
dab8701bd3fa
Also look up variable names in __builtins__ if not found in globals.
Ka-Ping Yee <ping@zesty.ca>
parents:
21480
diff
changeset
|
54 return 'builtin', builtins[name] |
|
dab8701bd3fa
Also look up variable names in __builtins__ if not found in globals.
Ka-Ping Yee <ping@zesty.ca>
parents:
21480
diff
changeset
|
55 else: |
|
dab8701bd3fa
Also look up variable names in __builtins__ if not found in globals.
Ka-Ping Yee <ping@zesty.ca>
parents:
21480
diff
changeset
|
56 if hasattr(builtins, name): |
|
dab8701bd3fa
Also look up variable names in __builtins__ if not found in globals.
Ka-Ping Yee <ping@zesty.ca>
parents:
21480
diff
changeset
|
57 return 'builtin', getattr(builtins, name) |
| 19421 | 58 return None, __UNDEF__ |
| 59 | |
| 60 def scanvars(reader, frame, locals): | |
| 61 """Scan one logical line of Python and look up values of variables used.""" | |
| 62 import tokenize, keyword | |
|
32263
b9c9e7e8be7d
[Bug #758665] cgitb.scanvars() fails because of an unititialized value variable. Patch from Robin Becker.
Andrew M. Kuchling <amk@amk.ca>
parents:
32001
diff
changeset
|
63 vars, lasttoken, parent, prefix, value = [], None, None, '', __UNDEF__ |
| 19421 | 64 for ttype, token, start, end, line in tokenize.generate_tokens(reader): |
| 65 if ttype == tokenize.NEWLINE: break | |
| 66 if ttype == tokenize.NAME and token not in keyword.kwlist: | |
| 67 if lasttoken == '.': | |
| 68 if parent is not __UNDEF__: | |
| 69 value = getattr(parent, token, __UNDEF__) | |
| 70 vars.append((prefix + token, prefix, value)) | |
| 71 else: | |
| 72 where, value = lookup(token, frame, locals) | |
| 73 vars.append((token, where, value)) | |
| 74 elif token == '.': | |
| 75 prefix += lasttoken + '.' | |
| 76 parent = value | |
| 77 else: | |
| 78 parent, prefix = None, '' | |
| 79 lasttoken = token | |
| 80 return vars | |
| 81 | |
| 82 def html((etype, evalue, etb), context=5): | |
| 83 """Return a nice HTML document describing a given traceback.""" | |
|
21194
1519d6faab15
Add "file" argument to Hook constructor.
Ka-Ping Yee <ping@zesty.ca>
parents:
19421
diff
changeset
|
84 import os, types, time, traceback, linecache, inspect, pydoc |
| 19365 | 85 |
| 86 if type(etype) is types.ClassType: | |
| 87 etype = etype.__name__ | |
| 88 pyver = 'Python ' + sys.version.split()[0] + ': ' + sys.executable | |
| 89 date = time.ctime(time.time()) | |
| 19421 | 90 head = '<body bgcolor="#f0f0f8">' + pydoc.html.heading( |
| 19365 | 91 '<big><big><strong>%s</strong></big></big>' % str(etype), |
| 19421 | 92 '#ffffff', '#6622aa', pyver + '<br>' + date) + ''' |
| 93 <p>A problem occurred in a Python script. Here is the sequence of | |
| 94 function calls leading up to the error, in the order they occurred.''' | |
| 19365 | 95 |
| 19421 | 96 indent = '<tt>' + small(' ' * 5) + ' </tt>' |
| 19365 | 97 frames = [] |
| 98 records = inspect.getinnerframes(etb, context) | |
| 99 for frame, file, lnum, func, lines, index in records: | |
| 100 file = file and os.path.abspath(file) or '?' | |
| 19421 | 101 link = '<a href="file://%s">%s</a>' % (file, pydoc.html.escape(file)) |
| 19365 | 102 args, varargs, varkw, locals = inspect.getargvalues(frame) |
| 19421 | 103 call = '' |
| 104 if func != '?': | |
| 105 call = 'in ' + strong(func) + \ | |
| 106 inspect.formatargvalues(args, varargs, varkw, locals, | |
| 107 formatvalue=lambda value: '=' + pydoc.html.repr(value)) | |
| 19365 | 108 |
| 19421 | 109 highlight = {} |
| 110 def reader(lnum=[lnum]): | |
| 111 highlight[lnum[0]] = 1 | |
| 112 try: return linecache.getline(file, lnum[0]) | |
| 113 finally: lnum[0] += 1 | |
| 114 vars = scanvars(reader, frame, locals) | |
| 19365 | 115 |
| 19421 | 116 rows = ['<tr><td bgcolor="#d8bbff">%s%s %s</td></tr>' % |
| 117 ('<big> </big>', link, call)] | |
| 19365 | 118 if index is not None: |
| 119 i = lnum - index | |
| 120 for line in lines: | |
| 19421 | 121 num = small(' ' * (5-len(str(i))) + str(i)) + ' ' |
| 122 line = '<tt>%s%s</tt>' % (num, pydoc.html.preformat(line)) | |
| 123 if i in highlight: | |
| 124 rows.append('<tr><td bgcolor="#ffccee">%s</td></tr>' % line) | |
| 125 else: | |
| 126 rows.append('<tr><td>%s</td></tr>' % grey(line)) | |
| 127 i += 1 | |
| 19365 | 128 |
| 19421 | 129 done, dump = {}, [] |
| 130 for name, where, value in vars: | |
| 131 if name in done: continue | |
| 132 done[name] = 1 | |
| 133 if value is not __UNDEF__: | |
|
23998
dab8701bd3fa
Also look up variable names in __builtins__ if not found in globals.
Ka-Ping Yee <ping@zesty.ca>
parents:
21480
diff
changeset
|
134 if where in ['global', 'builtin']: |
|
dab8701bd3fa
Also look up variable names in __builtins__ if not found in globals.
Ka-Ping Yee <ping@zesty.ca>
parents:
21480
diff
changeset
|
135 name = ('<em>%s</em> ' % where) + strong(name) |
|
dab8701bd3fa
Also look up variable names in __builtins__ if not found in globals.
Ka-Ping Yee <ping@zesty.ca>
parents:
21480
diff
changeset
|
136 elif where == 'local': |
|
dab8701bd3fa
Also look up variable names in __builtins__ if not found in globals.
Ka-Ping Yee <ping@zesty.ca>
parents:
21480
diff
changeset
|
137 name = strong(name) |
|
dab8701bd3fa
Also look up variable names in __builtins__ if not found in globals.
Ka-Ping Yee <ping@zesty.ca>
parents:
21480
diff
changeset
|
138 else: |
|
dab8701bd3fa
Also look up variable names in __builtins__ if not found in globals.
Ka-Ping Yee <ping@zesty.ca>
parents:
21480
diff
changeset
|
139 name = where + strong(name.split('.')[-1]) |
| 19421 | 140 dump.append('%s = %s' % (name, pydoc.html.repr(value))) |
| 141 else: | |
| 142 dump.append(name + ' <em>undefined</em>') | |
| 143 | |
| 144 rows.append('<tr><td>%s</td></tr>' % small(grey(', '.join(dump)))) | |
| 145 frames.append('''<p> | |
| 146 <table width="100%%" cellspacing=0 cellpadding=0 border=0> | |
| 147 %s</table>''' % '\n'.join(rows)) | |
| 148 | |
|
31850
696f4ba9ddf7
[Bugfix candidate] Escape traceback type and value. There are probably additional cases where cgitb.py doesn't escape as paranoidly as it should (e.g. attribute names)
Andrew M. Kuchling <amk@amk.ca>
parents:
29668
diff
changeset
|
149 exception = ['<p>%s: %s' % (strong(pydoc.html.escape(str(etype))), |
|
696f4ba9ddf7
[Bugfix candidate] Escape traceback type and value. There are probably additional cases where cgitb.py doesn't escape as paranoidly as it should (e.g. attribute names)
Andrew M. Kuchling <amk@amk.ca>
parents:
29668
diff
changeset
|
150 pydoc.html.escape(str(evalue)))] |
| 19365 | 151 if type(evalue) is types.InstanceType: |
| 152 for name in dir(evalue): | |
|
23998
dab8701bd3fa
Also look up variable names in __builtins__ if not found in globals.
Ka-Ping Yee <ping@zesty.ca>
parents:
21480
diff
changeset
|
153 if name[:1] == '_': continue |
| 19365 | 154 value = pydoc.html.repr(getattr(evalue, name)) |
| 155 exception.append('\n<br>%s%s =\n%s' % (indent, name, value)) | |
| 156 | |
| 157 import traceback | |
| 158 return head + ''.join(frames) + ''.join(exception) + ''' | |
| 159 | |
| 160 | |
| 19421 | 161 <!-- The above is a description of an error in a Python program, formatted |
| 162 for a Web browser because the 'cgitb' module was enabled. In case you | |
| 163 are not reading this in a Web browser, here is the original traceback: | |
| 19365 | 164 |
| 165 %s | |
| 166 --> | |
| 19421 | 167 ''' % ''.join(traceback.format_exception(etype, evalue, etb)) |
| 19365 | 168 |
|
29511
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
169 def text((etype, evalue, etb), context=5): |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
170 """Return a plain text document describing a given traceback.""" |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
171 import os, types, time, traceback, linecache, inspect, pydoc |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
172 |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
173 if type(etype) is types.ClassType: |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
174 etype = etype.__name__ |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
175 pyver = 'Python ' + sys.version.split()[0] + ': ' + sys.executable |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
176 date = time.ctime(time.time()) |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
177 head = "%s\n%s\n%s\n" % (str(etype), pyver, date) + ''' |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
178 A problem occurred in a Python script. Here is the sequence of |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
179 function calls leading up to the error, in the order they occurred. |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
180 ''' |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
181 |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
182 frames = [] |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
183 records = inspect.getinnerframes(etb, context) |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
184 for frame, file, lnum, func, lines, index in records: |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
185 file = file and os.path.abspath(file) or '?' |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
186 args, varargs, varkw, locals = inspect.getargvalues(frame) |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
187 call = '' |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
188 if func != '?': |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
189 call = 'in ' + func + \ |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
190 inspect.formatargvalues(args, varargs, varkw, locals, |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
191 formatvalue=lambda value: '=' + pydoc.text.repr(value)) |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
192 |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
193 highlight = {} |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
194 def reader(lnum=[lnum]): |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
195 highlight[lnum[0]] = 1 |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
196 try: return linecache.getline(file, lnum[0]) |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
197 finally: lnum[0] += 1 |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
198 vars = scanvars(reader, frame, locals) |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
199 |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
200 rows = [' %s %s' % (file, call)] |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
201 if index is not None: |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
202 i = lnum - index |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
203 for line in lines: |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
204 num = '%5d ' % i |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
205 rows.append(num+line.rstrip()) |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
206 i += 1 |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
207 |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
208 done, dump = {}, [] |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
209 for name, where, value in vars: |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
210 if name in done: continue |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
211 done[name] = 1 |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
212 if value is not __UNDEF__: |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
213 if where == 'global': name = 'global ' + name |
|
32292
e1345ce275f7
Another nit found by Neal Norwitz using pychecker. This was caused by a
Skip Montanaro <skip@pobox.com>
parents:
32263
diff
changeset
|
214 elif where != 'local': name = where + name.split('.')[-1] |
|
29511
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
215 dump.append('%s = %s' % (name, pydoc.text.repr(value))) |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
216 else: |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
217 dump.append(name + ' undefined') |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
218 |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
219 rows.append('\n'.join(dump)) |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
220 frames.append('\n%s\n' % '\n'.join(rows)) |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
221 |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
222 exception = ['%s: %s' % (str(etype), str(evalue))] |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
223 if type(evalue) is types.InstanceType: |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
224 for name in dir(evalue): |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
225 value = pydoc.text.repr(getattr(evalue, name)) |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
226 exception.append('\n%s%s = %s' % (" "*4, name, value)) |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
227 |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
228 import traceback |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
229 return head + ''.join(frames) + ''.join(exception) + ''' |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
230 |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
231 The above is a description of an error in a Python program. Here is |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
232 the original traceback: |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
233 |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
234 %s |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
235 ''' % ''.join(traceback.format_exception(etype, evalue, etb)) |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
236 |
| 19365 | 237 class Hook: |
| 19421 | 238 """A hook to replace sys.excepthook that shows tracebacks in HTML.""" |
| 239 | |
|
29511
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
240 def __init__(self, display=1, logdir=None, context=5, file=None, |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
241 format="html"): |
| 19365 | 242 self.display = display # send tracebacks to browser if true |
| 243 self.logdir = logdir # log tracebacks to files if not None | |
| 19421 | 244 self.context = context # number of source code lines per frame |
|
21194
1519d6faab15
Add "file" argument to Hook constructor.
Ka-Ping Yee <ping@zesty.ca>
parents:
19421
diff
changeset
|
245 self.file = file or sys.stdout # place to send the output |
|
29511
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
246 self.format = format |
| 19365 | 247 |
| 248 def __call__(self, etype, evalue, etb): | |
| 249 self.handle((etype, evalue, etb)) | |
| 250 | |
| 251 def handle(self, info=None): | |
| 252 info = info or sys.exc_info() | |
|
29511
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
253 if self.format == "html": |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
254 self.file.write(reset()) |
| 19365 | 255 |
|
29511
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
256 formatter = (self.format=="html") and html or text |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
257 plain = False |
| 19365 | 258 try: |
|
29511
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
259 doc = formatter(info, self.context) |
| 19365 | 260 except: # just in case something goes wrong |
| 261 import traceback | |
|
29511
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
262 doc = ''.join(traceback.format_exception(*info)) |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
263 plain = True |
| 19365 | 264 |
| 265 if self.display: | |
|
29511
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
266 if plain: |
| 19365 | 267 doc = doc.replace('&', '&').replace('<', '<') |
|
21194
1519d6faab15
Add "file" argument to Hook constructor.
Ka-Ping Yee <ping@zesty.ca>
parents:
19421
diff
changeset
|
268 self.file.write('<pre>' + doc + '</pre>\n') |
| 19365 | 269 else: |
|
21194
1519d6faab15
Add "file" argument to Hook constructor.
Ka-Ping Yee <ping@zesty.ca>
parents:
19421
diff
changeset
|
270 self.file.write(doc + '\n') |
| 19365 | 271 else: |
|
21194
1519d6faab15
Add "file" argument to Hook constructor.
Ka-Ping Yee <ping@zesty.ca>
parents:
19421
diff
changeset
|
272 self.file.write('<p>A problem occurred in a Python script.\n') |
| 19365 | 273 |
| 274 if self.logdir is not None: | |
| 19421 | 275 import os, tempfile |
|
32001
2cc714977479
[Bug #945063] Get file extension correct. (2.3 bugfix candidate)
Andrew M. Kuchling <amk@amk.ca>
parents:
31850
diff
changeset
|
276 suffix = ['.txt', '.html'][self.format=="html"] |
|
29511
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
277 (fd, path) = tempfile.mkstemp(suffix=suffix, dir=self.logdir) |
| 19365 | 278 try: |
|
24710
11c701038805
Massive changes from SF 589982 (tempfile.py rewrite, by Zack
Guido van Rossum <guido@python.org>
parents:
23998
diff
changeset
|
279 file = os.fdopen(fd, 'w') |
| 19365 | 280 file.write(doc) |
| 281 file.close() | |
|
21194
1519d6faab15
Add "file" argument to Hook constructor.
Ka-Ping Yee <ping@zesty.ca>
parents:
19421
diff
changeset
|
282 msg = '<p> %s contains the description of this error.' % path |
| 19365 | 283 except: |
|
21194
1519d6faab15
Add "file" argument to Hook constructor.
Ka-Ping Yee <ping@zesty.ca>
parents:
19421
diff
changeset
|
284 msg = '<p> Tried to save traceback to %s, but failed.' % path |
|
1519d6faab15
Add "file" argument to Hook constructor.
Ka-Ping Yee <ping@zesty.ca>
parents:
19421
diff
changeset
|
285 self.file.write(msg + '\n') |
|
1519d6faab15
Add "file" argument to Hook constructor.
Ka-Ping Yee <ping@zesty.ca>
parents:
19421
diff
changeset
|
286 try: |
|
1519d6faab15
Add "file" argument to Hook constructor.
Ka-Ping Yee <ping@zesty.ca>
parents:
19421
diff
changeset
|
287 self.file.flush() |
|
1519d6faab15
Add "file" argument to Hook constructor.
Ka-Ping Yee <ping@zesty.ca>
parents:
19421
diff
changeset
|
288 except: pass |
| 19365 | 289 |
| 290 handler = Hook().handle | |
|
29511
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
291 def enable(display=1, logdir=None, context=5, format="html"): |
| 19421 | 292 """Install an exception handler that formats tracebacks as HTML. |
| 293 | |
| 294 The optional argument 'display' can be set to 0 to suppress sending the | |
| 295 traceback to the browser, and 'logdir' can be set to a directory to cause | |
| 296 tracebacks to be written to files there.""" | |
|
29511
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
297 sys.excepthook = Hook(display=display, logdir=logdir, |
|
d1acf89d1c49
SF Patch 569574 - enhancements to cgitb for plain text display
Skip Montanaro <skip@pobox.com>
parents:
26912
diff
changeset
|
298 context=context, format=format) |