twisted.web.template
module documentationtwisted.web
View Source
HTML rendering for twisted.web.
Variable | VALID_HTML_TAG_NAMES | A list of recognized HTML tag names, used by the tag object. |
Variable | TEMPLATE_NAMESPACE | The XML namespace used to identify attributes and elements used by the templating system, which should be removed from the final output document. |
Variable | tags | A convenience object which can produce Tag objects on demand
via attribute access. For example: tags.div is equivalent to
Tag("div") . Tags not specified in VALID_HTML_TAG_NAMES
will result in an AttributeError . |
Class | Tag | No summary |
Class | slot | Marker for markup insertion in a template. |
Class | Comment | A <!-- --> comment from a template. Given a separate
representation in the DOM so that they may be round-tripped through
rendering without losing information. |
Class | CDATA | A <![CDATA[]]> block from a template. Given a
separate representation in the DOM so that they may be round-tripped
through rendering without losing information. |
Class | CharRef | A numeric character reference. Given a separate representation in the DOM so that non-ASCII characters may be output as pure ASCII. |
Class | TagLoader | An ITemplateLoader
that loads existing IRenderable
providers. |
Class | XMLString | An ITemplateLoader
that loads and parses XML from a string. |
Class | XMLFile | An ITemplateLoader
that loads and parses XML from a file. |
Function | renderElement | Render an element or other IRenderable . |
Class | Element | Base for classes which can render part of a page. |
Function | renderer | Decorate with renderer to use
methods as template render directives. |
Function | flatten | Incrementally write out a string representation of root
using write . |
Function | flattenString | Collate a string representation of root into a single
string. |
Class | _NSContext | A mapping from XML namespaces onto their prefixes in the document. |
Class | _ToStan | A SAX parser which converts an XML document to the Twisted STAN Document Object Model. |
Function | _flatsaxParse | Perform a SAX parse of an XML document with the _ToStan class. |
Class | _TagFactory | A factory for Tag objects; the
implementation of the tags object. |
Tag
objects on demand
via attribute access. For example: tags.div
is equivalent to
Tag("div")
. Tags not specified in VALID_HTML_TAG_NAMES
will result in an AttributeError
.
Perform a SAX parse of an XML document with the _ToStan class.
Parameters | fl | The XML document to be parsed. (type: A file object or filename.) |
Returns | a list of Stan objects. |
Render an element or other IRenderable
.
Parameters | request | The Request being rendered to. |
element | An IRenderable which will be rendered. | |
doctype | A bytes which will be written as the first line of the
request, or None
to disable writing of a doctype. The string should not
include a trailing newline and will default to the HTML5 doctype
'<!DOCTYPE html>' . | |
Returns | NOT_DONE_YET | |
Present Since | 12.1 |
Decorate with renderer
to use
methods as template render directives.
For example:
class Foo(Element): @renderer def twiddle(self, request, tag): return tag('Hello, world.') <div xmlns:t="http://twistedmatrix.com/ns/twisted.web.template/0.1"> <span t:render="twiddle" /> </div>
Will result in this final output:
<div> <span>Hello, world.</span> </div>
Incrementally write out a string representation of root
using write
.
In order to create a string representation, root
will be
decomposed into simpler objects which will themselves be decomposed and so
on until strings or objects which can easily be converted to strings are
encountered.
Parameters | request | A request object which will be passed to the render method of
any IRenderable
provider which is encountered. |
root | An object to be made flatter. This may be of type unicode ,
bytes ,
slot , Tag , tuple ,
list ,
types.GeneratorType ,
Deferred ,
or something that provides IRenderable . | |
write | A callable which will be invoked with each bytes
produced by flattening root . | |
Returns | A Deferred
which will be called back when root has been completely
flattened into write or which will be errbacked if an
unexpected exception occurs. |
Collate a string representation of root
into a single
string.
This is basically gluing flatten
to an io.BytesIO
and returning the results. See flatten
for the
exact meanings of request
and root
.
Returns | A Deferred
which will be called back with a single string as its result when
root has been completely flattened into write or
which will be errbacked if an unexpected exception occurs. |