class AttributeChild(Element):
loader = XMLFile(util.templatefilepath('attribute-child.html'))
def __init__(self, docgetter, ob):
self.docgetter = docgetter
self.ob = ob
@renderer
def class_(self, request, tag):
class_ = self.ob.css_class
if self.ob.parent is not self.ob:
class_ = 'base' + class_
return class_
@renderer
def functionAnchor(self, request, tag):
return self.ob.fullName()
@renderer
def shortFunctionAnchor(self, request, tag):
return self.ob.name
@renderer
def attribute(self, request, tag):
return self.ob.name
@renderer
def functionBody(self, request, tag):
return self.docgetter.get(self.ob)
class ChildTable(Element):
loader = XMLFile(util.templatefilepath('table.html'))
last_id = 0
def __init__(self, docgetter, ob, children):
self.docgetter = docgetter
self.system = ob.system
self.children = children
ChildTable.last_id += 1
self._id = ChildTable.last_id
self.ob = ob
@renderer
def id(self, request, tag):
return 'id'+str(self._id)
@renderer
def rows(self, request, tag):
return [
TableRow(
TagLoader(tag),
self.docgetter,
self.ob,
child)
for child in self.children]
class FunctionChild(Element):
loader = XMLFile(util.templatefilepath('function-child.html'))
def __init__(self, docgetter, ob, functionExtras):
self.docgetter = docgetter
self.ob = ob
self._functionExtras = functionExtras
@renderer
def class_(self, request, tag):
class_ = self.ob.css_class
if self.ob.parent is not self.ob:
class_ = 'base' + class_
return class_
@renderer
def functionAnchor(self, request, tag):
return self.ob.fullName()
@renderer
def shortFunctionAnchor(self, request, tag):
return self.ob.name
@renderer
def decorator(self, request, tag):
return list(format_decorators(self.ob))
@renderer
def functionDef(self, request, tag):
def_stmt = 'async def' if self.ob.is_async else 'def'
name = self.ob.name
if name.endswith('.setter') or name.endswith('.deleter'):
name = name[:name.rindex('.')]
return [
tags.span(def_stmt, class_='py-keyword'), ' ',
tags.span(name, class_='py-defname'), signature(self.ob), ':'
]
@renderer
def sourceLink(self, request, tag):
if self.ob.sourceHref:
return tag.fillSlots(sourceHref=self.ob.sourceHref)
else:
return ()
@renderer
def functionExtras(self, request, tag):
return self._functionExtras
@renderer
def functionBody(self, request, tag):
return self.docgetter.get(self.ob)
@renderer
def functionDeprecated(self, request, tag):
if hasattr(self.ob, "_deprecated_info"):
return (tags.div(self.ob._deprecated_info, role="alert", class_="deprecationNotice alert alert-warning"),)
else:
return ()
class AttributeChild(Element):
loader = XMLFile(util.templatefilepath('attribute-child.html'))
def __init__(self, docgetter, ob, functionExtras):
self.docgetter = docgetter
self.ob = ob
self._functionExtras = functionExtras
@renderer
def class_(self, request, tag):
class_ = self.ob.css_class
if self.ob.parent is not self.ob:
class_ = 'base' + class_
return class_
@renderer
def functionAnchor(self, request, tag):
return self.ob.fullName()
@renderer
def shortFunctionAnchor(self, request, tag):
return self.ob.name
@renderer
def decorator(self, request, tag):
return list(format_decorators(self.ob))
@renderer
def attribute(self, request, tag):
return self.ob.name
@renderer
def sourceLink(self, request, tag):
if self.ob.sourceHref:
return tag.fillSlots(sourceHref=self.ob.sourceHref)
else:
return ()
@renderer
def functionExtras(self, request, tag):
return self._functionExtras
@renderer
def functionBody(self, request, tag):
return self.docgetter.get(self.ob)
@renderer
def functionDeprecated(self, request, tag):
if hasattr(self.ob, "_deprecated_info"):
return (tags.div(self.ob._deprecated_info,
role="alert",
class_="deprecationNotice alert alert-warning"), )
else:
return ()
class AttributeChild(Element):
loader = XMLFile(util.templatefilepath('attribute-child.html'))
def __init__(self, docgetter, ob, functionExtras):
self.docgetter = docgetter
self.ob = ob
self._functionExtras = functionExtras
@renderer
def class_(self, request, tag):
class_ = self.ob.css_class
if self.ob.parent is not self.ob:
class_ = 'base' + class_
return class_
@renderer
def functionAnchor(self, request, tag):
return self.ob.fullName()
@renderer
def shortFunctionAnchor(self, request, tag):
return self.ob.name
@renderer
def attribute(self, request, tag):
return self.ob.name
@renderer
def sourceLink(self, request, tag):
if self.ob.sourceHref:
return tag.fillSlots(sourceHref=self.ob.sourceHref)
else:
return ()
@renderer
def functionExtras(self, request, tag):
return self._functionExtras
@renderer
def functionBody(self, request, tag):
return self.docgetter.get(self.ob)
def loader(self):
return XMLFile(util.templatefilepath('summary.html'))
def loader(self):
return XMLFile(util.templatefilepath('index.html'))
def loader(self):
return XMLFile(util.templatefilepath('common.html'))
class FunctionChild(Element):
loader = XMLFile(util.templatefilepath('function-child.html'))
def __init__(self, docgetter, ob, functionExtras):
self.docgetter = docgetter
self.ob = ob
self._functionExtras = functionExtras
@renderer
def class_(self, request, tag):
class_ = self.ob.css_class
if self.ob.parent is not self.ob:
class_ = 'base' + class_
return class_
@renderer
def functionAnchor(self, request, tag):
return self.ob.fullName()
@renderer
def shortFunctionAnchor(self, request, tag):
return self.ob.name
@renderer
def decorator(self, request, tag):
decorators = []
if self.ob.decorators:
for dec in self.ob.decorators:
if isinstance(dec, ast.Call):
if isinstance(dec.func, ast.Name):
fn = self.ob.expandName(dec.func.id)
# We don't want to show the deprecated decorator, it shows up
# as an infobox
if fn == "twisted.python.deprecate.deprecated":
break
decorators.append(astor.to_source(dec).strip())
if decorators:
decorator = [('@' + dec, tags.br()) for dec in decorators]
else:
decorator = ()
return decorator
@renderer
def functionName(self, request, tag):
return [self.ob.name, '(', signature(self.ob.argspec), '):']
@renderer
def sourceLink(self, request, tag):
if self.ob.sourceHref:
return tag.fillSlots(sourceHref=self.ob.sourceHref)
else:
return ()
@renderer
def functionExtras(self, request, tag):
return self._functionExtras
@renderer
def functionBody(self, request, tag):
return self.docgetter.get(self.ob)
@renderer
def functionDeprecated(self, request, tag):
if hasattr(self.ob, "_deprecated_info"):
return (tags.div(self.ob._deprecated_info, role="alert", class_="deprecationNotice alert alert-warning"),)
else:
return ()
class FunctionChild(Element):
loader = XMLFile(util.templatefilepath("function-child.html"))
def __init__(self, docgetter, ob, functionExtras):
self.docgetter = docgetter
self.ob = ob
self._functionExtras = functionExtras
@renderer
def class_(self, request, tag):
class_ = self.ob.css_class
if self.ob.parent is not self.ob:
class_ = "base" + class_
return class_
@renderer
def functionAnchor(self, request, tag):
return self.ob.fullName()
@renderer
def shortFunctionAnchor(self, request, tag):
return self.ob.name
@renderer
def decorator(self, request, tag):
decorators = []
if self.ob.decorators:
for dec in self.ob.decorators:
if isinstance(dec.asList()[0], ast.Name):
fn = self.ob.expandName(dec.asList()[0].name)
# We don't want to show the deprecated decorator, it shows up
# as an infobox
if fn == "twisted.python.deprecate.deprecated":
break
decorators.append(ast_pp.pp(dec))
if self.ob.kind == "Class Method" and "classmethod" not in decorators:
decorators.append("classmethod")
elif self.ob.kind == "Static Method" and "staticmethod" not in decorators:
decorators.append("staticmethod")
if decorators:
decorator = [("@" + dec, tags.br()) for dec in decorators]
else:
decorator = ()
return decorator
@renderer
def functionName(self, request, tag):
return [self.ob.name, "(", signature(self.ob.argspec), "):"]
@renderer
def sourceLink(self, request, tag):
if self.ob.sourceHref:
return tag.fillSlots(sourceHref=self.ob.sourceHref)
else:
return ()
@renderer
def functionExtras(self, request, tag):
return self._functionExtras
@renderer
def functionBody(self, request, tag):
return self.docgetter.get(self.ob)
@renderer
def functionDeprecated(self, request, tag):
if hasattr(self.ob, "_deprecated_info"):
return (tags.div(
self.ob._deprecated_info,
role="alert",
class_="deprecationNotice alert alert-warning",
), )
else:
return ()
def loader(self):
return XMLFile(util.templatefilepath("nameIndex.html"))
