/usr/share/pyshared/pydoctor/templatewriter/summary.py is in python-pydoctor 0.5b1+bzr603-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 | """Classes that generate the summary pages."""
from twisted.web.template import tags
from twisted.web.template import Element, renderer, TagLoader, XMLFile
from pydoctor import epydoc2stan, model
from pydoctor.templatewriter.util import taglink, templatefile
def moduleSummary(modorpack):
r = tags.li(taglink(modorpack), ' - ', epydoc2stan.doc2stan(modorpack, summary=True)[0])
if not isinstance(modorpack, model.Package):
return r
contents = [m for m in modorpack.orderedcontents
if m.isVisible and m.name != '__init__']
if not contents:
return r
ul = tags.ul()
for m in sorted(contents, key=lambda m:m.fullName()):
ul(moduleSummary(m))
return r(ul)
def _lckey(x):
return (x.fullName().lower(), x.fullName())
class ModuleIndexPage(Element):
filename = 'moduleIndex.html'
loader = XMLFile(templatefile('summary.html'))
def __init__(self, system):
self.system = system
@renderer
def title(self, request, tag):
return tag.clear()("Module Index")
@renderer
def stuff(self, request, tag):
r = []
for o in self.system.rootobjects:
r.append(moduleSummary(o))
return tag.clear()(r)
@renderer
def heading(self, request, tag):
return tag().clear()("Module Index")
def findRootClasses(system):
roots = {}
for cls in system.objectsOfType(model.Class):
if ' ' in cls.name or not cls.isVisible:
continue
if cls.bases:
for n, b in zip(cls.bases, cls.baseobjects):
if b is None or not b.isVisible:
roots.setdefault(n, []).append(cls)
elif b.system is not system:
roots[b.fullName()] = b
else:
roots[cls.fullName()] = cls
return sorted(roots.items(), key=lambda x:x[0].lower())
def subclassesFrom(hostsystem, cls, anchors):
r = tags.li()
name = cls.fullName()
if name not in anchors:
r(tags.a(name=name))
anchors.add(name)
r(taglink(cls), ' - ', epydoc2stan.doc2stan(cls, summary=True)[0])
scs = [sc for sc in cls.subclasses if sc.system is hostsystem and ' ' not in sc.fullName()
and sc.isVisible]
if len(scs) > 0:
ul = tags.ul()
for sc in sorted(scs, key=_lckey):
ul(subclassesFrom(hostsystem, sc, anchors))
r(ul)
return r
class ClassIndexPage(Element):
filename = 'classIndex.html'
loader = XMLFile(templatefile('summary.html'))
def __init__(self, system):
self.system = system
@renderer
def title(self, request, tag):
return tag.clear()("Class Hierarchy")
@renderer
def stuff(self, request, tag):
t = tag
anchors = set()
for b, o in findRootClasses(self.system):
if isinstance(o, model.Class):
t(subclassesFrom(self.system, o, anchors))
else:
item = tags.li(b)
if o:
ul = tags.ul()
for sc in sorted(o, key=_lckey):
ul(subclassesFrom(self.system, sc, anchors))
item(ul)
t(item)
return t
@renderer
def heading(self, request, tag):
return tag.clear()("Class Hierarchy")
class LetterElement(Element):
def __init__(self, loader, initials, letter):
Element.__init__(self, loader)
self.initials = initials
self.my_letter = letter
@renderer
def letter(self, request, tag):
return tag(self.my_letter)
@renderer
def letterlinks(self, request, tag):
letterlinks = []
for initial in sorted(self.initials):
if initial == self.my_letter:
letterlinks.append(initial)
else:
letterlinks.append(tags.a(href='#'+initial)(initial))
letterlinks.append(' - ')
if letterlinks:
del letterlinks[-1]
return tag(letterlinks)
@renderer
def names(self, request, tag):
name2obs = {}
for obj in self.initials[self.my_letter]:
name2obs.setdefault(obj.name, []).append(obj)
r = []
for name in sorted(name2obs, key=lambda x:(x.lower(), x)):
obs = name2obs[name]
if len(obs) == 1:
r.append(tag.clone()(name, ' - ', taglink(obs[0])))
else:
ul = tags.ul()
for ob in sorted(obs, key=_lckey):
ul(tags.li(taglink(ob)))
r.append(tag.clone()(name, ul))
return r
class NameIndexPage(Element):
filename = 'nameIndex.html'
loader = XMLFile(templatefile('nameIndex.html'))
def __init__(self, system):
self.system = system
self.initials = {}
for ob in self.system.orderedallobjects:
if ob.isVisible:
self.initials.setdefault(ob.name[0].upper(), []).append(ob)
@renderer
def title(self, request, tag):
return tag.clear()("Index Of Names")
@renderer
def heading(self, request, tag):
return tag.clear()("Index Of Names")
@renderer
def index(self, request, tag):
r = []
for i in sorted(self.initials):
r.append(LetterElement(TagLoader(tag), self.initials, i))
return r
class IndexPage(Element):
filename = 'index.html'
loader = XMLFile(templatefile('index.html'))
def __init__(self, system):
self.system = system
@renderer
def project_link(self, request, tag):
if self.system.options.projecturl:
return tags.a(href=self.system.options.projecturl)(
self.system.options.projectname)
elif self.system.options.projectname:
return self.system.options.projectname
else:
return self.system.guessedprojectname
@renderer
def project(self, request, tag):
if self.system.options.projectname:
return self.system.options.projectname
else:
return self.system.guessedprojectname
@renderer
def recentChanges(self, request, tag):
return ()
@renderer
def problemObjects(self, request, tag):
return ()
@renderer
def onlyIfOneRoot(self, request, tag):
if len(self.system.rootobjects) != 1:
return []
else:
root, = self.system.rootobjects
return tag.clear()(
"Start at ", taglink(root),
", the root ", root.kind.lower(), ".")
@renderer
def onlyIfMultipleRoots(self, request, tag):
if len(self.system.rootobjects) == 1:
return []
else:
return tag
@renderer
def roots(self, request, tag):
r = []
for o in self.system.rootobjects:
r.append(tag.clone().fillSlots(root=taglink(o)))
return r
@renderer
def rootkind(self, request, tag):
rootkinds = {}
for o in self.system.rootobjects:
rootkinds[o.kind.lower() + 's'] = 1
return tag.clear()('/'.join(sorted(rootkinds)))
@renderer
def buildtime(self, request, tag):
return self.system.buildtime.strftime("%Y-%m-%d %H:%M:%S")
def hasdocstring(ob):
for source in ob.docsources():
if source.docstring is not None:
return True
return False
class UndocumentedSummaryPage(Element):
filename = 'undoccedSummary.html'
loader = XMLFile(templatefile('summary.html'))
def __init__(self, system):
self.system = system
@renderer
def title(self, request, tag):
return tag.clear()("Summary of Undocumented Objects")
@renderer
def heading(self, request, tag):
return tag.clear()("Summary of Undocumented Objects")
@renderer
def stuff(self, request, tag):
undoccedpublic = [o for o in self.system.orderedallobjects
if o.isVisible and not hasdocstring(o)]
undoccedpublic.sort(key=lambda o:o.fullName())
for o in undoccedpublic:
tag(tags.li(o.kind, " - ", taglink(o)))
return tag
summarypages = [
ModuleIndexPage,
ClassIndexPage,
IndexPage,
NameIndexPage,
UndocumentedSummaryPage,
]
|