twisted.web.util._SourceFragmentElement(Element) class documentation

Part of twisted.web.util (View In Hierarchy)

_SourceFragmentElement is an IRenderable which can render several lines of source code near the line number of a particular frame object.

Instance Variable frame A Failure-style frame object for which to load a source line to render. This is really a tuple holding some information from a frame object. See Failure.frames for specifics.
Method __init__ Undocumented
Method sourceLines No summary
Method _getSourceLines Find the source line references by self.frame and yield, in source line order, it and the previous and following lines.

Inherited from Element:

Instance Variable loader The factory which will be used to load documents to return from render. (type: ITemplateLoader provider)
Method lookupRenderMethod Look up and return the named render method.
Method render Implement IRenderable to allow one Element to be embedded in another's template or rendering output.
frame =
A Failure-style frame object for which to load a source line to render. This is really a tuple holding some information from a frame object. See Failure.frames for specifics.
def __init__(self, loader, frame):
overrides twisted.web.template.Element.__init__
Undocumented
def _getSourceLines(self):

Find the source line references by self.frame and yield, in source line order, it and the previous and following lines.

ReturnsA generator which yields two-tuples. Each tuple gives a source line number and the contents of that source line.
@renderer
def sourceLines(self, request, tag):

Render the source line indicated by self.frame and several surrounding lines. The active line will be given a class of "snippetHighlightLine". Other lines will be given a class of "snippetLine".

API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.