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