# (See pdb.doc for documentation.)
# Create a custom safe Repr instance and increase its maxstring.
# The default of 30 truncates error messages too easily.
__all__
= ["run", "pm", "Pdb", "runeval", "runctx", "runcall", "set_trace",
def find_function(funcname
, filename
):
cre
= re
.compile(r
'def\s+%s\s*[(]' % funcname
)
# consumer of this info expects the first line to be 1
answer
= funcname
, filename
, lineno
# Interaction prompt line will separate file and call info from code
# text using value of line_prefix string. A newline and arrow may
# be to your liking. You can set it once pdb is imported using the
# command "pdb.line_prefix = '\n% '".
# line_prefix = ': ' # Use this to get the old situation back
line_prefix
= '\n-> ' # Probably a better default
class Pdb(bdb
.Bdb
, cmd
.Cmd
):
self
._wait
_for
_mainpyfile
= 0
# Try to load readline if it exists
# Read $HOME/.pdbrc and ./.pdbrc
envHome
= os
.environ
['HOME']
rcFile
= open(os
.path
.join(envHome
, ".pdbrc"))
for line
in rcFile
.readlines():
self
.rcLines
.append(line
)
for line
in rcFile
.readlines():
self
.rcLines
.append(line
)
self
.stack
, self
.curindex
= self
.get_stack(f
, t
)
self
.curframe
= self
.stack
[self
.curindex
][0]
# Can be executed earlier than 'setup' if desired
# Make local copy because of recursion
if len(line
) > 0 and line
[0] != '#':
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."""
if self
._wait
_for
_mainpyfile
:
if self
.stop_here(frame
):
self
.interaction(frame
, None)
def user_line(self
, frame
):
"""This function is called when we stop or break at this line."""
if self
._wait
_for
_mainpyfile
:
if (self
.mainpyfile
!= self
.canonic(frame
.f_code
.co_filename
)
self
._wait
_for
_mainpyfile
= 0
self
.interaction(frame
, None)
def user_return(self
, frame
, return_value
):
"""This function is called when a return trap is set here."""
frame
.f_locals
['__return__'] = return_value
self
.interaction(frame
, None)
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."""
frame
.f_locals
['__exception__'] = exc_type
, exc_value
if type(exc_type
) == type(''):
else: exc_type_name
= exc_type
.__name
__
print exc_type_name
+ ':', _saferepr(exc_value
)
self
.interaction(frame
, exc_traceback
)
# General interaction function
def interaction(self
, frame
, traceback
):
self
.setup(frame
, traceback
)
self
.print_stack_entry(self
.stack
[self
.curindex
])
if line
[:1] == '!': line
= line
[1:]
locals = self
.curframe
.f_locals
globals = self
.curframe
.f_globals
code
= compile(line
+ '\n', '<stdin>', 'single')
exec code
in globals, locals
t
, v
= sys
.exc_info()[:2]
else: exc_type_name
= t
.__name
__
print '***', exc_type_name
+ ':', v
"""Handle alias expansion and ';;' separator."""
while args
[0] in self
.aliases
:
line
= self
.aliases
[args
[0]]
line
= line
.replace("%" + str(ii
),
line
= line
.replace("%*", ' '.join(args
[1:]))
# split into ';;' separated commands
# unless it's an alias command
# queue up everything after marker
next
= line
[marker
+2:].lstrip()
self
.cmdqueue
.append(next
)
line
= line
[:marker
].rstrip()
# Command definitions, called by cmdloop()
# The argument is the remaining string on the command line
# Return true to exit from the command loop
def do_break(self
, arg
, temporary
= 0):
# break [ ([filename:]lineno | function) [, "condition"] ]
if self
.breaks
: # There's at least one
print "Num Type Disp Enb Where"
for bp
in bdb
.Breakpoint
.bpbynumber
:
# parse arguments; comma has lowest precedence
# and cannot occur in filename
# parse stuff after comma: "condition"
cond
= arg
[comma
+1:].lstrip()
arg
= arg
[:comma
].rstrip()
# parse stuff before comma: [filename:]lineno | function
filename
= arg
[:colon
].rstrip()
f
= self
.lookupmodule(filename
)
print '*** ', repr(filename
),
print 'not found from sys.path'
arg
= arg
[colon
+1:].lstrip()
print '*** Bad lineno:', arg
# no colon; can be lineno or function
if hasattr(func
, 'im_func'):
#use co_name to identify the bkpt (function names
#could be aliased, but co_name is invariant)
lineno
= code
.co_firstlineno
filename
= code
.co_filename
(ok
, filename
, ln
) = self
.lineinfo(arg
)
print '*** The specified object',
print 'is not a function'
print ('or was not found '
funcname
= ok
# ok contains a function name
filename
= self
.defaultFile()
# Check for reasonable breakpoint
line
= self
.checkline(filename
, lineno
)
# now set the break point
err
= self
.set_break(filename
, line
, temporary
, cond
, funcname
)
bp
= self
.get_breaks(filename
, line
)[-1]
print "Breakpoint %d at %s:%d" % (bp
.number
,
# To be overridden in derived debuggers
"""Produce a reasonable default."""
filename
= self
.curframe
.f_code
.co_filename
if filename
== '<string>' and self
.mainpyfile
:
filename
= self
.mainpyfile
def do_tbreak(self
, arg
):
def lineinfo(self
, identifier
):
failed
= (None, None, None)
# Input is identifier, may be in single quotes
idstring
= identifier
.split("'")
if id == '': return failed
# Protection for derived debuggers
# Best first guess at file to look at
fname
= self
.defaultFile()
# First is module, second is method/class
f
= self
.lookupmodule(parts
[0])
answer
= find_function(item
, fname
)
def checkline(self
, filename
, lineno
):
"""Check whether specified line seems to be executable.
Return `lineno` if it is, 0 if not (e.g. a docstring, comment, blank
line or EOF). Warning: testing is not comprehensive.
line
= linecache
.getline(filename
, lineno
)
# Don't allow setting breakpoint at a blank line
if (not line
or (line
[0] == '#') or
(line
[:3] == '"""') or line
[:3] == "'''"):
print '*** Blank or comment'
def do_enable(self
, arg
):
print 'Breakpoint index %r is not a number' % i
if not (0 <= i
< len(bdb
.Breakpoint
.bpbynumber
)):
print 'No breakpoint numbered', i
bp
= bdb
.Breakpoint
.bpbynumber
[i
]
def do_disable(self
, arg
):
print 'Breakpoint index %r is not a number' % i
if not (0 <= i
< len(bdb
.Breakpoint
.bpbynumber
)):
print 'No breakpoint numbered', i
bp
= bdb
.Breakpoint
.bpbynumber
[i
]
def do_condition(self
, arg
):
# arg is breakpoint number and condition
bpnum
= int(args
[0].strip())
bp
= bdb
.Breakpoint
.bpbynumber
[bpnum
]
print 'Breakpoint', bpnum
,
print 'is now unconditional.'
"""arg is bp number followed by ignore count."""
bpnum
= int(args
[0].strip())
count
= int(args
[1].strip())
bp
= bdb
.Breakpoint
.bpbynumber
[bpnum
]
reply
= 'Will ignore next '
reply
= reply
+ '%d crossings' % count
reply
= reply
+ '1 crossing'
print reply
+ ' of breakpoint %d.' % bpnum
print 'Will stop next time breakpoint',
print bpnum
, 'is reached.'
"""Three possibilities, tried in this order:
clear -> clear all breaks, ask for confirmation
clear file:lineno -> clear all breaks at file:lineno
clear bpno bpno ... -> clear breakpoints by number"""
reply
= raw_input('Clear all breaks? ')
reply
= reply
.strip().lower()
if reply
in ('y', 'yes'):
# Make sure it works for "clear C:\foo\bar.py:12"
err
= "Invalid line number (%s)" % arg
err
= self
.clear_break(filename
, lineno
)
if not (0 <= i
< len(bdb
.Breakpoint
.bpbynumber
)):
print 'No breakpoint numbered', i
err
= self
.clear_bpbynumber(i
)
print 'Deleted breakpoint', i
do_cl
= do_clear
# 'c' is already an abbreviation for 'continue'
self
.curindex
= self
.curindex
- 1
self
.curframe
= self
.stack
[self
.curindex
][0]
self
.print_stack_entry(self
.stack
[self
.curindex
])
if self
.curindex
+ 1 == len(self
.stack
):
self
.curindex
= self
.curindex
+ 1
self
.curframe
= self
.stack
[self
.curindex
][0]
self
.print_stack_entry(self
.stack
[self
.curindex
])
self
.set_next(self
.curframe
)
def do_return(self
, arg
):
self
.set_return(self
.curframe
)
def do_continue(self
, arg
):
do_c
= do_cont
= do_continue
if self
.curindex
+ 1 != len(self
.stack
):
print "*** You can only jump within the bottom frame"
print "*** The 'jump' command requires a line number."
# Do the jump, fix up our copy of the stack, and display the
self
.curframe
.f_lineno
= arg
self
.stack
[self
.curindex
] = self
.stack
[self
.curindex
][0], arg
self
.print_stack_entry(self
.stack
[self
.curindex
])
print '*** Jump failed:', e
globals = self
.curframe
.f_globals
locals = self
.curframe
.f_locals
p
.prompt
= "(%s) " % self
.prompt
.strip()
print "ENTERING RECURSIVE DEBUGGER"
sys
.call_tracing(p
.run
, (arg
, globals, locals))
print "LEAVING RECURSIVE DEBUGGER"
sys
.settrace(self
.trace_dispatch
)
self
._user
_requested
_quit
= 1
self
._user
_requested
_quit
= 1
if co
.co_flags
& 4: n
= n
+1
if co
.co_flags
& 8: n
= n
+1
if name
in dict: print dict[name
]
else: print "*** undefined ***"
def do_retval(self
, arg
):
if '__return__' in self
.curframe
.f_locals
:
print self
.curframe
.f_locals
['__return__']
print '*** Not yet returned!'
return eval(arg
, self
.curframe
.f_globals
,
t
, v
= sys
.exc_info()[:2]
else: exc_type_name
= t
.__name
__
print '***', exc_type_name
+ ':', repr(v
)
print repr(self
._getval
(arg
))
pprint
.pprint(self
._getval
(arg
))
first
= max(1, int(x
) - 5)
print '*** Error in argument:', repr(arg
)
elif self
.lineno
is None:
first
= max(1, self
.curframe
.f_lineno
- 5)
filename
= self
.curframe
.f_code
.co_filename
breaklist
= self
.get_file_breaks(filename
)
for lineno
in range(first
, last
+1):
line
= linecache
.getline(filename
, lineno
)
s
= repr(lineno
).rjust(3)
if len(s
) < 4: s
= s
+ ' '
if lineno
in breaklist
: s
= s
+ 'B'
if lineno
== self
.curframe
.f_lineno
:
except KeyboardInterrupt:
def do_whatis(self
, arg
):
value
= eval(arg
, self
.curframe
.f_globals
,
t
, v
= sys
.exc_info()[:2]
else: exc_type_name
= t
.__name
__
print '***', exc_type_name
+ ':', repr(v
)
try: code
= value
.func_code
print 'Function', code
.co_name
# Is it an instance method?
try: code
= value
.im_func
.func_code
print 'Method', code
.co_name
keys
= self
.aliases
.keys()
print "%s = %s" % (alias
, self
.aliases
[alias
])
if args
[0] in self
.aliases
and len(args
) == 1:
print "%s = %s" % (args
[0], self
.aliases
[args
[0]])
self
.aliases
[args
[0]] = ' '.join(args
[1:])
def do_unalias(self
, arg
):
if len(args
) == 0: return
if args
[0] in self
.aliases
:
del self
.aliases
[args
[0]]
# Print a traceback starting at the top stack frame.
# The most recently entered frame is printed last;
# this is different from dbx and gdb, but consistent with
# the Python interpreter's stack trace.
# It is also consistent with the up/down commands (which are
# compatible with dbx and gdb: up moves towards 'main()'
# and down moves towards the most recent stack frame).
def print_stack_trace(self
):
for frame_lineno
in self
.stack
:
self
.print_stack_entry(frame_lineno
)
except KeyboardInterrupt:
def print_stack_entry(self
, frame_lineno
, prompt_prefix
=line_prefix
):
frame
, lineno
= frame_lineno
if frame
is self
.curframe
:
print self
.format_stack_entry(frame_lineno
, prompt_prefix
)
# Help methods (derived from pdb.doc)
Without argument, print the list of available commands.
With a command name as argument, print help about that command
"help pdb" pipes the full documentation file to the $PAGER
"help exec" gives help on the ! command"""
Print a stack trace, with the most recent frame at the bottom.
An arrow indicates the "current frame", which determines the
context of most commands. 'bt' is an alias for this command."""
Move the current frame one level down in the stack trace
Move the current frame one level up in the stack trace
print """b(reak) ([file:]lineno | function) [, condition]
With a line number argument, set a break there in the current
file. With a function name, set a break at first executable line
of that function. Without argument, list all breaks. If a second
argument is present, it is a string specifying an expression
which must evaluate to true before the breakpoint is honored.
The line number may be prefixed with a filename and a colon,
to specify a breakpoint in another file (probably one that
hasn't been loaded yet). The file is searched for on sys.path;
the .py suffix may be omitted."""
print "cl(ear) filename:lineno"
print """cl(ear) [bpnumber [bpnumber...]]
With a space separated list of breakpoint numbers, clear
those breakpoints. Without argument, clear all breaks (but
first ask confirmation). With a filename:lineno argument,
clear all breaks at that line in that file.
Note that the argument is different from previous versions of
the debugger (in python distributions 1.5.1 and before) where
a linenumber was used instead of either filename:lineno or
print """tbreak same arguments as break, but breakpoint is
removed when first hit."""
print """enable bpnumber [bpnumber ...]
Enables the breakpoints given as a space separated list of
print """disable bpnumber [bpnumber ...]
Disables the breakpoints given as a space separated list of
print """ignore bpnumber count
Sets the ignore count for the given breakpoint number. A breakpoint
becomes active when the ignore count is zero. When non-zero, the
count is decremented each time the breakpoint is reached and the
breakpoint is not disabled and any associated condition evaluates
def help_condition(self
):
print """condition bpnumber str_condition
str_condition is a string specifying an expression which
must evaluate to true before the breakpoint is honored.
If str_condition is absent, any existing condition is removed;
i.e., the breakpoint is made unconditional."""
Execute the current line, stop at the first possible occasion
(either in a function that is called or in the current function)."""
Continue execution until the next line in the current function
is reached or it returns."""
Continue execution until the current function returns."""
Continue execution, only stop when a breakpoint is encountered."""
Set the next line that will be executed."""
Enter a recursive debugger that steps through the code argument
(which is an arbitrary expression or statement to be executed
in the current environment)."""
print """l(ist) [first [,last]]
List source code for the current file.
Without arguments, list 11 lines around the current line
or continue the previous listing.
With one argument, list 11 lines starting at that line.
With two arguments, list the given range;
if the second argument is less than the first, it is a count."""
Print the arguments of the current function."""
Print the value of the expression."""
Pretty-print the value of the expression."""
Execute the (one-line) statement in the context of
The exclamation point can be omitted unless the first word
of the statement resembles a debugger command.
To assign to a global variable you must always prefix the
command with a 'global' command, e.g.:
(Pdb) global list_options; list_options = ['-l']
print """q(uit) or exit - Quit from the debugger.
The program being executed is aborted."""
Prints the type of the argument."""
Handles the receipt of EOF as a command."""
print """alias [name [command [parameter parameter ...] ]]
Creates an alias called 'name' the executes 'command'. The command
must *not* be enclosed in quotes. Replaceable parameters are
indicated by %1, %2, and so on, while %* is replaced by all the
parameters. If no command is given, the current alias for name
is shown. If no name is given, all aliases are listed.
Aliases may be nested and can contain anything that can be
legally typed at the pdb prompt. Note! You *can* override
internal pdb commands with aliases! Those internal commands
are then hidden until the alias is removed. Aliasing is recursively
applied to the first word of the command line; all other words
in the line are left alone.
Some useful aliases (especially when placed in the .pdbrc file) are:
#Print instance variables (usage "pi classInst")
alias pi for k in %1.__dict__.keys(): print "%1.",k,"=",%1.__dict__[k]
#Print instance variables in self
Deletes the specified alias."""
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
):
f
= os
.path
.join(sys
.path
[0], filename
)
if os
.path
.exists(f
) and self
.canonic(f
) == self
.mainpyfile
:
root
, ext
= os
.path
.splitext(filename
)
filename
= filename
+ '.py'
if os
.path
.isabs(filename
):
while os
.path
.islink(dirname
):
dirname
= os
.readlink(dirname
)
fullname
= os
.path
.join(dirname
, filename
)
if os
.path
.exists(fullname
):
def _runscript(self
, filename
):
# Start with fresh empty copy of globals and locals and tell the script
# that it's being run as __main__ to avoid scripts being able to access
globals_
= {"__name__" : "__main__"}
# When bdb sets tracing, a number of call and line events happens
# BEFORE debugger even reaches user's code (and the exact sequence of
# events depends on python version). So we take special measures to
# avoid stopping before we reach the main script (see user_line and
# user_call for details).
self
._wait
_for
_mainpyfile
= 1
self
.mainpyfile
= self
.canonic(filename
)
self
._user
_requested
_quit
= 0
statement
= 'execfile( "%s")' % filename
self
.run(statement
, globals=globals_
, locals=locals_
)
def run(statement
, globals=None, locals=None):
Pdb().run(statement
, globals, locals)
def runeval(expression
, globals=None, locals=None):
return Pdb().runeval(expression
, globals, locals)
def runctx(statement
, globals, locals):
run(statement
, globals, locals)
def runcall(*args
, **kwds
):
return Pdb().runcall(*args
, **kwds
)
Pdb().set_trace(sys
._getframe
().f_back
)
while t
.tb_next
is not None:
p
.interaction(t
.tb_frame
, t
)
post_mortem(sys
.last_traceback
)
# Main program for testing
TESTCMD
= 'import x; x.main()'
fullname
= os
.path
.join(dirname
, 'pdb.doc')
if os
.path
.exists(fullname
):
sts
= os
.system('${PAGER-more} '+fullname
)
if sts
: print '*** Pager exit status:', sts
print 'Sorry, can\'t find the help file "pdb.doc"',
print 'along the Python search path'
print "usage: pdb.py scriptfile [arg] ..."
mainpyfile
= sys
.argv
[1] # Get script filename
if not os
.path
.exists(mainpyfile
):
print 'Error:', mainpyfile
, 'does not exist'
del sys
.argv
[0] # Hide "pdb.py" from argument list
# Replace pdb's dir with script's dir in front of module search path.
sys
.path
[0] = os
.path
.dirname(mainpyfile
)
# Note on saving/restoring sys.argv: it's a good idea when sys.argv was
# modified by the script being debugged. It's a bad idea when it was
# changed by the user from the command line. The best approach would be to
# have a "restart" command which would allow explicit specification of
# command line arguments.
pdb
._runscript
(mainpyfile
)
if pdb
._user
_requested
_quit
:
print "The program finished and will be restarted"
# In most cases SystemExit does not warrant a post-mortem session.
print "The program exited via sys.exit(). Exit status: ",
print "Uncaught exception. Entering post mortem debugging"
print "Running 'cont' or 'step' will restart the program"
while t
.tb_next
is not None:
pdb
.interaction(t
.tb_frame
,t
)
print "Post mortem debugger finished. The "+mainpyfile
+" will be restarted"
# When invoked as main program, invoke the debugger on a script