1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
|
"""$Id: pydbbdb.py,v 1.57 2009/03/06 09:41:37 rockyb Exp $
Routines here have to do with the subclassing of bdb. Defines Python
debugger Basic Debugger (Bdb) class. This file could/should probably
get merged into bdb.py
"""
import bdb, bytecode, inspect, linecache, time, types
from repr import Repr
from fns import *
## from complete import rl_complete
def frame2file(obj, frame):
return obj.filename(obj.canonic_filename(frame))
class Bdb(bdb.Bdb):
# Additional levels call frames usually on the stack.
# Perhaps should be an instance variable?
extra_call_frames = 7 # Yes, it's really that many!
def __init__(self):
bdb.Bdb.__init__(self)
self.bdb_set_trace = bdb.Bdb.set_trace
## self.complete = lambda arg: complete.rl_complete(self, arg)
# Create a custom safe Repr instance and increase its maxstring.
# The default of 30 truncates error messages too easily.
self._repr = Repr()
self._repr.maxstring = 100
self._repr.maxother = 60
self._repr.maxset = 10
self._repr.maxfrozen = 10
self._repr.array = 10
self._saferepr = self._repr.repr
# Certain debugger commands are and actions only applicable
# for running programs. Thus we record the running status of
# the debugged code.
self.running = False
# A 0 value means stop on this occurrence. A positive value means to
# skip that many more step/next's.
self.step_ignore = 0
# Do we want to show/stop at def statements before they are run?
self.deftrace = False
return
def __print_call_params(self, frame):
"Show call paramaters and values"
self.setup(frame)
# Does format_stack_entry() have an 'include_location' parameter?
fse_code = self.format_stack_entry.func_code
fse_args = fse_code.co_varnames
if 'include_location' in fse_args:
self.msg(self.format_stack_entry(self.stack[-1],
include_location=False))
else:
self.msg(self.format_stack_entry(self.stack[-1]))
return
return
def __print_location_if_trace(self, frame, include_fntrace=True):
if self.linetrace or (self.fntrace and include_fntrace):
self.setup(frame)
self.print_location(print_line=True)
self.display.display(self.curframe)
if self.linetrace_delay:
time.sleep(self.linetrace_delay)
return
return
return
def bp_commands(self, frame):
"""Call every command that was set for the current
active breakpoint (if there is one) Returns True if
the normal interaction function must be called,
False otherwise """
# self.currentbp is set in bdb.py in bdb.break_here if
# a breakpoint was hit
if getattr(self,"currentbp",False) and self.currentbp in self.commands:
currentbp = self.currentbp
self.currentbp = 0
lastcmd_back = self.lastcmd
self.setup(frame, None)
for line in self.commands[currentbp]:
self.onecmd(line)
self.lastcmd = lastcmd_back
if not self.commands_silent[currentbp]:
self.print_location(print_line=self.linetrace)
if self.commands_doprompt[currentbp]:
self.cmdloop()
self.forget()
return False
return True
def is_running(self):
if self.running: return True
self.errmsg('The program being debugged is not being run.')
return False
def lookupmodule(self, filename):
"""Helper function for break/clear parsing -- may be overridden.
lookupmodule() translates (possibly incomplete) file or module name
into an absolute file name.
"""
if os.path.isabs(filename) and os.path.exists(filename):
return filename
f = os.path.join(sys.path[0], filename)
if os.path.exists(f) and self.canonic(f) == self.mainpyfile:
return f
root, ext = os.path.splitext(filename)
if ext == '':
filename = filename + '.py'
if os.path.isabs(filename):
return filename
for dirname in sys.path:
while os.path.islink(dirname):
dirname = os.readlink(dirname)
fullname = os.path.join(dirname, filename)
if os.path.exists(fullname):
return fullname
return None
# Override Bdb methods
def bpprint(self, bp, out=None):
if bp.temporary:
disp = 'del '
else:
disp = 'keep '
if bp.enabled:
disp = disp + 'y '
else:
disp = disp + 'n '
self.msg('%-4dbreakpoint %s at %s:%d' %
(bp.number, disp, self.filename(bp.file), bp.line), out)
if bp.cond:
self.msg('\tstop only if %s' % (bp.cond))
if bp.ignore:
self.msg('\tignore next %d hits' % (bp.ignore), out)
if (bp.hits):
if (bp.hits > 1): ss = 's'
else: ss = ''
self.msg('\tbreakpoint already hit %d time%s' %
(bp.hits, ss), out)
return
def output_break_commands(self):
"""Return a list of 'break' commands. This could be used to save and
restore breakpoint status across a restart"""
# FIXME: We are going to assume no breakpoints set
# previously. bp_no is renumbered breakpoint numbers used
# in subsequent "disable" commands.
bp_no = 0
out = []
for bp in bdb.Breakpoint.bpbynumber:
if bp:
bp_no += 1
if bp.cond:
condition = bp.cond
else:
condition = ''
out.append("break %s:%s%s" %
(self.filename(bp.file), bp.line, condition))
if not bp.enabled:
out.append("disable %s" % bp_no)
return out
def break_here(self, frame):
"""This routine is almost copy of bdb.py's routine. Alas what pdb
calls clear gdb calls delete and gdb's clear command is different.
I tried saving/restoring method names, but that didn't catch
all of the places break_here was called.
"""
filename = self.canonic(frame.f_code.co_filename)
if not filename in self.breaks:
return False
lineno = frame.f_lineno
if not lineno in self.breaks[filename]:
# The line itself has no breakpoint, but maybe the line is the
# first line of a function with breakpoint set by function name.
lineno = frame.f_code.co_firstlineno
if not lineno in self.breaks[filename]:
return False
# flag says ok to delete temp. bp
(bp, flag) = bdb.effective(filename, lineno, frame)
if bp:
## This is new when we have thread debugging.
self.currentbp = bp.number
if hasattr(bp, 'thread_name') and hasattr(self, 'thread_name') \
and bp.thread_name != self.thread_name:
return False
if (flag and bp.temporary):
#### ARG. All for the below name change.
self.do_delete(str(bp.number))
return True
return False
def canonic(self, filename):
""" Overrides bdb canonic. We need to ensure the file
we return exists! """
if filename == "<" + filename[1:-1] + ">":
return filename
canonic = self.fncache.get(filename)
if not canonic:
lead_dir = filename.split(os.sep)[0]
if lead_dir == os.curdir or lead_dir == os.pardir:
# We may have invoked the program from a directory
# other than where the program resides. filename is
# relative to where the program resides. So make sure
# to use that.
canonic = os.path.abspath(os.path.join(self.main_dirname,
filename))
else:
canonic = os.path.abspath(filename)
if not os.path.isfile(canonic):
canonic = search_file(filename, self.search_path,
self.main_dirname)
# Not if this is right for utter failure.
if not canonic: canonic = filename
canonic = os.path.realpath(os.path.normcase(canonic))
self.fncache[filename] = canonic
return canonic
return canonic
def canonic_filename(self, frame):
return self.canonic(frame.f_code.co_filename)
def clear_break(self, filename, lineno):
filename = self.canonic(filename)
if not filename in self.breaks:
self.errmsg('No breakpoint at %s:%d.'
% (self.filename(filename), lineno))
return []
if lineno not in self.breaks[filename]:
self.errmsg('No breakpoint at %s:%d.'
% (self.filename(filename), lineno))
return []
# If there's only one bp in the list for that file,line
# pair, then remove the breaks entry
brkpts = []
for bp in bdb.Breakpoint.bplist[filename, lineno][:]:
brkpts.append(bp.number)
bp.deleteMe()
if not bdb.Breakpoint.bplist.has_key((filename, lineno)):
self.breaks[filename].remove(lineno)
if not self.breaks[filename]:
del self.breaks[filename]
return brkpts
return brkpts
def complete(self, text, state):
"A readline complete replacement"
if hasattr(self, "completer"):
if self.readline:
line_buffer = self.readline.get_line_buffer()
cmds = self.all_completions(line_buffer, False)
else:
line_buffer = ''
cmds = self.all_completions(text, False)
self.completer.namespace = dict(zip(cmds, cmds))
args=line_buffer.split()
if len(args) < 2:
self.completer.namespace.update(self.curframe.f_globals.copy())
self.completer.namespace.update(self.curframe.f_locals)
return self.completer.complete(text, state)
return None
def filename(self, filename=None):
"""Return filename or the basename of that depending on the
self.basename setting"""
if filename is None:
if self.mainpyfile:
filename = self.mainpyfile
else:
return None
if self.basename:
return(os.path.basename(filename))
return filename
def format_stack_entry(self, frame_lineno, lprefix=': ',
include_location=True):
"""Format and return a stack entry gdb-style.
Note: lprefix is not used. It is kept for compatibility.
"""
import repr as repr_mod
frame, lineno = frame_lineno
filename = frame2file(self, frame)
s = ''
if frame.f_code.co_name:
s = frame.f_code.co_name
else:
s = "<lambda>"
args, varargs, varkw, local_vars = inspect.getargvalues(frame)
if '<module>' == s and ([], None, None,) == (args, varargs, varkw,):
is_module = True
if is_exec_stmt(frame):
s += ' exec()'
else:
fn_name = get_call_function_name(frame)
if fn_name: s += ' %s()' % fn_name
pass
else:
is_module = False
parms=inspect.formatargvalues(args, varargs, varkw, local_vars)
if len(parms) >= self.maxargstrsize:
parms = "%s...)" % parms[0:self.maxargstrsize]
pass
s += parms
pass
# ddd can't handle wrapped stack entries.
# if len(s) >= 35:
# s += "\n "
if '__return__' in frame.f_locals:
rv = frame.f_locals['__return__']
s += '->'
s += repr_mod.repr(rv)
add_quotes_around_file = True
if include_location:
if is_module:
s += ' file'
elif s == '?()':
if is_exec_stmt(frame):
s = 'in exec'
exec_str = get_exec_string(frame.f_back)
if exec_str != None:
filename = exec_str
add_quotes_around_file = False
else:
s = 'in file'
else:
s += ' called from file'
if add_quotes_around_file: filename = "'%s'" % filename
s += " %s at line %r" % (filename, lineno)
return s
return s
# The following two methods can be called by clients to use
# a debugger to debug a statement, given as a string.
def run(self, cmd, globals=None, locals=None):
"""A copy of bdb's run but with a local variable added so we
can find it it a call stack and hide it when desired (which is
probably most of the time).
"""
breadcrumb = self.run
if globals is None:
import __main__
globals = __main__.__dict__
if locals is None:
locals = globals
self.reset()
sys.settrace(self.trace_dispatch)
if not isinstance(cmd, types.CodeType):
cmd = cmd+'\n'
try:
self.running = True
try:
exec cmd in globals, locals
except bdb.BdbQuit:
pass
finally:
self.quitting = 1
self.running = False
sys.settrace(None)
return
def reset(self):
bdb.Bdb.reset(self)
self.forget()
return
def set_trace(self, frame=None):
"""Wrapper to accomodate different versions of Python"""
if sys.version_info[0] == 2 and sys.version_info[1] >= 4:
if frame is None:
frame = self.curframe
self.bdb_set_trace(self, frame)
else:
# older versions
self.bdb_set_trace(self)
return
def user_call(self, frame, argument_list):
"""This method is called when there is the remote possibility
that we ever need to stop in this function.
Note argument_list isn't used. It is kept for compatibility"""
self.stop_reason = 'call'
if self._wait_for_mainpyfile:
return
if self.stop_here(frame):
frame_count = count_frames(frame, Bdb.extra_call_frames)
self.msg_nocr('--%sCall level %d' %
('-' * (2*frame_count), frame_count))
if frame_count >= 0:
self.__print_call_params(frame)
else:
self.msg("")
if self.linetrace or self.fntrace:
self.__print_location_if_trace(frame)
if not self.break_here(frame): return
self.interaction(frame, None)
return
return
def user_exception(self, frame, (exc_type, exc_value, exc_traceback)):
"""This function is called if an exception occurs,
but only if we are to stop at or just below this level."""
self.stop_reason = 'exception'
# Remove any pending source lines.
self.rcLines = []
frame.f_locals['__exception__'] = exc_type, exc_value
if type(exc_type) == types.StringType:
exc_type_name = exc_type
else: exc_type_name = exc_type.__name__
self.msg("%s:%s" % (str(exc_type_name),
str(self._saferepr(exc_value))))
self.interaction(frame, exc_traceback)
return
def user_line(self, frame):
"""This function is called when we stop or break at this line.
However it's *also* called when line OR function tracing is
in effect. A little bit confusing and this code needs to be
simplified."""
self.stop_reason = 'line'
if self._wait_for_mainpyfile:
if (self.mainpyfile != self.canonic_filename(frame)
or inspect.getlineno(frame) <= 0):
return
self._wait_for_mainpyfile = False
if self.stop_here(frame) or self.linetrace or self.fntrace:
# Don't stop if we are looking at a def for which a breakpoint
# has not been set.
filename = frame2file(self, frame)
# Python 2.5 or greater has 3 arg getline which handles
# eggs and zip files
if 3 == linecache.getline.func_code.co_argcount:
line = linecache.getline(filename, inspect.getlineno(frame),
frame.f_globals)
else:
line = linecache.getline(filename, inspect.getlineno(frame))
pass
# No, we don't have a breakpoint. So we are either
# stepping or here because of line tracing.
if self.step_ignore > 0:
# Don't stop this time, just note a step was done in
# step count
self.step_ignore -= 1
self.__print_location_if_trace(frame, False)
return
elif self.step_ignore < 0:
# We are stepping only because we tracing
self.__print_location_if_trace(frame, False)
return
if not self.break_here(frame):
if bytecode.is_def_stmt(line, frame) and not self.deftrace:
self.__print_location_if_trace(frame, False)
return
elif self.fntrace:
# The above test is a real hack. We need to clean
# up this code.
return
else:
if not self.break_here(frame) and self.step_ignore > 0:
self.__print_location_if_trace(frame, False)
self.step_ignore -= 1
return
if self.bp_commands(frame):
self.interaction(frame, None)
return
return
def user_return(self, frame, return_value):
"""This function is called when a return trap is set here."""
self.stop_reason = 'return'
frame.f_locals['__return__'] = return_value
frame_count = count_frames(frame, Bdb.extra_call_frames)
if frame_count >= 0:
self.msg_nocr("--%sReturn from level %d" % ('-' * (2*frame_count),
frame_count))
if type(return_value) in [types.StringType, types.IntType,
types.FloatType, types.BooleanType]:
self.msg_nocr('=> %s' % repr(return_value))
self.msg('(%s)' % repr(type(return_value)))
self.stop_reason = 'return'
self.__print_location_if_trace(frame, False)
if self.returnframe != None:
self.interaction(frame, None)
return
return
|