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