-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathClassList.py
More file actions
251 lines (220 loc) · 7.72 KB
/
Copy pathClassList.py
File metadata and controls
251 lines (220 loc) · 7.72 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
#!/usr/bin/env python2
"""ClassHierarchy.py
A quick, hacky script to construct a class hierarchy list from a set of Python files.
"""
import os
import re
import sys
from glob import glob
from operator import attrgetter
def EmptyString(klass):
return ''
class Klass(object):
"""Represents a Python class for our purposes."""
def __init__(self, name='Webware', filename=''):
self._name = name
self._bases = []
self._derived = []
self._filename = filename
def addBase(self, klass):
assert isinstance(klass, Klass)
if klass not in self._bases:
self._bases.append(klass)
klass.addDerived(self)
def addDerived(self, klass):
assert isinstance(klass, Klass)
if klass not in self._derived:
self._derived.append(klass)
def name(self):
return self._name
def filename(self):
return self._filename
def setFilename(self, filename):
self._filename = filename
def printList(self, file=sys.stdout,
indent=0, indentString=' ',
prefix='', func=EmptyString, postfix='',
multipleBasesMarker='*'):
filename = self._filename
if os.path.splitext(filename)[0] == self._name:
filename = ''
if len(self._bases) < 2:
star = ''
else:
star = multipleBasesMarker
file.write(''.join((prefix, indentString*indent,
self._name, star, func(self), postfix)) + '\n')
indent += 1
for klass in self._derived:
klass.printList(file, indent, indentString, prefix, func, postfix)
def __repr__(self):
return '<%s, %s>' % (self.__class__.__name__, self._name)
class ClassList(object):
"""Builds a class list for a package of Python modules."""
def __init__(self, name='Webware'):
self._name = name
self._splitter = re.compile(r"[(,):]")
self._klasses = {}
self._verbose = False
self._filesToIgnore = []
def addFilesToIgnore(self, list):
self._filesToIgnore.extend(list)
def readFiles(self, filename):
filenames = glob(filename)
for name in filenames:
self.readFile(name)
def readFile(self, name):
if name in self._filesToIgnore:
if self._verbose:
print 'Skipping %s...' % name
return
if self._verbose:
print 'Reading %s...' % name
lines = open(name).readlines()
lineNum = 1
for line in lines:
if len(line) > 8 and line[:6] == 'class ' and ':' in line:
self.readLine(line, name, lineNum)
lineNum += 1
if self._verbose:
print
def readLine(self, line, filename=None, lineNum=None):
# strip comments
comment = line.find('#')
if comment >= 0:
line = line[:comment]
# split into words
names = self._splitter.split(line[5:])
# strip white space
names = map(lambda part: part.strip(), names)
# get rid of empty strings
names = filter(None, names)
# special case: class foo(fi): pass
if names[-1] == 'pass':
del names[-1]
# check for weirdos
for name in names:
if ' ' in name or '\t' in name:
if name is not None:
if lineNum is not None:
print '%s:%s:' % (filename, lineNum),
else:
print '%s:' % (filename),
print 'strange result:', names
if not self._verbose:
print 'Maybe you should set self._verbose and try again.'
sys.exit(1)
if self._verbose:
print names
# create the klasses as needed
for name in names:
if name not in self._klasses:
self._klasses[name] = Klass(name)
# connect them
klass = self._klasses[names[0]]
klass.setFilename(filename)
for name in names[1:]:
klass.addBase(self._klasses[name])
def roots(self):
roots = []
for klass in self._klasses.values():
if not klass._bases:
roots.append(klass)
return roots
def printList(self, file=sys.stdout):
roots = self.roots()
for klass in sorted(roots, key=attrgetter('_name')):
klass.printList(file=file)
def printForWeb(self, hierarchic=False, file=sys.stdout):
if isinstance(file, basestring):
file = open(file, 'w')
closeFile = True
else:
closeFile = False
name = self._name
title = 'Class %s of %s' % (
'Hierarchy' if hierarchic else 'List', name)
other = ('<a href="Class%s.html">%s class list</a>'
' and the <a href="FileList.html">list of files</a> of %s'
% ('List' if hierarchic else 'Hierarchy',
'alphabetical' if hierarchic else 'hierarchical', name))
file.write('''<!DOCTYPE html>
<head>
<title>%s</title>
<style type="text/css">
<!--
body { background: #FFF;
font-family: Verdana, Arial, Helvetica, sans-serif; font-size: 10pt;
padding: 6pt; }
table { empty-cells: show;
border-spacing: 2px; border-collapse: separate; border-style: none; }
th { background-color: #CCF; text-align: left;
padding: 2px; border-style: none; }
td { background-color: #EEF;
padding: 2px; border-style: none; }
.center { text-align: center; }
.center table { margin-left: auto; margin-right: auto; text-align: left; }
-->
</style>
</head>
<body><div class="center">
<h1>%s</h1>
<p>See also the %s.</p>
<table>
''' % (title, title, other))
file.write('<tr><th>Class Name</th><th>Source File</th>'
'<th>Source</th><th>Doc</th><th>Summary</th></tr>\n')
if hierarchic:
classes = self.roots()
else:
classes = self._klasses.values()
for klass in sorted(classes, key=attrgetter('_name')):
if hierarchic:
klass.printList(file=file, prefix='<tr><td>',
indentString=' '*6,
func=self.links, postfix='</tr>\n')
else:
file.write('<tr><td>%s%s</tr>\n'
% (klass.name(), self.links(klass)))
file.write('''</table>
</div></body>
</html>''')
if closeFile:
file.close()
def links(self, klass):
"""In support of printForWeb()"""
name = self._name
filename = klass.filename()
links = []
# source file
if os.path.exists(filename):
links.append('<a href="../../%s">%s</a>' % (filename, filename))
else:
links.append(' ')
filename = os.path.basename(filename)
module = os.path.splitext(filename)[0]
# highlighted source file
if os.path.exists('Docs/Source/Files/%s.html' % module):
links.append('<a href="Files/%s.html">source</a>' % module)
else:
links.append(' ')
# doc file
if os.path.exists('Docs/Source/Docs/%s.%s.html' % (name, module)):
links.append('<a href="Docs/%s.%s.html">doc</a>' % (name, module))
else:
links.append(' ')
# summary file
if os.path.exists('Docs/Source/Summaries/%s.html' % module):
links.append('<a href="Summaries/%s.html">summary</a>' % module)
else:
links.append(' ')
# finish up
links = '</td><td class="center">'.join(links)
return '</td><td>%s</td>' % links
def main(args):
classlist = ClassList()
for filename in args:
classlist.readFiles(filename)
classlist.printList()
if __name__ == '__main__':
main(sys.argv[1:])