/usr/share/pyshared/pydoctor/server.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 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 | """A web application that dynamically generates pydoctor documentation."""
import parser
import urllib
import time
from twisted.python.urlpath import URLPath
from twisted.web.static import File
from twisted.web import resource
from twisted.web.template import Element, renderElement, renderer, XMLFile, XMLString, tags
from twisted.web.util import Redirect
from pydoctor import model, epydoc2stan
from pydoctor.templatewriter import DOCTYPE, pages, summary, util
from pydoctor.astbuilder import MyTransformer
def parse_str(s):
"""Parse the string literal into a L{str_with_orig} that has the literal form as an attribute."""
t = parser.suite(s.strip()).totuple(1)
return MyTransformer().get_docstring(t)
def findPageClassInDict(obj, d, default="CommonPage"):
for c in obj.__class__.__mro__:
n = c.__name__ + 'Page'
if n in d:
return d[n]
return d[default]
class WrapperPage(resource.Resource):
def __init__(self, element):
self.element = element
def render_GET(self, request):
request.write(DOCTYPE)
return renderElement(request, self.element)
class PostWrapperPage(WrapperPage):
def render_POST(self, request):
request.write(DOCTYPE)
return renderElement(request, self.element)
class PyDoctorResource(resource.Resource):
docgetter = None
def __init__(self, system):
resource.Resource.__init__(self)
self.system = system
self.putChild('apidocs.css', File(util.templatefile('apidocs.css')))
self.putChild('sorttable.js', File(util.templatefile('sorttable.js')))
self.putChild('pydoctor.js', File(util.templatefile('pydoctor.js')))
self.index = WrapperPage(self.indexPage())
self.putChild('', self.index)
self.putChild('index.html', self.index)
self.putChild('moduleIndex.html',
WrapperPage(summary.ModuleIndexPage(self.system)))
self.putChild('classIndex.html',
WrapperPage(summary.ClassIndexPage(self.system)))
self.putChild('nameIndex.html',
WrapperPage(summary.NameIndexPage(self.system)))
def indexPage(self):
return summary.IndexPage(self.system)
def pageClassForObject(self, ob):
return findPageClassInDict(ob, pages.__dict__)
def getChild(self, name, request):
if not name.endswith('.html'):
return None
name = name[0:-5]
if name not in self.system.allobjects:
return None
obj = self.system.allobjects[name]
return WrapperPage(self.pageClassForObject(obj)(obj, self.docgetter))
class IndexPage(summary.IndexPage):
@renderer
def recentChanges(self, request, tag):
return tag
@renderer
def problemObjects(self, request, tag):
if self.system.epytextproblems:
return tag
else:
return ()
class RecentChangesElement(Element):
def __init__(self, root):
self.root = root
@renderer
def changes(self, request, tag):
r = []
for d in reversed(self.root._edits):
r.append(
tag.clone().fillSlots(
diff=self.diff(d, request),
hist=self.hist(d, request),
object=util.taglink(d.obj),
time=d.time,
user=d.user))
return r
def diff(self, data, request):
u = URLPath.fromRequest(request)
u = u.sibling('diff')
u.query = urllib.urlencode({
'ob': data.obj.fullName(),
'revA': data.rev-1,
'revB': data.rev,
})
return tags.a(href=str(u))("(diff)")
def hist(self, data, request):
u = URLPath.fromRequest(request)
u = u.sibling('diff')
u.query = urllib.urlencode({
'ob': data.obj.fullName(),
'rev': data.rev,
})
return tags.a(href=str(u))("(hist)")
loader = XMLString('''\
<html xmlns:t="http://twistedmatrix.com/ns/twisted.web.template/0.1">
<head>
<title>Recent Changes</title>
<link rel="stylesheet" type="text/css" href="apidocs.css" />
</head>
<body>
<h1>Recent Changes</h1>
<p>See <a href="bigDiff">a diff containing all changes made online</a></p>
<ul>
<li t:render="changes">
<t:slot name="diff" /> - <t:slot name="hist" /> - <t:slot name="object" />
- <t:slot name="time" /> - <t:slot name="user" />
</li>
</ul>
</body>
</html>
''')
class EditableDocGetter(object):
def __init__(self, root):
self.root = root
def get(self, ob, summary=False):
return self.root.stanForOb(ob, summary=summary)
def userIP(req):
# obviously this is at least slightly a guess.
xff = req.received_headers.get('x-forwarded-for')
if xff:
return xff
elif getattr(req, 'client', None):
return req.getClientIP()
class ErrorElement(Element):
loader = XMLString("<html><head><title>Error</title></head><body><p>An error occurred.</p></body></html>")
def indentationAmount(ob):
ob = ob.doctarget
if isinstance(ob, model.Module):
return 0
lines = open(ob.doctarget.parentMod.filepath, 'rU').readlines()
if ob.docstring is None:
line = lines[ob.linenumber-1]
return len(line) - len(line.lstrip()) + 4
else:
docstring_line_count = len(ob.docstring.orig.splitlines())
firstline = lines[ob.docstring.linenumber - docstring_line_count]
return len(firstline) - len(firstline.lstrip())
def indent(ds, data):
lines = ds.splitlines()
r = [lines[0]]
for line in lines[1:]:
if line.strip():
line = data + line
r.append(line)
return '\n'.join(r)
def dedent(ds):
lines = ds.splitlines()
for line in lines[1:]:
if line.strip():
break
else:
return ds, None
initialWhitespace = line[:len(line) - len(line.lstrip())]
r = [lines[0]]
for line in lines[1:]:
if line.startswith(initialWhitespace):
line = line[len(initialWhitespace):]
r.append(line)
return '\n'.join(r), initialWhitespace
class EditElement(Element):
def __init__(self, root, ob, docstring, isPreview, initialWhitespace):
self.root = root
self.ob = ob
self.lines = open(
self.ob.doctarget.parentMod.filepath, 'rU').readlines()
self.docstring = docstring
self.isPreview = isPreview
self._initialWhitespace = initialWhitespace
@renderer
def title(self, request, tag):
return tag.clear()(
u"Editing docstring of \N{LEFT DOUBLE QUOTATION MARK}",
self.ob.fullName(),
u"\N{RIGHT DOUBLE QUOTATION MARK}")
@renderer
def preview(self, request, tag):
docstring = parse_str(self.docstring)
stan, errors = epydoc2stan.doc2stan(
self.ob, docstring=docstring)
if self.isPreview or errors:
if errors:
#print stan, errors
#assert isinstance(stan, tags.pre)
[text] = stan.children
lines = text.replace('\r\n', '\n').split('\n')
line2err = {}
for err in errors:
if isinstance(err, str):
ln = None
else:
ln = err.linenum()
line2err.setdefault(ln, []).append(err)
w = len(str(len(lines)))
for i, line in enumerate(lines):
i += 1
cls = "preview"
if i in line2err:
cls += " error"
tag(tags.pre(class_=cls)("%*s"%(w, i), ' ', line))
for err in line2err.get(i, []):
tag(tags.p(class_="errormessage")(err.descr()))
i += 1
for err in line2err.get(i, []):
tag(tags.p(class_="errormessage")(err.descr()))
items = []
for err in line2err.get(None, []):
items.append(tags.li(str(err)))
if items:
tag(tags.ul(items))
else:
tag = tag(stan)
return tag(tags.h2("Edit"))
else:
return ()
@renderer
def fullName(self, request, tag):
return self.ob.fullName()
@renderer
def initialWhitespace(self, request, tag):
return self._initialWhitespace
@renderer
def before(self, request, tag):
tob = self.ob.doctarget
if tob.docstring:
docstring_line_count = len(tob.docstring.orig.splitlines())
lineno = tob.docstring.linenumber - docstring_line_count
else:
lineno = tob.linenumber
firstlineno = max(0, lineno-6)
lines = self.lines[firstlineno:lineno]
if not lines:
return ()
if firstlineno > 0:
lines.insert(0, '...\n')
return tag(lines)
@renderer
def divIndent(self, request, tag):
return 'margin-left: %dex;'%(indentationAmount(self.ob),)
@renderer
def rows(self, request, tag):
return str(len(self.docstring.splitlines()) + 1)
@renderer
def textarea(self, request, tag):
return tag.clear()(self.docstring)
@renderer
def after(self, request, tag):
tob = self.ob.doctarget
if tob.docstring:
lineno = tob.docstring.linenumber
else:
lineno = tob.linenumber
lastlineno = lineno + 6
lines = self.lines[lineno:lastlineno]
if not lines:
return ()
if lastlineno < len(self.lines):
lines.append('...\n')
return tag(lines)
@renderer
def url(self, request, tag):
return 'edit?ob=' + self.ob.fullName()
loader = XMLFile(util.templatefile("edit.html"))
class HistoryElement(Element):
def __init__(self, root, ob, rev):
self.root = root
self.ob = ob
self.rev = rev
@renderer
def title(self, request, tag):
return tag(u"History of \N{LEFT DOUBLE QUOTATION MARK}" +
self.ob.fullName() +
u"\N{RIGHT DOUBLE QUOTATION MARK}s docstring")
@renderer
def links(self, request, tag):
ds = self.root.edits(self.ob)
therange = range(len(ds))
rev = therange[self.rev]
ul = tags.ul()
for i in therange:
li = tags.li()
if i:
u = URLPath.fromRequest(request)
u = u.sibling('diff')
u.query = urllib.urlencode({
'ob': self.ob.fullName(),
'revA': i-1,
'revB': i,
})
li(tags.a(href=str(u))("(diff)"))
else:
li("(diff)")
li(" - ")
if i == len(ds) - 1:
label = "Latest"
else:
label = str(i)
if i == rev:
li(label)
else:
u = URLPath.fromRequest(request)
u.query = urllib.urlencode({
'rev': str(i),
'ob': self.ob.fullName(),
})
li(tags.a(href=str(u))(label))
li(' - ' + ds[i].user + '/' + ds[i].time)
ul(li)
return tag(ul)
@renderer
def docstring(self, request, tag):
docstring = self.root.edits(self.ob)[self.rev].newDocstring
if docstring is None:
docstring = ''
return epydoc2stan.doc2stan(self.ob, docstring=docstring)[0]
@renderer
def linkback(self, request, tag):
return util.taglink(self.ob, label="Back")
loader = XMLString('''\
<html xmlns:t="http://twistedmatrix.com/ns/twisted.web.template/0.1">
<head>
<title t:render="title" />
<link rel="stylesheet" type="text/css" href="apidocs.css" />
</head>
<body>
<h1 t:render="title"/>
<p t:render="links" />
<div t:render="docstring" />
<p t:render="linkback" />
</body>
</html>
''')
class Edit(object):
def __init__(self, obj, rev, newDocstring, user, time):
self.obj = obj
self.rev = rev
self.newDocstring = newDocstring
self.user = user
self.time = time
def filepath(ob):
mod = ob.parentMod
filepath = mod.filepath
while mod:
top = mod
mod = mod.parent
toppath = top.contents['__init__'].filepath[:-(len('__init__.py') + 1 + len(top.name))]
return filepath[len(toppath):]
class FileDiff(object):
def __init__(self, ob):
self.ob = ob
self.lines = [l[:-1] for l in open(ob.filepath, 'rU').readlines()]
self.orig_lines = self.lines[:]
def reset(self):
self.orig_lines = self.lines[:]
def apply_edit(self, editA, editB):
if not editA.newDocstring:
if editA.obj.linenumber:
lineno = editA.obj.linenumber + 0
else:
lineno = 0
origlines = []
else:
origlines = editA.newDocstring.orig.splitlines()
lineno = editA.newDocstring.linenumber - len(origlines)
firstdocline = lineno
lastdocline = firstdocline + len(origlines)
if editB.newDocstring:
newlines = editB.newDocstring.orig.splitlines()
newlines[0] = indentationAmount(editB.obj)*' ' + newlines[0]
if lineno == 0 and self.lines and self.lines[0].strip() != '':
newlines.append('')
else:
newlines = []
self.lines[firstdocline:lastdocline] = newlines
def diff(self):
orig = [line + '\n' for line in self.orig_lines]
new = [line + '\n' for line in self.lines]
import difflib
fpath = filepath(self.ob)
return ''.join(difflib.unified_diff(orig, new,
fromfile=fpath,
tofile=fpath))
class DiffElement(Element):
def __init__(self, root, ob, origob, editA, editB):
self.root = root
self.ob = ob
self.origob = origob
self.editA = editA
self.editB = editB
@renderer
def title(self, request, tag):
return tag("Viewing differences between revisions ",
str(self.editA.rev), " and ", str(self.editB.rev), " of ",
u"\N{LEFT DOUBLE QUOTATION MARK}" +
self.origob.fullName() +
u"\N{RIGHT DOUBLE QUOTATION MARK}")
@renderer
def diff(self, request, tag):
fd = FileDiff(self.ob.parentMod)
fd.apply_edit(self.root.editsbyob[self.ob][0], self.editA)
fd.reset()
fd.apply_edit(self.editA, self.editB)
return tags.pre(fd.diff())
loader = XMLFile(util.templatefile('diff.html'))
class BigDiffElement(Element):
def __init__(self, system, root):
self.system = system
self.root = root
@renderer
def bigDiff(self, request, tag):
mods = {}
for m in self.root.editsbymod:
l = [e for e in self.root.editsbymod[m]
if e is self.root.editsbyob[e.obj.doctarget][-1]]
l.sort(key=lambda x:x.obj.linenumber, reverse=True)
mods[m] = FileDiff(m)
for e in l:
edit0 = self.root.editsbyob[e.obj][0]
mods[m].apply_edit(edit0, e)
r = []
for mod in sorted(mods, key=lambda x:x.filepath):
r.append(tags.pre(mods[mod].diff()))
return r
loader = XMLFile(util.templatefile('bigDiff.html'))
class RawBigDiffPage(resource.Resource):
def __init__(self, system, root):
self.system = system
self.root = root
def render_GET(self, request):
request.setHeader('content-type', 'text/plain')
mods = {}
if not self.root.editsbymod:
return 'No edits yet!'
for m in self.root.editsbymod:
l = [e for e in self.root.editsbymod[m]
if e is self.root.editsbyob[e.obj.doctarget][-1]]
l.sort(key=lambda x:x.obj.linenumber, reverse=True)
mods[m] = FileDiff(m)
for e in l:
edit0 = self.root.editsbyob[e.obj][0]
mods[m].apply_edit(edit0, e)
for mod in sorted(mods, key=lambda x:x.filepath):
request.write(mods[mod].diff())
return ''
class ProblemObjectsElement(Element):
def __init__(self, system):
self.system = system
@renderer
def problemObjects(self, request, tag):
r = []
for fn in sorted(self.system.epytextproblems):
o = self.system.allobjects[fn]
r.append(tag.clone().fillSlots(link=util.taglink(o)))
return r
loader = XMLFile(util.templatefile('problemObjects.html'))
def absoluteURL(request, ob):
if ob.documentation_location == model.DocLocation.PARENT_PAGE:
p = ob.parent
if isinstance(p, model.Module) and p.name == '__init__':
p = p.parent
child = p.fullName() + '.html'
frag = ob.name
elif ob.documentation_location == model.DocLocation.OWN_PAGE:
child = ob.fullName() + '.html'
frag = None
else:
raise AssertionError("XXX")
u = URLPath.fromRequest(request)
u = u.sibling(child)
u.query = ''
u.fragment = frag
return str(u)
class EditingPyDoctorResource(PyDoctorResource):
def __init__(self, system):
PyDoctorResource.__init__(self, system)
self._edits = []
self.editsbyob = {}
self.editsbymod = {}
self.docgetter = EditableDocGetter(self)
def indexPage(self):
return IndexPage(self.system)
def getChild(self, name, request):
meth = getattr(self, 'child_' + name, None)
if meth:
return meth(request)
return PyDoctorResource.getChild(self, name, request)
def child_recentChanges(self, ctx):
return WrapperPage(RecentChangesElement(self))
def child_edit(self, request):
ob = self.system.allobjects.get(request.args.get('ob', [None])[0])
if ob is None:
return WrapperPage(ErrorElement())
newDocstring = request.args.get('docstring', [None])[0]
if newDocstring is None:
isPreview = False
newDocstring = self.mostRecentEdit(ob).newDocstring
if newDocstring is None:
newDocstring = ''
else:
newDocstring = newDocstring.orig
newDocstring, initialWhitespace = dedent(newDocstring)
if initialWhitespace is None:
initialWhitespace = ' '*indentationAmount(ob)
else:
isPreview = True
initialWhitespace = request.args.get('initialWhitespace', [None])[0]
action = request.args.get('action', ['Preview'])[0]
if action in ('Submit', 'Cancel'):
if action == 'Submit':
if newDocstring:
newDocstring = indent(newDocstring, initialWhitespace)
self.newDocstring(userIP(request), ob, newDocstring)
return Redirect(absoluteURL(request, ob))
return PostWrapperPage(
EditElement(self, ob, newDocstring, isPreview, initialWhitespace))
def child_history(self, request):
try:
rev = int(request.args.get('rev', ['-1'])[0])
except ValueError:
return WrapperPage(ErrorElement())
try:
ob = request.args['ob'][0]
ob = self.system.allobjects[ob]
except KeyError:
raise
return WrapperPage(ErrorElement())
try:
self.edits(ob)[rev]
except (IndexError, KeyError):
raise
return WrapperPage(ErrorElement())
return WrapperPage(HistoryElement(self, ob, rev))
def child_diff(self, request):
origob = ob = self.system.allobjects.get(request.args['ob'][0])
if ob is None:
return WrapperPage(ErrorElement())
if isinstance(ob, model.Package):
ob = ob.contents['__init__']
try:
revA = int(request.args.get('revA', [''])[0])
revB = int(request.args.get('revB', [''])[0])
except ValueError:
return WrapperPage(ErrorElement())
try:
edits = self.editsbyob[ob]
except KeyError:
return WrapperPage(ErrorElement())
try:
editA = edits[revA]
editB = edits[revB]
except IndexError:
return WrapperPage(ErrorElement())
return WrapperPage(DiffElement(self, ob, origob, editA, editB))
def child_bigDiff(self, request):
return WrapperPage(BigDiffElement(self.system, self))
def child_rawBigDiff(self, request):
return RawBigDiffPage(self.system, self)
def child_problemObjects(self, request):
return WrapperPage(ProblemObjectsElement(self.system))
def mostRecentEdit(self, ob):
return self.edits(ob)[-1]
def edits(self, ob):
ob = ob.doctarget
if ob not in self.editsbyob:
self.editsbyob[ob] = [
Edit(ob, 0, ob.docstring, 'no-one', 'Dawn of time')]
return self.editsbyob[ob]
def currentDocstringForObject(self, ob):
for source in ob.docsources():
d = self.mostRecentEdit(source).newDocstring
if d is not None:
return d
return ''
def addEdit(self, edit):
self.editsbyob.setdefault(edit.obj.doctarget, []).append(edit)
self.editsbymod.setdefault(
edit.obj.doctarget.parentMod, []).append(edit)
self._edits.append(edit)
def newDocstring(self, user, ob, newDocstring):
tob = ob.doctarget
if tob.parentMod not in self.editsbymod:
self.editsbymod[tob.parentMod] = []
prevEdit = self.mostRecentEdit(ob)
if not newDocstring.strip():
newDocstring = None
else:
newDocstring = parse_str(newDocstring)
newLength = len(newDocstring.orig.splitlines())
if prevEdit.newDocstring:
oldLength = len(prevEdit.newDocstring.orig.splitlines())
oldNumber = prevEdit.newDocstring.linenumber
newDocstring.linenumber = oldNumber - oldLength + newLength
else:
# XXX check for comments?
newDocstring.linenumber = tob.linenumber + 1 + newLength
edit = Edit(tob, prevEdit.rev + 1, newDocstring, user,
time.strftime("%Y-%m-%d %H:%M:%S"))
self.addEdit(edit)
if tob.fullName() in self.system.epytextproblems:
self.system.epytextproblems.remove(tob.fullName())
def stanForOb(self, ob, summary=False):
current_docstring = self.currentDocstringForObject(ob)
if summary:
return epydoc2stan.doc2stan(
ob.doctarget, summary=True,
docstring=current_docstring)[0]
r = [tags.div(epydoc2stan.doc2stan(ob.doctarget,
docstring=current_docstring)[0]),
tags.a(href="edit?ob="+ob.fullName())("Edit"),
" "]
if ob.doctarget in self.editsbyob:
r.append(tags.a(href="history?ob="+ob.fullName())(
"View docstring history (",
str(len(self.editsbyob[ob.doctarget])),
" versions)"))
else:
r.append(tags.span(class_='undocumented')("No edits yet."))
return r
|