Python code coverage for Lib/idlelib/ClassBrowser.py

#	count	content
1	n/a	"""Class browser.
2	n/a
3	n/a	XXX TO DO:
4	n/a
5	n/a	- reparse when source changed (maybe just a button would be OK?)
6	n/a	(or recheck on window popup)
7	n/a	- add popup menu with more options (e.g. doc strings, base classes, imports)
8	n/a	- show function argument list? (have to do pattern matching on source)
9	n/a	- should the classes and methods lists also be in the module's menu bar?
10	n/a	- add base classes to class browser tree
11	n/a	"""
12	n/a
13	n/a	import os
14	n/a	import sys
15	n/a	import pyclbr
16	n/a
17	n/a	from idlelib import PyShell
18	n/a	from idlelib.WindowList import ListedToplevel
19	n/a	from idlelib.TreeWidget import TreeNode, TreeItem, ScrolledCanvas
20	n/a	from idlelib.configHandler import idleConf
21	n/a
22	n/a	class ClassBrowser:
23	n/a
24	n/a	def __init__(self, flist, name, path):
25	n/a	# XXX This API should change, if the file doesn't end in ".py"
26	n/a	# XXX the code here is bogus!
27	n/a	self.name = name
28	n/a	self.file = os.path.join(path[0], self.name + ".py")
29	n/a	self.init(flist)
30	n/a
31	n/a	def close(self, event=None):
32	n/a	self.top.destroy()
33	n/a	self.node.destroy()
34	n/a
35	n/a	def init(self, flist):
36	n/a	self.flist = flist
37	n/a	# reset pyclbr
38	n/a	pyclbr._modules.clear()
39	n/a	# create top
40	n/a	self.top = top = ListedToplevel(flist.root)
41	n/a	top.protocol("WM_DELETE_WINDOW", self.close)
42	n/a	top.bind("<Escape>", self.close)
43	n/a	self.settitle()
44	n/a	top.focus_set()
45	n/a	# create scrolled canvas
46	n/a	theme = idleConf.GetOption('main','Theme','name')
47	n/a	background = idleConf.GetHighlight(theme, 'normal')['background']
48	n/a	sc = ScrolledCanvas(top, bg=background, highlightthickness=0, takefocus=1)
49	n/a	sc.frame.pack(expand=1, fill="both")
50	n/a	item = self.rootnode()
51	n/a	self.node = node = TreeNode(sc.canvas, None, item)
52	n/a	node.update()
53	n/a	node.expand()
54	n/a
55	n/a	def settitle(self):
56	n/a	self.top.wm_title("Class Browser - " + self.name)
57	n/a	self.top.wm_iconname("Class Browser")
58	n/a
59	n/a	def rootnode(self):
60	n/a	return ModuleBrowserTreeItem(self.file)
61	n/a
62	n/a	class ModuleBrowserTreeItem(TreeItem):
63	n/a
64	n/a	def __init__(self, file):
65	n/a	self.file = file
66	n/a
67	n/a	def GetText(self):
68	n/a	return os.path.basename(self.file)
69	n/a
70	n/a	def GetIconName(self):
71	n/a	return "python"
72	n/a
73	n/a	def GetSubList(self):
74	n/a	sublist = []
75	n/a	for name in self.listclasses():
76	n/a	item = ClassBrowserTreeItem(name, self.classes, self.file)
77	n/a	sublist.append(item)
78	n/a	return sublist
79	n/a
80	n/a	def OnDoubleClick(self):
81	n/a	if os.path.normcase(self.file[-3:]) != ".py":
82	n/a	return
83	n/a	if not os.path.exists(self.file):
84	n/a	return
85	n/a	PyShell.flist.open(self.file)
86	n/a
87	n/a	def IsExpandable(self):
88	n/a	return os.path.normcase(self.file[-3:]) == ".py"
89	n/a
90	n/a	def listclasses(self):
91	n/a	dir, file = os.path.split(self.file)
92	n/a	name, ext = os.path.splitext(file)
93	n/a	if os.path.normcase(ext) != ".py":
94	n/a	return []
95	n/a	try:
96	n/a	dict = pyclbr.readmodule_ex(name, [dir] + sys.path)
97	n/a	except ImportError as msg:
98	n/a	return []
99	n/a	items = []
100	n/a	self.classes = {}
101	n/a	for key, cl in dict.items():
102	n/a	if cl.module == name:
103	n/a	s = key
104	n/a	if hasattr(cl, 'super') and cl.super:
105	n/a	supers = []
106	n/a	for sup in cl.super:
107	n/a	if type(sup) is type(''):
108	n/a	sname = sup
109	n/a	else:
110	n/a	sname = sup.name
111	n/a	if sup.module != cl.module:
112	n/a	sname = "%s.%s" % (sup.module, sname)
113	n/a	supers.append(sname)
114	n/a	s = s + "(%s)" % ", ".join(supers)
115	n/a	items.append((cl.lineno, s))
116	n/a	self.classes[s] = cl
117	n/a	items.sort()
118	n/a	list = []
119	n/a	for item, s in items:
120	n/a	list.append(s)
121	n/a	return list
122	n/a
123	n/a	class ClassBrowserTreeItem(TreeItem):
124	n/a
125	n/a	def __init__(self, name, classes, file):
126	n/a	self.name = name
127	n/a	self.classes = classes
128	n/a	self.file = file
129	n/a	try:
130	n/a	self.cl = self.classes[self.name]
131	n/a	except (IndexError, KeyError):
132	n/a	self.cl = None
133	n/a	self.isfunction = isinstance(self.cl, pyclbr.Function)
134	n/a
135	n/a	def GetText(self):
136	n/a	if self.isfunction:
137	n/a	return "def " + self.name + "(...)"
138	n/a	else:
139	n/a	return "class " + self.name
140	n/a
141	n/a	def GetIconName(self):
142	n/a	if self.isfunction:
143	n/a	return "python"
144	n/a	else:
145	n/a	return "folder"
146	n/a
147	n/a	def IsExpandable(self):
148	n/a	if self.cl:
149	n/a	try:
150	n/a	return not not self.cl.methods
151	n/a	except AttributeError:
152	n/a	return False
153	n/a
154	n/a	def GetSubList(self):
155	n/a	if not self.cl:
156	n/a	return []
157	n/a	sublist = []
158	n/a	for name in self.listmethods():
159	n/a	item = MethodBrowserTreeItem(name, self.cl, self.file)
160	n/a	sublist.append(item)
161	n/a	return sublist
162	n/a
163	n/a	def OnDoubleClick(self):
164	n/a	if not os.path.exists(self.file):
165	n/a	return
166	n/a	edit = PyShell.flist.open(self.file)
167	n/a	if hasattr(self.cl, 'lineno'):
168	n/a	lineno = self.cl.lineno
169	n/a	edit.gotoline(lineno)
170	n/a
171	n/a	def listmethods(self):
172	n/a	if not self.cl:
173	n/a	return []
174	n/a	items = []
175	n/a	for name, lineno in self.cl.methods.items():
176	n/a	items.append((lineno, name))
177	n/a	items.sort()
178	n/a	list = []
179	n/a	for item, name in items:
180	n/a	list.append(name)
181	n/a	return list
182	n/a
183	n/a	class MethodBrowserTreeItem(TreeItem):
184	n/a
185	n/a	def __init__(self, name, cl, file):
186	n/a	self.name = name
187	n/a	self.cl = cl
188	n/a	self.file = file
189	n/a
190	n/a	def GetText(self):
191	n/a	return "def " + self.name + "(...)"
192	n/a
193	n/a	def GetIconName(self):
194	n/a	return "python" # XXX
195	n/a
196	n/a	def IsExpandable(self):
197	n/a	return 0
198	n/a
199	n/a	def OnDoubleClick(self):
200	n/a	if not os.path.exists(self.file):
201	n/a	return
202	n/a	edit = PyShell.flist.open(self.file)
203	n/a	edit.gotoline(self.cl.methods[self.name])
204	n/a
205	n/a	def main():
206	n/a	try:
207	n/a	file = __file__
208	n/a	except NameError:
209	n/a	file = sys.argv[0]
210	n/a	if sys.argv[1:]:
211	n/a	file = sys.argv[1]
212	n/a	else:
213	n/a	file = sys.argv[0]
214	n/a	dir, file = os.path.split(file)
215	n/a	name = os.path.splitext(file)[0]
216	n/a	ClassBrowser(PyShell.flist, name, [dir])
217	n/a	if sys.stdin is sys.__stdin__:
218	n/a	mainloop()
219	n/a
220	n/a	if __name__ == "__main__":
221	n/a	main()