Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / cpython3 / 57b39e0916d741d9851ac875d8f443bfc6005def / . / Lib / cgitb.py
blob: 19118ea53d4a42fd3f8c0260d44fdfa02dd7b31d [file] [log] [blame]
Skip Montanaro364ca402003-06-17 12:58:31 +0000[diff] [blame]1"""More comprehensive traceback formatting for Python scripts.
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]2
3To enable this module, do:
4
5 import cgitb; cgitb.enable()
6
Skip Montanaro364ca402003-06-17 12:58:31 +0000[diff] [blame]7at the top of your script. The optional arguments to enable() are:
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]8
9 display - if true, tracebacks are displayed in the web browser
10 logdir - if set, tracebacks are written to files in this directory
Ka-Ping Yee83205972001-08-21 06:53:01 +0000[diff] [blame]11 context - number of lines of source code to show for each stack frame
Tim Peters478c1052003-06-29 05:46:54 +0000[diff] [blame]12 format - 'text' or 'html' controls the output format
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]13
Skip Montanaro364ca402003-06-17 12:58:31 +0000[diff] [blame]14By default, tracebacks are displayed but not saved, the context is 5 lines
15and the output format is 'html' (for backwards compatibility with the
16original use of this module)
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]17
18Alternatively, if you have caught an exception and want cgitb to display it
Skip Montanaro364ca402003-06-17 12:58:31 +0000[diff] [blame]19for you, call cgitb.handler(). The optional argument to handler() is a
203-item tuple (etype, evalue, etb) just like the value of sys.exc_info().
21The default handler displays output as HTML.
22"""
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]23
24__author__ = 'Ka-Ping Yee'
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000[diff] [blame]25
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]26__version__ = '$Revision$'
27
Ka-Ping Yeefa78d0f2001-12-04 18:45:17 +0000[diff] [blame]28import sys
29
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]30def reset():
31 """Return a string that resets the CGI and browser to a known state."""
32 return '''<!--: spam
33Content-Type: text/html
34
Ka-Ping Yee83205972001-08-21 06:53:01 +0000[diff] [blame]35<body bgcolor="#f0f0f8"><font color="#f0f0f8" size="-5"> -->
36<body bgcolor="#f0f0f8"><font color="#f0f0f8" size="-5"> --> -->
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]37</font> </font> </font> </script> </object> </blockquote> </pre>
38</table> </table> </table> </table> </table> </font> </font> </font>'''
39
Ka-Ping Yee83205972001-08-21 06:53:01 +0000[diff] [blame]40__UNDEF__ = [] # a special sentinel object
Andrew M. Kuchling5fcefdb2004-07-10 14:14:51 +0000[diff] [blame]41def small(text):
42 if text:
43 return '<small>' + text + '</small>'
44 else:
45 return ''
Tim Peters182b5ac2004-07-18 06:16:08 +0000[diff] [blame]46
Andrew M. Kuchling5fcefdb2004-07-10 14:14:51 +0000[diff] [blame]47def strong(text):
48 if text:
49 return '<strong>' + text + '</strong>'
50 else:
51 return ''
Tim Peters182b5ac2004-07-18 06:16:08 +0000[diff] [blame]52
Andrew M. Kuchling5fcefdb2004-07-10 14:14:51 +0000[diff] [blame]53def grey(text):
54 if text:
55 return '<font color="#909090">' + text + '</font>'
56 else:
57 return ''
Ka-Ping Yee83205972001-08-21 06:53:01 +0000[diff] [blame]58
59def lookup(name, frame, locals):
60 """Find the value for a given name in the given environment."""
61 if name in locals:
62 return 'local', locals[name]
63 if name in frame.f_globals:
64 return 'global', frame.f_globals[name]
Ka-Ping Yee711cad72002-06-26 07:10:56 +0000[diff] [blame]65 if '__builtins__' in frame.f_globals:
66 builtins = frame.f_globals['__builtins__']
67 if type(builtins) is type({}):
68 if name in builtins:
69 return 'builtin', builtins[name]
70 else:
71 if hasattr(builtins, name):
72 return 'builtin', getattr(builtins, name)
Ka-Ping Yee83205972001-08-21 06:53:01 +0000[diff] [blame]73 return None, __UNDEF__
74
75def scanvars(reader, frame, locals):
76 """Scan one logical line of Python and look up values of variables used."""
77 import tokenize, keyword
Andrew M. Kuchling26f6bdf2004-06-05 19:15:34 +0000[diff] [blame]78 vars, lasttoken, parent, prefix, value = [], None, None, '', __UNDEF__
Ka-Ping Yee83205972001-08-21 06:53:01 +0000[diff] [blame]79 for ttype, token, start, end, line in tokenize.generate_tokens(reader):
80 if ttype == tokenize.NEWLINE: break
81 if ttype == tokenize.NAME and token not in keyword.kwlist:
82 if lasttoken == '.':
83 if parent is not __UNDEF__:
84 value = getattr(parent, token, __UNDEF__)
85 vars.append((prefix + token, prefix, value))
86 else:
87 where, value = lookup(token, frame, locals)
88 vars.append((token, where, value))
89 elif token == '.':
90 prefix += lasttoken + '.'
91 parent = value
92 else:
93 parent, prefix = None, ''
94 lasttoken = token
95 return vars
96
97def html((etype, evalue, etb), context=5):
98 """Return a nice HTML document describing a given traceback."""
Ka-Ping Yeefa78d0f2001-12-04 18:45:17 +0000[diff] [blame]99 import os, types, time, traceback, linecache, inspect, pydoc
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]100
101 if type(etype) is types.ClassType:
102 etype = etype.__name__
103 pyver = 'Python ' + sys.version.split()[0] + ': ' + sys.executable
104 date = time.ctime(time.time())
Ka-Ping Yee83205972001-08-21 06:53:01 +0000[diff] [blame]105 head = '<body bgcolor="#f0f0f8">' + pydoc.html.heading(
Andrew M. Kuchling5fcefdb2004-07-10 14:14:51 +0000[diff] [blame]106 '<big><big>%s</big></big>' %
107 strong(pydoc.html.escape(str(etype))),
Ka-Ping Yee83205972001-08-21 06:53:01 +0000[diff] [blame]108 '#ffffff', '#6622aa', pyver + '<br>' + date) + '''
109<p>A problem occurred in a Python script. Here is the sequence of
Andrew M. Kuchling5fcefdb2004-07-10 14:14:51 +0000[diff] [blame]110function calls leading up to the error, in the order they occurred.</p>'''
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]111
Ka-Ping Yee83205972001-08-21 06:53:01 +0000[diff] [blame]112 indent = '<tt>' + small('&nbsp;' * 5) + '&nbsp;</tt>'
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]113 frames = []
114 records = inspect.getinnerframes(etb, context)
115 for frame, file, lnum, func, lines, index in records:
Georg Brandl07c81d92005-06-26 21:57:55 +0000[diff] [blame]116 if file:
117 file = os.path.abspath(file)
118 link = '<a href="file://%s">%s</a>' % (file, pydoc.html.escape(file))
119 else:
120 file = link = '?'
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]121 args, varargs, varkw, locals = inspect.getargvalues(frame)
Ka-Ping Yee83205972001-08-21 06:53:01 +0000[diff] [blame]122 call = ''
123 if func != '?':
124 call = 'in ' + strong(func) + \
125 inspect.formatargvalues(args, varargs, varkw, locals,
126 formatvalue=lambda value: '=' + pydoc.html.repr(value))
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]127
Ka-Ping Yee83205972001-08-21 06:53:01 +0000[diff] [blame]128 highlight = {}
129 def reader(lnum=[lnum]):
130 highlight[lnum[0]] = 1
131 try: return linecache.getline(file, lnum[0])
132 finally: lnum[0] += 1
133 vars = scanvars(reader, frame, locals)
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]134
Ka-Ping Yee83205972001-08-21 06:53:01 +0000[diff] [blame]135 rows = ['<tr><td bgcolor="#d8bbff">%s%s %s</td></tr>' %
136 ('<big>&nbsp;</big>', link, call)]
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]137 if index is not None:
138 i = lnum - index
139 for line in lines:
Ka-Ping Yee83205972001-08-21 06:53:01 +0000[diff] [blame]140 num = small('&nbsp;' * (5-len(str(i))) + str(i)) + '&nbsp;'
141 line = '<tt>%s%s</tt>' % (num, pydoc.html.preformat(line))
142 if i in highlight:
143 rows.append('<tr><td bgcolor="#ffccee">%s</td></tr>' % line)
144 else:
145 rows.append('<tr><td>%s</td></tr>' % grey(line))
146 i += 1
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]147
Ka-Ping Yee83205972001-08-21 06:53:01 +0000[diff] [blame]148 done, dump = {}, []
149 for name, where, value in vars:
150 if name in done: continue
151 done[name] = 1
152 if value is not __UNDEF__:
Raymond Hettingerdbecd932005-02-06 06:57:08 +0000[diff] [blame]153 if where in ('global', 'builtin'):
Ka-Ping Yee711cad72002-06-26 07:10:56 +0000[diff] [blame]154 name = ('<em>%s</em> ' % where) + strong(name)
155 elif where == 'local':
156 name = strong(name)
157 else:
158 name = where + strong(name.split('.')[-1])
Ka-Ping Yee83205972001-08-21 06:53:01 +0000[diff] [blame]159 dump.append('%s&nbsp;= %s' % (name, pydoc.html.repr(value)))
160 else:
161 dump.append(name + ' <em>undefined</em>')
162
163 rows.append('<tr><td>%s</td></tr>' % small(grey(', '.join(dump))))
Andrew M. Kuchling5fcefdb2004-07-10 14:14:51 +0000[diff] [blame]164 frames.append('''
Ka-Ping Yee83205972001-08-21 06:53:01 +0000[diff] [blame]165<table width="100%%" cellspacing=0 cellpadding=0 border=0>
166%s</table>''' % '\n'.join(rows))
167
Andrew M. Kuchlingb67c9432004-03-31 20:17:56 +0000[diff] [blame]168 exception = ['<p>%s: %s' % (strong(pydoc.html.escape(str(etype))),
169 pydoc.html.escape(str(evalue)))]
Georg Brandl57b39e02007-04-11 19:24:50 +0000[diff] [blame^]170 for name in dir(evalue):
171 if name[:1] == '_': continue
172 value = pydoc.html.repr(getattr(evalue, name))
173 exception.append('\n<br>%s%s&nbsp;=\n%s' % (indent, name, value))
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]174
175 import traceback
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]176 return head + ''.join(frames) + ''.join(exception) + '''
177
178
Ka-Ping Yee83205972001-08-21 06:53:01 +0000[diff] [blame]179<!-- The above is a description of an error in a Python program, formatted
180 for a Web browser because the 'cgitb' module was enabled. In case you
181 are not reading this in a Web browser, here is the original traceback:
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]182
183%s
184-->
Ka-Ping Yee83205972001-08-21 06:53:01 +0000[diff] [blame]185''' % ''.join(traceback.format_exception(etype, evalue, etb))
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]186
Skip Montanaro364ca402003-06-17 12:58:31 +0000[diff] [blame]187def text((etype, evalue, etb), context=5):
188 """Return a plain text document describing a given traceback."""
189 import os, types, time, traceback, linecache, inspect, pydoc
190
191 if type(etype) is types.ClassType:
192 etype = etype.__name__
193 pyver = 'Python ' + sys.version.split()[0] + ': ' + sys.executable
194 date = time.ctime(time.time())
195 head = "%s\n%s\n%s\n" % (str(etype), pyver, date) + '''
196A problem occurred in a Python script. Here is the sequence of
197function calls leading up to the error, in the order they occurred.
198'''
199
200 frames = []
201 records = inspect.getinnerframes(etb, context)
202 for frame, file, lnum, func, lines, index in records:
203 file = file and os.path.abspath(file) or '?'
204 args, varargs, varkw, locals = inspect.getargvalues(frame)
205 call = ''
206 if func != '?':
207 call = 'in ' + func + \
208 inspect.formatargvalues(args, varargs, varkw, locals,
209 formatvalue=lambda value: '=' + pydoc.text.repr(value))
210
211 highlight = {}
212 def reader(lnum=[lnum]):
213 highlight[lnum[0]] = 1
214 try: return linecache.getline(file, lnum[0])
215 finally: lnum[0] += 1
216 vars = scanvars(reader, frame, locals)
217
218 rows = [' %s %s' % (file, call)]
219 if index is not None:
220 i = lnum - index
221 for line in lines:
222 num = '%5d ' % i
223 rows.append(num+line.rstrip())
224 i += 1
225
226 done, dump = {}, []
227 for name, where, value in vars:
228 if name in done: continue
229 done[name] = 1
230 if value is not __UNDEF__:
231 if where == 'global': name = 'global ' + name
Skip Montanaro1c0228a2004-06-07 11:20:40 +0000[diff] [blame]232 elif where != 'local': name = where + name.split('.')[-1]
Skip Montanaro364ca402003-06-17 12:58:31 +0000[diff] [blame]233 dump.append('%s = %s' % (name, pydoc.text.repr(value)))
234 else:
235 dump.append(name + ' undefined')
236
237 rows.append('\n'.join(dump))
238 frames.append('\n%s\n' % '\n'.join(rows))
239
240 exception = ['%s: %s' % (str(etype), str(evalue))]
Georg Brandl57b39e02007-04-11 19:24:50 +0000[diff] [blame^]241 for name in dir(evalue):
242 value = pydoc.text.repr(getattr(evalue, name))
243 exception.append('\n%s%s = %s' % (" "*4, name, value))
Skip Montanaro364ca402003-06-17 12:58:31 +0000[diff] [blame]244
245 import traceback
246 return head + ''.join(frames) + ''.join(exception) + '''
247
248The above is a description of an error in a Python program. Here is
249the original traceback:
250
251%s
252''' % ''.join(traceback.format_exception(etype, evalue, etb))
253
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]254class Hook:
Ka-Ping Yee83205972001-08-21 06:53:01 +0000[diff] [blame]255 """A hook to replace sys.excepthook that shows tracebacks in HTML."""
256
Skip Montanaro364ca402003-06-17 12:58:31 +0000[diff] [blame]257 def __init__(self, display=1, logdir=None, context=5, file=None,
258 format="html"):
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]259 self.display = display # send tracebacks to browser if true
260 self.logdir = logdir # log tracebacks to files if not None
Ka-Ping Yee83205972001-08-21 06:53:01 +0000[diff] [blame]261 self.context = context # number of source code lines per frame
Ka-Ping Yeefa78d0f2001-12-04 18:45:17 +0000[diff] [blame]262 self.file = file or sys.stdout # place to send the output
Skip Montanaro364ca402003-06-17 12:58:31 +0000[diff] [blame]263 self.format = format
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]264
265 def __call__(self, etype, evalue, etb):
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]266 self.handle((etype, evalue, etb))
267
268 def handle(self, info=None):
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]269 info = info or sys.exc_info()
Skip Montanaro364ca402003-06-17 12:58:31 +0000[diff] [blame]270 if self.format == "html":
271 self.file.write(reset())
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]272
Skip Montanaro364ca402003-06-17 12:58:31 +0000[diff] [blame]273 formatter = (self.format=="html") and html or text
274 plain = False
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]275 try:
Skip Montanaro364ca402003-06-17 12:58:31 +0000[diff] [blame]276 doc = formatter(info, self.context)
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]277 except: # just in case something goes wrong
278 import traceback
Skip Montanaro364ca402003-06-17 12:58:31 +0000[diff] [blame]279 doc = ''.join(traceback.format_exception(*info))
280 plain = True
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]281
282 if self.display:
Skip Montanaro364ca402003-06-17 12:58:31 +0000[diff] [blame]283 if plain:
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]284 doc = doc.replace('&', '&amp;').replace('<', '&lt;')
Ka-Ping Yeefa78d0f2001-12-04 18:45:17 +0000[diff] [blame]285 self.file.write('<pre>' + doc + '</pre>\n')
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]286 else:
Ka-Ping Yeefa78d0f2001-12-04 18:45:17 +0000[diff] [blame]287 self.file.write(doc + '\n')
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]288 else:
Ka-Ping Yeefa78d0f2001-12-04 18:45:17 +0000[diff] [blame]289 self.file.write('<p>A problem occurred in a Python script.\n')
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]290
291 if self.logdir is not None:
Ka-Ping Yee83205972001-08-21 06:53:01 +0000[diff] [blame]292 import os, tempfile
Andrew M. Kuchling30633c92004-05-06 13:13:44 +0000[diff] [blame]293 suffix = ['.txt', '.html'][self.format=="html"]
Skip Montanaro364ca402003-06-17 12:58:31 +0000[diff] [blame]294 (fd, path) = tempfile.mkstemp(suffix=suffix, dir=self.logdir)
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]295 try:
Guido van Rossum3b0a3292002-08-09 16:38:32 +0000[diff] [blame]296 file = os.fdopen(fd, 'w')
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]297 file.write(doc)
298 file.close()
Ka-Ping Yeefa78d0f2001-12-04 18:45:17 +0000[diff] [blame]299 msg = '<p> %s contains the description of this error.' % path
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]300 except:
Ka-Ping Yeefa78d0f2001-12-04 18:45:17 +0000[diff] [blame]301 msg = '<p> Tried to save traceback to %s, but failed.' % path
302 self.file.write(msg + '\n')
303 try:
304 self.file.flush()
305 except: pass
Ka-Ping Yee6b5a48d2001-08-18 04:04:50 +0000[diff] [blame]306
307handler = Hook().handle
Skip Montanaro364ca402003-06-17 12:58:31 +0000[diff] [blame]308def enable(display=1, logdir=None, context=5, format="html"):
Ka-Ping Yee83205972001-08-21 06:53:01 +0000[diff] [blame]309 """Install an exception handler that formats tracebacks as HTML.
310
311 The optional argument 'display' can be set to 0 to suppress sending the
312 traceback to the browser, and 'logdir' can be set to a directory to cause
313 tracebacks to be written to files there."""
Skip Montanaro364ca402003-06-17 12:58:31 +0000[diff] [blame]314 sys.excepthook = Hook(display=display, logdir=logdir,
315 context=context, format=format)