Lib/idlelib/Debugger.py

   1 import os
   2 import bdb
   3 import types
   4 from Tkinter import *
   5 from WindowList import ListedToplevel
   6 from ScrolledList import ScrolledList
   7
   8
   9 class Idb(bdb.Bdb):
  10
  11     def __init__(self, gui):
  12         self.gui = gui
  13         bdb.Bdb.__init__(self)
  14
  15     def user_line(self, frame):
  16         # get the currently executing function
  17         ##print>>sys.__stderr__, "*function: ", frame.f_code.co_name
  18         ##print>>sys.__stderr__, "*file: ", frame.f_code.co_filename
  19         ##print>>sys.__stderr__, "*line number: ", frame.f_code.co_firstlineno
  20         co_filename = frame.f_code.co_filename
  21         co_name = frame.f_code.co_name
  22         try:
  23             func = frame.f_locals[co_name]
  24             if getattr(func, "DebuggerStepThrough", 0):
  25                 print "XXXX DEBUGGER STEPPING THROUGH"
  26                 self.set_step()
  27                 return
  28         except:
  29             pass
  30         if co_filename in ('rpc.py', '<string>'):
  31             self.set_step()
  32             return
  33         if co_filename.endswith('threading.py'):
  34             self.set_step()
  35             return
  36         message = self.__frame2message(frame)
  37         self.gui.interaction(message, frame)
  38
  39     def user_exception(self, frame, info):
  40         message = self.__frame2message(frame)
  41         self.gui.interaction(message, frame, info)
  42
  43     def __frame2message(self, frame):
  44         code = frame.f_code
  45         filename = code.co_filename
  46         lineno = frame.f_lineno
  47         basename = os.path.basename(filename)
  48         message = "%s:%s" % (basename, lineno)
  49         if code.co_name != "?":
  50             message = "%s: %s()" % (message, code.co_name)
  51         return message
  52
  53
  54 class Debugger:
  55
  56     vstack = vsource = vlocals = vglobals = None
  57
  58     def __init__(self, pyshell, idb=None):
  59         if idb is None:
  60             idb = Idb(self)
  61         self.pyshell = pyshell
  62         self.idb = idb
  63         self.frame = None
  64         self.make_gui()
  65         self.interacting = 0
  66
  67     def run(self, *args):
  68         try:
  69             self.interacting = 1
  70             return self.idb.run(*args)
  71         finally:
  72             self.interacting = 0
  73
  74     def close(self, event=None):
  75         if self.interacting:
  76             self.top.bell()
  77             return
  78         if self.stackviewer:
  79             self.stackviewer.close(); self.stackviewer = None
  80         # Remove all EditWindow BREAK tags when closing debugger:
  81         edit_windows = self.pyshell.flist.inversedict.keys()
  82         for window in edit_windows:
  83             window.text.tag_remove("BREAK", 1.0, END)
  84             window.break_set = False
  85         # Clean up pyshell if user clicked debugger control close widget.
  86         # (Causes a harmless extra cycle through close_debugger() if user
  87         # toggled debugger from pyshell Debug menu)
  88         self.pyshell.close_debugger()
  89         # Now close the debugger control window....
  90         self.top.destroy()
  91
  92     def make_gui(self):
  93         pyshell = self.pyshell
  94         self.flist = pyshell.flist
  95         self.root = root = pyshell.root
  96         self.top = top =ListedToplevel(root)
  97         self.top.wm_title("Debug Control")
  98         self.top.wm_iconname("Debug")
  99         top.wm_protocol("WM_DELETE_WINDOW", self.close)
 100         self.top.bind("<Escape>", self.close)
 101         #
 102         self.bframe = bframe = Frame(top)
 103         self.bframe.pack(anchor="w")
 104         self.buttons = bl = []
 105         #
 106         self.bcont = b = Button(bframe, text="Go", command=self.cont)
 107         bl.append(b)
 108         self.bstep = b = Button(bframe, text="Step", command=self.step)
 109         bl.append(b)
 110         self.bnext = b = Button(bframe, text="Over", command=self.next)
 111         bl.append(b)
 112         self.bret = b = Button(bframe, text="Out", command=self.ret)
 113         bl.append(b)
 114         self.bret = b = Button(bframe, text="Quit", command=self.quit)
 115         bl.append(b)
 116         #
 117         for b in bl:
 118             b.configure(state="disabled")
 119             b.pack(side="left")
 120         #
 121         self.cframe = cframe = Frame(bframe)
 122         self.cframe.pack(side="left")
 123         #
 124         if not self.vstack:
 125             self.__class__.vstack = BooleanVar(top)
 126             self.vstack.set(1)
 127         self.bstack = Checkbutton(cframe,
 128             text="Stack", command=self.show_stack, variable=self.vstack)
 129         self.bstack.grid(row=0, column=0)
 130         if not self.vsource:
 131             self.__class__.vsource = BooleanVar(top)
 132             ##self.vsource.set(1)
 133         self.bsource = Checkbutton(cframe,
 134             text="Source", command=self.show_source, variable=self.vsource)
 135         self.bsource.grid(row=0, column=1)
 136         if not self.vlocals:
 137             self.__class__.vlocals = BooleanVar(top)
 138             self.vlocals.set(1)
 139         self.blocals = Checkbutton(cframe,
 140             text="Locals", command=self.show_locals, variable=self.vlocals)
 141         self.blocals.grid(row=1, column=0)
 142         if not self.vglobals:
 143             self.__class__.vglobals = BooleanVar(top)
 144             ##self.vglobals.set(1)
 145         self.bglobals = Checkbutton(cframe,
 146             text="Globals", command=self.show_globals, variable=self.vglobals)
 147         self.bglobals.grid(row=1, column=1)
 148         #
 149         self.status = Label(top, anchor="w")
 150         self.status.pack(anchor="w")
 151         self.error = Label(top, anchor="w")
 152         self.error.pack(anchor="w", fill="x")
 153         self.errorbg = self.error.cget("background")
 154         #
 155         self.fstack = Frame(top, height=1)
 156         self.fstack.pack(expand=1, fill="both")
 157         self.flocals = Frame(top)
 158         self.flocals.pack(expand=1, fill="both")
 159         self.fglobals = Frame(top, height=1)
 160         self.fglobals.pack(expand=1, fill="both")
 161         #
 162         if self.vstack.get():
 163             self.show_stack()
 164         if self.vlocals.get():
 165             self.show_locals()
 166         if self.vglobals.get():
 167             self.show_globals()
 168
 169
 170     def interaction(self, message, frame, info=None):
 171         self.frame = frame
 172         self.status.configure(text=message)
 173         #
 174         if info:
 175             type, value, tb = info
 176             try:
 177                 m1 = type.__name__
 178             except AttributeError:
 179                 m1 = "%s" % str(type)
 180             if value is not None:
 181                 try:
 182                     m1 = "%s: %s" % (m1, str(value))
 183                 except:
 184                     pass
 185             bg = "yellow"
 186         else:
 187             m1 = ""
 188             tb = None
 189             bg = self.errorbg
 190         self.error.configure(text=m1, background=bg)
 191         #
 192         sv = self.stackviewer
 193         if sv:
 194             stack, i = self.idb.get_stack(self.frame, tb)
 195             sv.load_stack(stack, i)
 196         #
 197         self.show_variables(1)
 198         #
 199         if self.vsource.get():
 200             self.sync_source_line()
 201         #
 202         for b in self.buttons:
 203             b.configure(state="normal")
 204         #
 205         self.top.tkraise()
 206         self.root.mainloop()
 207         #
 208         for b in self.buttons:
 209             b.configure(state="disabled")
 210         self.status.configure(text="")
 211         self.error.configure(text="", background=self.errorbg)
 212         self.frame = None
 213
 214     def sync_source_line(self):
 215         frame = self.frame
 216         if not frame:
 217             return
 218         filename, lineno = self.__frame2fileline(frame)
 219         if filename[:1] + filename[-1:] != "<>" and os.path.exists(filename):
 220             self.flist.gotofileline(filename, lineno)
 221
 222     def __frame2fileline(self, frame):
 223         code = frame.f_code
 224         filename = code.co_filename
 225         lineno = frame.f_lineno
 226         return filename, lineno
 227
 228     def cont(self):
 229         self.idb.set_continue()
 230         self.root.quit()
 231
 232     def step(self):
 233         self.idb.set_step()
 234         self.root.quit()
 235
 236     def next(self):
 237         self.idb.set_next(self.frame)
 238         self.root.quit()
 239
 240     def ret(self):
 241         self.idb.set_return(self.frame)
 242         self.root.quit()
 243
 244     def quit(self):
 245         self.idb.set_quit()
 246         self.root.quit()
 247
 248     stackviewer = None
 249
 250     def show_stack(self):
 251         if not self.stackviewer and self.vstack.get():
 252             self.stackviewer = sv = StackViewer(self.fstack, self.flist, self)
 253             if self.frame:
 254                 stack, i = self.idb.get_stack(self.frame, None)
 255                 sv.load_stack(stack, i)
 256         else:
 257             sv = self.stackviewer
 258             if sv and not self.vstack.get():
 259                 self.stackviewer = None
 260                 sv.close()
 261             self.fstack['height'] = 1
 262
 263     def show_source(self):
 264         if self.vsource.get():
 265             self.sync_source_line()
 266
 267     def show_frame(self, (frame, lineno)):
 268         self.frame = frame
 269         self.show_variables()
 270
 271     localsviewer = None
 272     globalsviewer = None
 273
 274     def show_locals(self):
 275         lv = self.localsviewer
 276         if self.vlocals.get():
 277             if not lv:
 278                 self.localsviewer = NamespaceViewer(self.flocals, "Locals")
 279         else:
 280             if lv:
 281                 self.localsviewer = None
 282                 lv.close()
 283                 self.flocals['height'] = 1
 284         self.show_variables()
 285
 286     def show_globals(self):
 287         gv = self.globalsviewer
 288         if self.vglobals.get():
 289             if not gv:
 290                 self.globalsviewer = NamespaceViewer(self.fglobals, "Globals")
 291         else:
 292             if gv:
 293                 self.globalsviewer = None
 294                 gv.close()
 295                 self.fglobals['height'] = 1
 296         self.show_variables()
 297
 298     def show_variables(self, force=0):
 299         lv = self.localsviewer
 300         gv = self.globalsviewer
 301         frame = self.frame
 302         if not frame:
 303             ldict = gdict = None
 304         else:
 305             ldict = frame.f_locals
 306             gdict = frame.f_globals
 307             if lv and gv and ldict is gdict:
 308                 ldict = None
 309         if lv:
 310             lv.load_dict(ldict, force, self.pyshell.interp.rpcclt)
 311         if gv:
 312             gv.load_dict(gdict, force, self.pyshell.interp.rpcclt)
 313
 314     def set_breakpoint_here(self, edit):
 315         text = edit.text
 316         filename = edit.io.filename
 317         if not filename:
 318             text.bell()
 319             return
 320         lineno = int(float(text.index("insert")))
 321         msg = self.idb.set_break(filename, lineno)
 322         if msg:
 323             text.bell()
 324             return
 325         text.tag_add("BREAK", "insert linestart", "insert lineend +1char")
 326         edit.break_set = True
 327
 328     def clear_breakpoint_here(self, edit):
 329         text = edit.text
 330         filename = edit.io.filename
 331         if not filename:
 332             text.bell()
 333             return
 334         lineno = int(float(text.index("insert")))
 335         msg = self.idb.clear_break(filename, lineno)
 336         if msg:
 337             text.bell()
 338             return
 339         text.tag_remove("BREAK", "insert linestart",\
 340                         "insert lineend +1char")
 341         # Don't bother to track break_set status
 342
 343     def clear_file_breaks(self, edit):
 344         text = edit.text
 345         filename = edit.io.filename
 346         if not filename:
 347             text.bell()
 348             return
 349         msg = self.idb.clear_all_file_breaks(filename)
 350         if msg:
 351             text.bell()
 352             return
 353         text.tag_remove("BREAK", "1.0", END)
 354         edit.break_set = False
 355
 356
 357 class StackViewer(ScrolledList):
 358
 359     def __init__(self, master, flist, gui):
 360         ScrolledList.__init__(self, master, width=80)
 361         self.flist = flist
 362         self.gui = gui
 363         self.stack = []
 364
 365     def load_stack(self, stack, index=None):
 366         self.stack = stack
 367         self.clear()
 368         for i in range(len(stack)):
 369             frame, lineno = stack[i]
 370             try:
 371                 modname = frame.f_globals["__name__"]
 372             except:
 373                 modname = "?"
 374             code = frame.f_code
 375             filename = code.co_filename
 376             funcname = code.co_name
 377             import linecache
 378             sourceline = linecache.getline(filename, lineno)
 379             import string
 380             sourceline = string.strip(sourceline)
 381             if funcname in ("?", "", None):
 382                 item = "%s, line %d: %s" % (modname, lineno, sourceline)
 383             else:
 384                 item = "%s.%s(), line %d: %s" % (modname, funcname,
 385                                                  lineno, sourceline)
 386             if i == index:
 387                 item = "> " + item
 388             self.append(item)
 389         if index is not None:
 390             self.select(index)
 391
 392     def popup_event(self, event):
 393         "override base method"
 394         if self.stack:
 395             return ScrolledList.popup_event(self, event)
 396
 397     def fill_menu(self):
 398         "override base method"
 399         menu = self.menu
 400         menu.add_command(label="Go to source line",
 401                          command=self.goto_source_line)
 402         menu.add_command(label="Show stack frame",
 403                          command=self.show_stack_frame)
 404
 405     def on_select(self, index):
 406         "override base method"
 407         if 0 <= index < len(self.stack):
 408             self.gui.show_frame(self.stack[index])
 409
 410     def on_double(self, index):
 411         "override base method"
 412         self.show_source(index)
 413
 414     def goto_source_line(self):
 415         index = self.listbox.index("active")
 416         self.show_source(index)
 417
 418     def show_stack_frame(self):
 419         index = self.listbox.index("active")
 420         if 0 <= index < len(self.stack):
 421             self.gui.show_frame(self.stack[index])
 422
 423     def show_source(self, index):
 424         if not (0 <= index < len(self.stack)):
 425             return
 426         frame, lineno = self.stack[index]
 427         code = frame.f_code
 428         filename = code.co_filename
 429         if os.path.isfile(filename):
 430             edit = self.flist.open(filename)
 431             if edit:
 432                 edit.gotoline(lineno)
 433
 434
 435 class NamespaceViewer:
 436
 437     def __init__(self, master, title, dict=None):
 438         width = 0
 439         height = 40
 440         if dict:
 441             height = 20*len(dict) # XXX 20 == observed height of Entry widget
 442         self.master = master
 443         self.title = title
 444         import repr
 445         self.repr = repr.Repr()
 446         self.repr.maxstring = 60
 447         self.repr.maxother = 60
 448         self.frame = frame = Frame(master)
 449         self.frame.pack(expand=1, fill="both")
 450         self.label = Label(frame, text=title, borderwidth=2, relief="groove")
 451         self.label.pack(fill="x")
 452         self.vbar = vbar = Scrollbar(frame, name="vbar")
 453         vbar.pack(side="right", fill="y")
 454         self.canvas = canvas = Canvas(frame,
 455                                       height=min(300, max(40, height)),
 456                                       scrollregion=(0, 0, width, height))
 457         canvas.pack(side="left", fill="both", expand=1)
 458         vbar["command"] = canvas.yview
 459         canvas["yscrollcommand"] = vbar.set
 460         self.subframe = subframe = Frame(canvas)
 461         self.sfid = canvas.create_window(0, 0, window=subframe, anchor="nw")
 462         self.load_dict(dict)
 463
 464     dict = -1
 465
 466     def load_dict(self, dict, force=0, rpc_client=None):
 467         if dict is self.dict and not force:
 468             return
 469         subframe = self.subframe
 470         frame = self.frame
 471         for c in subframe.children.values():
 472             c.destroy()
 473         self.dict = None
 474         if not dict:
 475             l = Label(subframe, text="None")
 476             l.grid(row=0, column=0)
 477         else:
 478             names = dict.keys()
 479             names.sort()
 480             row = 0
 481             for name in names:
 482                 value = dict[name]
 483                 svalue = self.repr.repr(value) # repr(value)
 484                 # Strip extra quotes caused by calling repr on the (already)
 485                 # repr'd value sent across the RPC interface:
 486                 if rpc_client:
 487                     svalue = svalue[1:-1]
 488                 l = Label(subframe, text=name)
 489                 l.grid(row=row, column=0, sticky="nw")
 490     ##            l = Label(subframe, text=svalue, justify="l", wraplength=300)
 491                 l = Entry(subframe, width=0, borderwidth=0)
 492                 l.insert(0, svalue)
 493     ##            l["state"] = "disabled"
 494                 l.grid(row=row, column=1, sticky="nw")
 495                 row = row+1
 496         self.dict = dict
 497         # XXX Could we use a <Configure> callback for the following?
 498         subframe.update_idletasks() # Alas!
 499         width = subframe.winfo_reqwidth()
 500         height = subframe.winfo_reqheight()
 501         canvas = self.canvas
 502         self.canvas["scrollregion"] = (0, 0, width, height)
 503         if height > 300:
 504             canvas["height"] = 300
 505             frame.pack(expand=1)
 506         else:
 507             canvas["height"] = height
 508             frame.pack(expand=0)
 509
 510     def close(self):
 511         self.frame.destroy()