home *** CD-ROM | disk | FTP | other *** search
/ PC World 2002 May / PCWorld_2002-05_cd.bin / Software / TemaCD / activepython / ActivePython-2.1.1.msi / Python21_Lib_bdb.py < prev    next >
Encoding:
Python Source  |  2001-07-26  |  18.3 KB  |  566 lines
  1. """Debugger basics"""
  2.  
  3. import sys
  4. import os
  5. import types
  6.  
  7. __all__ = ["BdbQuit","Bdb","Breakpoint"]
  8.  
  9. BdbQuit = 'bdb.BdbQuit' # Exception to give up completely
  10.  
  11.  
  12. class Bdb:
  13.  
  14.     """Generic Python debugger base class.
  15.  
  16.     This class takes care of details of the trace facility;
  17.     a derived class should implement user interaction.
  18.     The standard debugger class (pdb.Pdb) is an example.
  19.     """
  20.  
  21.     def __init__(self):
  22.         self.breaks = {}
  23.         self.fncache = {}
  24.  
  25.     def canonic(self, filename):
  26.         canonic = self.fncache.get(filename)
  27.         if not canonic:
  28.             canonic = os.path.abspath(filename)
  29.             self.fncache[filename] = canonic
  30.         return canonic
  31.  
  32.     def reset(self):
  33.         import linecache
  34.         linecache.checkcache()
  35.         self.botframe = None
  36.         self.stopframe = None
  37.         self.returnframe = None
  38.         self.quitting = 0
  39.  
  40.     def trace_dispatch(self, frame, event, arg):
  41.         if self.quitting:
  42.             return # None
  43.         if event == 'line':
  44.             return self.dispatch_line(frame)
  45.         if event == 'call':
  46.             return self.dispatch_call(frame, arg)
  47.         if event == 'return':
  48.             return self.dispatch_return(frame, arg)
  49.         if event == 'exception':
  50.             return self.dispatch_exception(frame, arg)
  51.         print 'bdb.Bdb.dispatch: unknown debugging event:', `event`
  52.         return self.trace_dispatch
  53.  
  54.     def dispatch_line(self, frame):
  55.         if self.stop_here(frame) or self.break_here(frame):
  56.             self.user_line(frame)
  57.             if self.quitting: raise BdbQuit
  58.         return self.trace_dispatch
  59.  
  60.     def dispatch_call(self, frame, arg):
  61.         # XXX 'arg' is no longer used
  62.         if self.botframe is None:
  63.             # First call of dispatch since reset()
  64.             self.botframe = frame
  65.             return self.trace_dispatch
  66.         if not (self.stop_here(frame) or self.break_anywhere(frame)):
  67.             # No need to trace this function
  68.             return # None
  69.         self.user_call(frame, arg)
  70.         if self.quitting: raise BdbQuit
  71.         return self.trace_dispatch
  72.  
  73.     def dispatch_return(self, frame, arg):
  74.         if self.stop_here(frame) or frame == self.returnframe:
  75.             self.user_return(frame, arg)
  76.             if self.quitting: raise BdbQuit
  77.  
  78.     def dispatch_exception(self, frame, arg):
  79.         if self.stop_here(frame):
  80.             self.user_exception(frame, arg)
  81.             if self.quitting: raise BdbQuit
  82.         return self.trace_dispatch
  83.  
  84.     # Normally derived classes don't override the following
  85.     # methods, but they may if they want to redefine the
  86.     # definition of stopping and breakpoints.
  87.  
  88.     def stop_here(self, frame):
  89.         if self.stopframe is None:
  90.             return 1
  91.         if frame is self.stopframe:
  92.             return 1
  93.         while frame is not None and frame is not self.stopframe:
  94.             if frame is self.botframe:
  95.                 return 1
  96.             frame = frame.f_back
  97.         return 0
  98.  
  99.     def break_here(self, frame):
  100.         filename = self.canonic(frame.f_code.co_filename)
  101.         if not self.breaks.has_key(filename):
  102.             return 0
  103.         lineno = frame.f_lineno
  104.         if not lineno in self.breaks[filename]:
  105.             return 0
  106.         # flag says ok to delete temp. bp
  107.         (bp, flag) = effective(filename, lineno, frame)
  108.         if bp:
  109.             self.currentbp = bp.number
  110.             if (flag and bp.temporary):
  111.                 self.do_clear(str(bp.number))
  112.             return 1
  113.         else:
  114.             return 0
  115.  
  116.     def do_clear(self, arg):
  117.         raise NotImplementedError, "subclass of bdb must implement do_clear()"
  118.  
  119.     def break_anywhere(self, frame):
  120.         return self.breaks.has_key(
  121.             self.canonic(frame.f_code.co_filename))
  122.  
  123.     # Derived classes should override the user_* methods
  124.     # to gain control.
  125.  
  126.     def user_call(self, frame, argument_list):
  127.         """This method is called when there is the remote possibility
  128.         that we ever need to stop in this function."""
  129.         pass
  130.  
  131.     def user_line(self, frame):
  132.         """This method is called when we stop or break at this line."""
  133.         pass
  134.  
  135.     def user_return(self, frame, return_value):
  136.         """This method is called when a return trap is set here."""
  137.         pass
  138.  
  139.     def user_exception(self, frame, (exc_type, exc_value, exc_traceback)):
  140.         """This method is called if an exception occurs,
  141.         but only if we are to stop at or just below this level."""
  142.         pass
  143.  
  144.     # Derived classes and clients can call the following methods
  145.     # to affect the stepping state.
  146.  
  147.     def set_step(self):
  148.         """Stop after one line of code."""
  149.         self.stopframe = None
  150.         self.returnframe = None
  151.         self.quitting = 0
  152.  
  153.     def set_next(self, frame):
  154.         """Stop on the next line in or below the given frame."""
  155.         self.stopframe = frame
  156.         self.returnframe = None
  157.         self.quitting = 0
  158.  
  159.     def set_return(self, frame):
  160.         """Stop when returning from the given frame."""
  161.         self.stopframe = frame.f_back
  162.         self.returnframe = frame
  163.         self.quitting = 0
  164.  
  165.     def set_trace(self):
  166.         """Start debugging from here."""
  167.         try:
  168.             1 + ''
  169.         except:
  170.             frame = sys.exc_info()[2].tb_frame.f_back
  171.         self.reset()
  172.         while frame:
  173.             frame.f_trace = self.trace_dispatch
  174.             self.botframe = frame
  175.             frame = frame.f_back
  176.         self.set_step()
  177.         sys.settrace(self.trace_dispatch)
  178.  
  179.     def set_continue(self):
  180.         # Don't stop except at breakpoints or when finished
  181.         self.stopframe = self.botframe
  182.         self.returnframe = None
  183.         self.quitting = 0
  184.         if not self.breaks:
  185.             # no breakpoints; run without debugger overhead
  186.             sys.settrace(None)
  187.             try:
  188.                 1 + ''  # raise an exception
  189.             except:
  190.                 frame = sys.exc_info()[2].tb_frame.f_back
  191.             while frame and frame is not self.botframe:
  192.                 del frame.f_trace
  193.                 frame = frame.f_back
  194.  
  195.     def set_quit(self):
  196.         self.stopframe = self.botframe
  197.         self.returnframe = None
  198.         self.quitting = 1
  199.         sys.settrace(None)
  200.  
  201.     # Derived classes and clients can call the following methods
  202.     # to manipulate breakpoints.  These methods return an
  203.     # error message is something went wrong, None if all is well.
  204.     # Set_break prints out the breakpoint line and file:lineno.
  205.     # Call self.get_*break*() to see the breakpoints or better
  206.     # for bp in Breakpoint.bpbynumber: if bp: bp.bpprint().
  207.  
  208.     def set_break(self, filename, lineno, temporary=0, cond = None):
  209.         filename = self.canonic(filename)
  210.         import linecache # Import as late as possible
  211.         line = linecache.getline(filename, lineno)
  212.         if not line:
  213.             return 'Line %s:%d does not exist' % (filename,
  214.                                    lineno)
  215.         if not self.breaks.has_key(filename):
  216.             self.breaks[filename] = []
  217.         list = self.breaks[filename]
  218.         if not lineno in list:
  219.             list.append(lineno)
  220.         bp = Breakpoint(filename, lineno, temporary, cond)
  221.  
  222.     def clear_break(self, filename, lineno):
  223.         filename = self.canonic(filename)
  224.         if not self.breaks.has_key(filename):
  225.             return 'There are no breakpoints in %s' % filename
  226.         if lineno not in self.breaks[filename]:
  227.             return 'There is no breakpoint at %s:%d' % (filename,
  228.                                     lineno)
  229.         # If there's only one bp in the list for that file,line
  230.         # pair, then remove the breaks entry
  231.         for bp in Breakpoint.bplist[filename, lineno][:]:
  232.             bp.deleteMe()
  233.         if not Breakpoint.bplist.has_key((filename, lineno)):
  234.             self.breaks[filename].remove(lineno)
  235.         if not self.breaks[filename]:
  236.             del self.breaks[filename]
  237.  
  238.     def clear_bpbynumber(self, arg):
  239.         try:
  240.             number = int(arg)
  241.         except:
  242.             return 'Non-numeric breakpoint number (%s)' % arg
  243.         try:
  244.             bp = Breakpoint.bpbynumber[number]
  245.         except IndexError:
  246.             return 'Breakpoint number (%d) out of range' % number
  247.         if not bp:
  248.             return 'Breakpoint (%d) already deleted' % number
  249.         self.clear_break(bp.file, bp.line)
  250.  
  251.     def clear_all_file_breaks(self, filename):
  252.         filename = self.canonic(filename)
  253.         if not self.breaks.has_key(filename):
  254.             return 'There are no breakpoints in %s' % filename
  255.         for line in self.breaks[filename]:
  256.             blist = Breakpoint.bplist[filename, line]
  257.             for bp in blist:
  258.                 bp.deleteMe()
  259.         del self.breaks[filename]
  260.  
  261.     def clear_all_breaks(self):
  262.         if not self.breaks:
  263.             return 'There are no breakpoints'
  264.         for bp in Breakpoint.bpbynumber:
  265.             if bp:
  266.                 bp.deleteMe()
  267.         self.breaks = {}
  268.  
  269.     def get_break(self, filename, lineno):
  270.         filename = self.canonic(filename)
  271.         return self.breaks.has_key(filename) and \
  272.             lineno in self.breaks[filename]
  273.  
  274.     def get_breaks(self, filename, lineno):
  275.         filename = self.canonic(filename)
  276.         return self.breaks.has_key(filename) and \
  277.             lineno in self.breaks[filename] and \
  278.             Breakpoint.bplist[filename, lineno] or []
  279.  
  280.     def get_file_breaks(self, filename):
  281.         filename = self.canonic(filename)
  282.         if self.breaks.has_key(filename):
  283.             return self.breaks[filename]
  284.         else:
  285.             return []
  286.  
  287.     def get_all_breaks(self):
  288.         return self.breaks
  289.  
  290.     # Derived classes and clients can call the following method
  291.     # to get a data structure representing a stack trace.
  292.  
  293.     def get_stack(self, f, t):
  294.         stack = []
  295.         if t and t.tb_frame is f:
  296.             t = t.tb_next
  297.         while f is not None:
  298.             stack.append((f, f.f_lineno))
  299.             if f is self.botframe:
  300.                 break
  301.             f = f.f_back
  302.         stack.reverse()
  303.         i = max(0, len(stack) - 1)
  304.         while t is not None:
  305.             stack.append((t.tb_frame, t.tb_lineno))
  306.             t = t.tb_next
  307.         return stack, i
  308.  
  309.     #
  310.  
  311.     def format_stack_entry(self, frame_lineno, lprefix=': '):
  312.         import linecache, repr
  313.         frame, lineno = frame_lineno
  314.         filename = self.canonic(frame.f_code.co_filename)
  315.         s = filename + '(' + `lineno` + ')'
  316.         if frame.f_code.co_name:
  317.             s = s + frame.f_code.co_name
  318.         else:
  319.             s = s + "<lambda>"
  320.         if frame.f_locals.has_key('__args__'):
  321.             args = frame.f_locals['__args__']
  322.         else:
  323.             args = None
  324.         if args:
  325.             s = s + repr.repr(args)
  326.         else:
  327.             s = s + '()'
  328.         if frame.f_locals.has_key('__return__'):
  329.             rv = frame.f_locals['__return__']
  330.             s = s + '->'
  331.             s = s + repr.repr(rv)
  332.         line = linecache.getline(filename, lineno)
  333.         if line: s = s + lprefix + line.strip()
  334.         return s
  335.  
  336.     # The following two methods can be called by clients to use
  337.     # a debugger to debug a statement, given as a string.
  338.  
  339.     def run(self, cmd, globals=None, locals=None):
  340.         if globals is None:
  341.             import __main__
  342.             globals = __main__.__dict__
  343.         if locals is None:
  344.             locals = globals
  345.         self.reset()
  346.         sys.settrace(self.trace_dispatch)
  347.         if not isinstance(cmd, types.CodeType):
  348.             cmd = cmd+'\n'
  349.         try:
  350.             try:
  351.                 exec cmd in globals, locals
  352.             except BdbQuit:
  353.                 pass
  354.         finally:
  355.             self.quitting = 1
  356.             sys.settrace(None)
  357.  
  358.     def runeval(self, expr, globals=None, locals=None):
  359.         if globals is None:
  360.             import __main__
  361.             globals = __main__.__dict__
  362.         if locals is None:
  363.             locals = globals
  364.         self.reset()
  365.         sys.settrace(self.trace_dispatch)
  366.         if not isinstance(expr, types.CodeType):
  367.             expr = expr+'\n'
  368.         try:
  369.             try:
  370.                 return eval(expr, globals, locals)
  371.             except BdbQuit:
  372.                 pass
  373.         finally:
  374.             self.quitting = 1
  375.             sys.settrace(None)
  376.  
  377.     def runctx(self, cmd, globals, locals):
  378.         # B/W compatibility
  379.         self.run(cmd, globals, locals)
  380.  
  381.     # This method is more useful to debug a single function call.
  382.  
  383.     def runcall(self, func, *args):
  384.         self.reset()
  385.         sys.settrace(self.trace_dispatch)
  386.         res = None
  387.         try:
  388.             try:
  389.                 res = apply(func, args)
  390.             except BdbQuit:
  391.                 pass
  392.         finally:
  393.             self.quitting = 1
  394.             sys.settrace(None)
  395.         return res
  396.  
  397.  
  398. def set_trace():
  399.     Bdb().set_trace()
  400.  
  401.  
  402. class Breakpoint:
  403.  
  404.     """Breakpoint class
  405.  
  406.     Implements temporary breakpoints, ignore counts, disabling and
  407.     (re)-enabling, and conditionals.
  408.  
  409.     Breakpoints are indexed by number through bpbynumber and by
  410.     the file,line tuple using bplist.  The former points to a
  411.     single instance of class Breakpoint.  The latter points to a
  412.     list of such instances since there may be more than one
  413.     breakpoint per line.
  414.  
  415.     """
  416.  
  417.     # XXX Keeping state in the class is a mistake -- this means
  418.     # you cannot have more than one active Bdb instance.
  419.  
  420.     next = 1        # Next bp to be assigned
  421.     bplist = {}     # indexed by (file, lineno) tuple
  422.     bpbynumber = [None] # Each entry is None or an instance of Bpt
  423.                 # index 0 is unused, except for marking an
  424.                 # effective break .... see effective()
  425.  
  426.     def __init__(self, file, line, temporary=0, cond = None):
  427.         self.file = file    # This better be in canonical form!
  428.         self.line = line
  429.         self.temporary = temporary
  430.         self.cond = cond
  431.         self.enabled = 1
  432.         self.ignore = 0
  433.         self.hits = 0
  434.         self.number = Breakpoint.next
  435.         Breakpoint.next = Breakpoint.next + 1
  436.         # Build the two lists
  437.         self.bpbynumber.append(self)
  438.         if self.bplist.has_key((file, line)):
  439.             self.bplist[file, line].append(self)
  440.         else:
  441.             self.bplist[file, line] = [self]
  442.  
  443.  
  444.     def deleteMe(self):
  445.         index = (self.file, self.line)
  446.         self.bpbynumber[self.number] = None   # No longer in list
  447.         self.bplist[index].remove(self)
  448.         if not self.bplist[index]:
  449.             # No more bp for this f:l combo
  450.             del self.bplist[index]
  451.  
  452.     def enable(self):
  453.         self.enabled = 1
  454.  
  455.     def disable(self):
  456.         self.enabled = 0
  457.  
  458.     def bpprint(self):
  459.         if self.temporary:
  460.             disp = 'del  '
  461.         else:
  462.             disp = 'keep '
  463.         if self.enabled:
  464.             disp = disp + 'yes'
  465.         else:
  466.             disp = disp + 'no '
  467.         print '%-4dbreakpoint    %s at %s:%d' % (self.number, disp,
  468.                              self.file, self.line)
  469.         if self.cond:
  470.             print '\tstop only if %s' % (self.cond,)
  471.         if self.ignore:
  472.             print '\tignore next %d hits' % (self.ignore)
  473.         if (self.hits):
  474.             if (self.hits > 1): ss = 's'
  475.             else: ss = ''
  476.             print ('\tbreakpoint already hit %d time%s' %
  477.                    (self.hits, ss))
  478.  
  479. # -----------end of Breakpoint class----------
  480.  
  481. # Determines if there is an effective (active) breakpoint at this
  482. # line of code.  Returns breakpoint number or 0 if none
  483. def effective(file, line, frame):
  484.     """Determine which breakpoint for this file:line is to be acted upon.
  485.  
  486.     Called only if we know there is a bpt at this
  487.     location.  Returns breakpoint that was triggered and a flag
  488.     that indicates if it is ok to delete a temporary bp.
  489.  
  490.     """
  491.     possibles = Breakpoint.bplist[file,line]
  492.     for i in range(0, len(possibles)):
  493.         b = possibles[i]
  494.         if b.enabled == 0:
  495.             continue
  496.         # Count every hit when bp is enabled
  497.         b.hits = b.hits + 1
  498.         if not b.cond:
  499.             # If unconditional, and ignoring,
  500.             # go on to next, else break
  501.             if b.ignore > 0:
  502.                 b.ignore = b.ignore -1
  503.                 continue
  504.             else:
  505.                 # breakpoint and marker that's ok
  506.                 # to delete if temporary
  507.                 return (b,1)
  508.         else:
  509.             # Conditional bp.
  510.             # Ignore count applies only to those bpt hits where the
  511.             # condition evaluates to true.
  512.             try:
  513.                 val = eval(b.cond, frame.f_globals,
  514.                        frame.f_locals)
  515.                 if val:
  516.                     if b.ignore > 0:
  517.                         b.ignore = b.ignore -1
  518.                         # continue
  519.                     else:
  520.                         return (b,1)
  521.                 # else:
  522.                 #   continue
  523.             except:
  524.                 # if eval fails, most conservative
  525.                 # thing is to stop on breakpoint
  526.                 # regardless of ignore count.
  527.                 # Don't delete temporary,
  528.                 # as another hint to user.
  529.                 return (b,0)
  530.     return (None, None)
  531.  
  532. # -------------------- testing --------------------
  533.  
  534. class Tdb(Bdb):
  535.     def user_call(self, frame, args):
  536.         name = frame.f_code.co_name
  537.         if not name: name = '???'
  538.         print '+++ call', name, args
  539.     def user_line(self, frame):
  540.         import linecache
  541.         name = frame.f_code.co_name
  542.         if not name: name = '???'
  543.         fn = self.canonic(frame.f_code.co_filename)
  544.         line = linecache.getline(fn, frame.f_lineno)
  545.         print '+++', fn, frame.f_lineno, name, ':', line.strip()
  546.     def user_return(self, frame, retval):
  547.         print '+++ return', retval
  548.     def user_exception(self, frame, exc_stuff):
  549.         print '+++ exception', exc_stuff
  550.         self.set_continue()
  551.  
  552. def foo(n):
  553.     print 'foo(', n, ')'
  554.     x = bar(n*10)
  555.     print 'bar returned', x
  556.  
  557. def bar(a):
  558.     print 'bar(', a, ')'
  559.     return a/2
  560.  
  561. def test():
  562.     t = Tdb()
  563.     t.run('import bdb; bdb.foo(10)')
  564.  
  565. # end
  566.