Python code coverage for Lib/idlelib/Debugger.py

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