genshi/mirror: genshi/output.py annotate

annotate genshi/output.py @ 230:84168828b074 trunk

Renamed Markup to Genshi in repository.

author	cmlenz
date	Mon, 11 Sep 2006 15:07:07 +0000
parents	markup/output.py@ebceef564b79
children	ce848f7c41f1

rev	line source
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	1 # -- coding: utf-8 --
5479aae32f5a Initial import. cmlenz parents: diff changeset	2 #
66 59eb24184e9c Switch copyright to Edgewall and URLs to markup.edgewall.org. cmlenz parents: 27 diff changeset	3 # Copyright (C) 2006 Edgewall Software
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	4 # All rights reserved.
5479aae32f5a Initial import. cmlenz parents: diff changeset	5 #
5479aae32f5a Initial import. cmlenz parents: diff changeset	6 # This software is licensed as described in the file COPYING, which
5479aae32f5a Initial import. cmlenz parents: diff changeset	7 # you should have received as part of this distribution. The terms
230 84168828b074 Renamed Markup to Genshi in repository. cmlenz parents: 219 diff changeset	8 # are also available at http://genshi.edgewall.org/wiki/License.
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	9 #
5479aae32f5a Initial import. cmlenz parents: diff changeset	10 # This software consists of voluntary contributions made by many
5479aae32f5a Initial import. cmlenz parents: diff changeset	11 # individuals. For the exact contribution history, see the revision
230 84168828b074 Renamed Markup to Genshi in repository. cmlenz parents: 219 diff changeset	12 # history and logs, available at http://genshi.edgewall.org/log/.
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	13
5479aae32f5a Initial import. cmlenz parents: diff changeset	14 """This module provides different kinds of serialization methods for XML event
5479aae32f5a Initial import. cmlenz parents: diff changeset	15 streams.
5479aae32f5a Initial import. cmlenz parents: diff changeset	16 """
5479aae32f5a Initial import. cmlenz parents: diff changeset	17
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	18 from itertools import chain
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	19 try:
5479aae32f5a Initial import. cmlenz parents: diff changeset	20 frozenset
5479aae32f5a Initial import. cmlenz parents: diff changeset	21 except NameError:
5479aae32f5a Initial import. cmlenz parents: diff changeset	22 from sets import ImmutableSet as frozenset
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	23 import re
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	24
230 84168828b074 Renamed Markup to Genshi in repository. cmlenz parents: 219 diff changeset	25 from genshi.core import escape, Markup, Namespace, QName, StreamEventKind
84168828b074 Renamed Markup to Genshi in repository. cmlenz parents: 219 diff changeset	26 from genshi.core import DOCTYPE, START, END, START_NS, TEXT, START_CDATA, \
145 47bbd9d2a5af * Fix error in expression evaluation when the expression evaluates to an iterable that does not produce event tuples. cmlenz parents: 143 diff changeset	27 END_CDATA, PI, COMMENT, XML_NAMESPACE
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	28
200 5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	29 __all__ = ['DocType', 'XMLSerializer', 'XHTMLSerializer', 'HTMLSerializer',
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	30 'TextSerializer']
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	31
5479aae32f5a Initial import. cmlenz parents: diff changeset	32
85 4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	33 class DocType(object):
4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	34 """Defines a number of commonly used DOCTYPE declarations as constants."""
4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	35
4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	36 HTML_STRICT = ('html', '-//W3C//DTD HTML 4.01//EN',
4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	37 'http://www.w3.org/TR/html4/strict.dtd')
4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	38 HTML_TRANSITIONAL = ('html', '-//W3C//DTD HTML 4.01 Transitional//EN',
4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	39 'http://www.w3.org/TR/html4/loose.dtd')
4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	40 HTML = HTML_STRICT
4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	41
4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	42 XHTML_STRICT = ('html', '-//W3C//DTD XHTML 1.0 Strict//EN',
4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	43 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd')
4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	44 XHTML_TRANSITIONAL = ('html', '-//W3C//DTD XHTML 1.0 Transitional//EN',
4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	45 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd')
4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	46 XHTML = XHTML_STRICT
4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	47
4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	48
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	49 class XMLSerializer(object):
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	50 """Produces XML text from an event stream.
5479aae32f5a Initial import. cmlenz parents: diff changeset	51
230 84168828b074 Renamed Markup to Genshi in repository. cmlenz parents: 219 diff changeset	52 >>> from genshi.builder import tag
20 cc92d74ce9e5 Fix tests broken in [20]. cmlenz parents: 19 diff changeset	53 >>> elem = tag.div(tag.a(href='foo'), tag.br, tag.hr(noshade=True))
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	54 >>> print ''.join(XMLSerializer()(elem.generate()))
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	55 <div><a href="foo"/><br/><hr noshade="True"/></div>
5479aae32f5a Initial import. cmlenz parents: diff changeset	56 """
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	57
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	58 _PRESERVE_SPACE = frozenset()
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	59
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	60 def __init__(self, doctype=None, strip_whitespace=True):
85 4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	61 """Initialize the XML serializer.
4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	62
4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	63 @param doctype: a `(name, pubid, sysid)` tuple that represents the
4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	64 DOCTYPE declaration that should be included at the top of the
4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	65 generated output
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	66 @param strip_whitespace: whether extraneous whitespace should be
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	67 stripped from the output
85 4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	68 """
4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	69 self.preamble = []
4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	70 if doctype:
4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	71 self.preamble.append((DOCTYPE, doctype, (None, -1, -1)))
212 0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	72 self.filters = [EmptyTagFilter()]
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	73 if strip_whitespace:
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	74 self.filters.append(WhitespaceFilter(self._PRESERVE_SPACE))
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	75
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	76 def __call__(self, stream):
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	77 ns_attrib = []
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	78 ns_mapping = {XML_NAMESPACE.uri: 'xml'}
143 3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	79 have_doctype = False
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	80 in_cdata = False
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	81
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	82 stream = chain(self.preamble, stream)
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	83 for filter_ in self.filters:
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	84 stream = filter_(stream)
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	85 for kind, data, pos in stream:
5479aae32f5a Initial import. cmlenz parents: diff changeset	86
212 0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	87 if kind is START or kind is EMPTY:
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	88 tag, attrib = data
5479aae32f5a Initial import. cmlenz parents: diff changeset	89
5479aae32f5a Initial import. cmlenz parents: diff changeset	90 tagname = tag.localname
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	91 namespace = tag.namespace
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	92 if namespace:
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	93 if namespace in ns_mapping:
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	94 prefix = ns_mapping[namespace]
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	95 if prefix:
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	96 tagname = '%s:%s' % (prefix, tagname)
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	97 else:
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	98 ns_attrib.append((QName('xmlns'), namespace))
136 b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	99 buf = ['<', tagname]
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	100
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	101 for attr, value in attrib + ns_attrib:
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	102 attrname = attr.localname
5479aae32f5a Initial import. cmlenz parents: diff changeset	103 if attr.namespace:
26 3c1a022be04c * Split out the XPath tests into a separate `unittest`-based file. cmlenz parents: 20 diff changeset	104 prefix = ns_mapping.get(attr.namespace)
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	105 if prefix:
69 c40a5dcd2b55 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	106 attrname = '%s:%s' % (prefix, attrname)
136 b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	107 buf += [' ', attrname, '="', escape(value), '"']
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	108 ns_attrib = []
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	109
212 0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	110 if kind is EMPTY:
136 b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	111 buf += ['/>']
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	112 else:
136 b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	113 buf += ['>']
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	114
5479aae32f5a Initial import. cmlenz parents: diff changeset	115 yield Markup(''.join(buf))
5479aae32f5a Initial import. cmlenz parents: diff changeset	116
69 c40a5dcd2b55 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	117 elif kind is END:
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	118 tag = data
5479aae32f5a Initial import. cmlenz parents: diff changeset	119 tagname = tag.localname
5479aae32f5a Initial import. cmlenz parents: diff changeset	120 if tag.namespace:
26 3c1a022be04c * Split out the XPath tests into a separate `unittest`-based file. cmlenz parents: 20 diff changeset	121 prefix = ns_mapping.get(tag.namespace)
3c1a022be04c * Split out the XPath tests into a separate `unittest`-based file. cmlenz parents: 20 diff changeset	122 if prefix:
69 c40a5dcd2b55 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	123 tagname = '%s:%s' % (prefix, tag.localname)
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	124 yield Markup('</%s>' % tagname)
5479aae32f5a Initial import. cmlenz parents: diff changeset	125
69 c40a5dcd2b55 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	126 elif kind is TEXT:
143 3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	127 if in_cdata:
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	128 yield data
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	129 else:
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	130 yield escape(data, quotes=False)
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	131
89 80386d62814f Support comments in templates that are not included in the output, in the same way Kid does: if the comment text starts with a `!` character, it is stripped from the output. cmlenz parents: 85 diff changeset	132 elif kind is COMMENT:
80386d62814f Support comments in templates that are not included in the output, in the same way Kid does: if the comment text starts with a `!` character, it is stripped from the output. cmlenz parents: 85 diff changeset	133 yield Markup('<!--%s-->' % data)
80386d62814f Support comments in templates that are not included in the output, in the same way Kid does: if the comment text starts with a `!` character, it is stripped from the output. cmlenz parents: 85 diff changeset	134
136 b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	135 elif kind is DOCTYPE and not have_doctype:
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	136 name, pubid, sysid = data
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	137 buf = ['<!DOCTYPE %s']
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	138 if pubid:
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	139 buf += [' PUBLIC "%s"']
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	140 elif sysid:
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	141 buf += [' SYSTEM']
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	142 if sysid:
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	143 buf += [' "%s"']
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	144 buf += ['>\n']
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	145 yield Markup(''.join(buf), *filter(None, data))
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	146 have_doctype = True
109 230ee6a2c6b2 Reorder the conditional branches in the serializers so that the more common event kinds are on top. cmlenz parents: 105 diff changeset	147
230ee6a2c6b2 Reorder the conditional branches in the serializers so that the more common event kinds are on top. cmlenz parents: 105 diff changeset	148 elif kind is START_NS:
230ee6a2c6b2 Reorder the conditional branches in the serializers so that the more common event kinds are on top. cmlenz parents: 105 diff changeset	149 prefix, uri = data
230ee6a2c6b2 Reorder the conditional branches in the serializers so that the more common event kinds are on top. cmlenz parents: 105 diff changeset	150 if uri not in ns_mapping:
230ee6a2c6b2 Reorder the conditional branches in the serializers so that the more common event kinds are on top. cmlenz parents: 105 diff changeset	151 ns_mapping[uri] = prefix
230ee6a2c6b2 Reorder the conditional branches in the serializers so that the more common event kinds are on top. cmlenz parents: 105 diff changeset	152 if not prefix:
230ee6a2c6b2 Reorder the conditional branches in the serializers so that the more common event kinds are on top. cmlenz parents: 105 diff changeset	153 ns_attrib.append((QName('xmlns'), uri))
230ee6a2c6b2 Reorder the conditional branches in the serializers so that the more common event kinds are on top. cmlenz parents: 105 diff changeset	154 else:
230ee6a2c6b2 Reorder the conditional branches in the serializers so that the more common event kinds are on top. cmlenz parents: 105 diff changeset	155 ns_attrib.append((QName('xmlns:%s' % prefix), uri))
230ee6a2c6b2 Reorder the conditional branches in the serializers so that the more common event kinds are on top. cmlenz parents: 105 diff changeset	156
143 3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	157 elif kind is START_CDATA:
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	158 yield Markup('<![CDATA[')
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	159 in_cdata = True
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	160
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	161 elif kind is END_CDATA:
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	162 yield Markup(']]>')
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	163 in_cdata = False
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	164
105 71f3db26eecb Include processing instructions in serialized streams. cmlenz parents: 96 diff changeset	165 elif kind is PI:
71f3db26eecb Include processing instructions in serialized streams. cmlenz parents: 96 diff changeset	166 yield Markup('<?%s %s?>' % data)
71f3db26eecb Include processing instructions in serialized streams. cmlenz parents: 96 diff changeset	167
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	168
96 fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	169 class XHTMLSerializer(XMLSerializer):
fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	170 """Produces XHTML text from an event stream.
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	171
230 84168828b074 Renamed Markup to Genshi in repository. cmlenz parents: 219 diff changeset	172 >>> from genshi.builder import tag
20 cc92d74ce9e5 Fix tests broken in [20]. cmlenz parents: 19 diff changeset	173 >>> elem = tag.div(tag.a(href='foo'), tag.br, tag.hr(noshade=True))
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	174 >>> print ''.join(XHTMLSerializer()(elem.generate()))
96 fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	175 <div><a href="foo"></a><br /><hr noshade="noshade" /></div>
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	176 """
5479aae32f5a Initial import. cmlenz parents: diff changeset	177
18 5420cfe42d36 Actually make use of the `markup.core.Namespace` class, and add a couple of doctests. cmlenz parents: 1 diff changeset	178 NAMESPACE = Namespace('http://www.w3.org/1999/xhtml')
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	179
5479aae32f5a Initial import. cmlenz parents: diff changeset	180 _EMPTY_ELEMS = frozenset(['area', 'base', 'basefont', 'br', 'col', 'frame',
5479aae32f5a Initial import. cmlenz parents: diff changeset	181 'hr', 'img', 'input', 'isindex', 'link', 'meta',
5479aae32f5a Initial import. cmlenz parents: diff changeset	182 'param'])
5479aae32f5a Initial import. cmlenz parents: diff changeset	183 _BOOLEAN_ATTRS = frozenset(['selected', 'checked', 'compact', 'declare',
5479aae32f5a Initial import. cmlenz parents: diff changeset	184 'defer', 'disabled', 'ismap', 'multiple',
5479aae32f5a Initial import. cmlenz parents: diff changeset	185 'nohref', 'noresize', 'noshade', 'nowrap'])
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	186 _PRESERVE_SPACE = frozenset([QName('pre'), QName('textarea')])
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	187
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	188 def __call__(self, stream):
136 b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	189 namespace = self.NAMESPACE
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	190 ns_attrib = []
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	191 ns_mapping = {XML_NAMESPACE.uri: 'xml'}
136 b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	192 boolean_attrs = self._BOOLEAN_ATTRS
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	193 empty_elems = self._EMPTY_ELEMS
85 4938c310d904 Improve handling of DOCTYPE declarations. cmlenz parents: 73 diff changeset	194 have_doctype = False
143 3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	195 in_cdata = False
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	196
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	197 stream = chain(self.preamble, stream)
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	198 for filter_ in self.filters:
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	199 stream = filter_(stream)
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	200 for kind, data, pos in stream:
5479aae32f5a Initial import. cmlenz parents: diff changeset	201
212 0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	202 if kind is START or kind is EMPTY:
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	203 tag, attrib = data
96 fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	204
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	205 tagname = tag.localname
177 553866249cb0 * Minor fix for the XHTML serializer (the local namespace var got clobbered) cmlenz parents: 158 diff changeset	206 tagns = tag.namespace
553866249cb0 * Minor fix for the XHTML serializer (the local namespace var got clobbered) cmlenz parents: 158 diff changeset	207 if tagns:
553866249cb0 * Minor fix for the XHTML serializer (the local namespace var got clobbered) cmlenz parents: 158 diff changeset	208 if tagns in ns_mapping:
553866249cb0 * Minor fix for the XHTML serializer (the local namespace var got clobbered) cmlenz parents: 158 diff changeset	209 prefix = ns_mapping[tagns]
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	210 if prefix:
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	211 tagname = '%s:%s' % (prefix, tagname)
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	212 else:
177 553866249cb0 * Minor fix for the XHTML serializer (the local namespace var got clobbered) cmlenz parents: 158 diff changeset	213 ns_attrib.append((QName('xmlns'), tagns))
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	214 buf = ['<', tagname]
136 b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	215
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	216 for attr, value in attrib + ns_attrib:
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	217 attrname = attr.localname
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	218 if attr.namespace:
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	219 prefix = ns_mapping.get(attr.namespace)
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	220 if prefix:
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	221 attrname = '%s:%s' % (prefix, attrname)
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	222 if attrname in boolean_attrs:
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	223 if value:
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	224 buf += [' ', attrname, '="', attrname, '"']
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	225 else:
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	226 buf += [' ', attrname, '="', escape(value), '"']
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	227 ns_attrib = []
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	228
212 0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	229 if kind is EMPTY:
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	230 if (tagns and tagns != namespace.uri) \
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	231 or tag.localname in empty_elems:
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	232 buf += [' />']
96 fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	233 else:
212 0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	234 buf += ['></%s>' % tagname]
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	235 else:
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	236 buf += ['>']
96 fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	237
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	238 yield Markup(''.join(buf))
96 fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	239
fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	240 elif kind is END:
fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	241 tag = data
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	242 tagname = tag.localname
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	243 if tag.namespace:
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	244 prefix = ns_mapping.get(tag.namespace)
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	245 if prefix:
177 553866249cb0 * Minor fix for the XHTML serializer (the local namespace var got clobbered) cmlenz parents: 158 diff changeset	246 tagname = '%s:%s' % (prefix, tagname)
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	247 yield Markup('</%s>' % tagname)
96 fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	248
fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	249 elif kind is TEXT:
143 3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	250 if in_cdata:
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	251 yield data
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	252 else:
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	253 yield escape(data, quotes=False)
96 fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	254
fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	255 elif kind is COMMENT:
fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	256 yield Markup('<!--%s-->' % data)
fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	257
136 b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	258 elif kind is DOCTYPE and not have_doctype:
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	259 name, pubid, sysid = data
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	260 buf = ['<!DOCTYPE %s']
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	261 if pubid:
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	262 buf += [' PUBLIC "%s"']
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	263 elif sysid:
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	264 buf += [' SYSTEM']
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	265 if sysid:
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	266 buf += [' "%s"']
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	267 buf += ['>\n']
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	268 yield Markup(''.join(buf), *filter(None, data))
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	269 have_doctype = True
109 230ee6a2c6b2 Reorder the conditional branches in the serializers so that the more common event kinds are on top. cmlenz parents: 105 diff changeset	270
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	271 elif kind is START_NS:
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	272 prefix, uri = data
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	273 if uri not in ns_mapping:
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	274 ns_mapping[uri] = prefix
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	275 if not prefix:
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	276 ns_attrib.append((QName('xmlns'), uri))
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	277 else:
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	278 ns_attrib.append((QName('xmlns:%s' % prefix), uri))
109 230ee6a2c6b2 Reorder the conditional branches in the serializers so that the more common event kinds are on top. cmlenz parents: 105 diff changeset	279
143 3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	280 elif kind is START_CDATA:
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	281 yield Markup('<![CDATA[')
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	282 in_cdata = True
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	283
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	284 elif kind is END_CDATA:
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	285 yield Markup(']]>')
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	286 in_cdata = False
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	287
105 71f3db26eecb Include processing instructions in serialized streams. cmlenz parents: 96 diff changeset	288 elif kind is PI:
71f3db26eecb Include processing instructions in serialized streams. cmlenz parents: 96 diff changeset	289 yield Markup('<?%s %s?>' % data)
71f3db26eecb Include processing instructions in serialized streams. cmlenz parents: 96 diff changeset	290
96 fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	291
fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	292 class HTMLSerializer(XHTMLSerializer):
fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	293 """Produces HTML text from an event stream.
fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	294
230 84168828b074 Renamed Markup to Genshi in repository. cmlenz parents: 219 diff changeset	295 >>> from genshi.builder import tag
96 fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	296 >>> elem = tag.div(tag.a(href='foo'), tag.br, tag.hr(noshade=True))
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	297 >>> print ''.join(HTMLSerializer()(elem.generate()))
96 fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	298 <div><a href="foo"></a><br><hr noshade></div>
fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	299 """
fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	300
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	301 _NOESCAPE_ELEMS = frozenset([QName('script'), QName('style')])
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	302
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	303 def __init__(self, doctype=None, strip_whitespace=True):
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	304 """Initialize the HTML serializer.
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	305
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	306 @param doctype: a `(name, pubid, sysid)` tuple that represents the
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	307 DOCTYPE declaration that should be included at the top of the
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	308 generated output
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	309 @param strip_whitespace: whether extraneous whitespace should be
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	310 stripped from the output
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	311 """
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	312 super(HTMLSerializer, self).__init__(doctype, False)
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	313 if strip_whitespace:
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	314 self.filters.append(WhitespaceFilter(self._PRESERVE_SPACE,
143 3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	315 self._NOESCAPE_ELEMS, True))
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	316
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	317 def __call__(self, stream):
136 b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	318 namespace = self.NAMESPACE
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	319 ns_mapping = {}
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	320 boolean_attrs = self._BOOLEAN_ATTRS
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	321 empty_elems = self._EMPTY_ELEMS
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	322 noescape_elems = self._NOESCAPE_ELEMS
96 fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	323 have_doctype = False
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	324 noescape = False
96 fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	325
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	326 stream = chain(self.preamble, stream)
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	327 for filter_ in self.filters:
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	328 stream = filter_(stream)
96 fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	329 for kind, data, pos in stream:
fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	330
212 0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	331 if kind is START or kind is EMPTY:
96 fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	332 tag, attrib = data
136 b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	333 if not tag.namespace or tag in namespace:
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	334 tagname = tag.localname
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	335 buf = ['<', tagname]
96 fa08aef181a2 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module. cmlenz parents: 89 diff changeset	336
136 b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	337 for attr, value in attrib:
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	338 attrname = attr.localname
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	339 if not attr.namespace or attr in namespace:
136 b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	340 if attrname in boolean_attrs:
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	341 if value:
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	342 buf += [' ', attrname]
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	343 else:
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	344 buf += [' ', attrname, '="', escape(value), '"']
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	345
212 0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	346 buf += ['>']
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	347
212 0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	348 if kind is EMPTY:
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	349 if tagname not in empty_elems:
213 13d2d4420628 Store original message in exceptions as `msg` ivar. cmlenz parents: 212 diff changeset	350 buf += ['</%s>' % tagname]
212 0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	351
140 c1f4390d50f8 Fix bug in HTML serializer, plus some other minor tweaks. cmlenz parents: 136 diff changeset	352 yield Markup(''.join(buf))
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	353
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	354 if tagname in noescape_elems:
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	355 noescape = True
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	356
69 c40a5dcd2b55 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	357 elif kind is END:
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	358 tag = data
136 b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	359 if not tag.namespace or tag in namespace:
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	360 yield Markup('</%s>' % tag.localname)
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	361
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	362 noescape = False
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	363
69 c40a5dcd2b55 A couple of minor performance improvements. cmlenz parents: 66 diff changeset	364 elif kind is TEXT:
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	365 if noescape:
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	366 yield data
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	367 else:
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	368 yield escape(data, quotes=False)
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	369
89 80386d62814f Support comments in templates that are not included in the output, in the same way Kid does: if the comment text starts with a `!` character, it is stripped from the output. cmlenz parents: 85 diff changeset	370 elif kind is COMMENT:
80386d62814f Support comments in templates that are not included in the output, in the same way Kid does: if the comment text starts with a `!` character, it is stripped from the output. cmlenz parents: 85 diff changeset	371 yield Markup('<!--%s-->' % data)
80386d62814f Support comments in templates that are not included in the output, in the same way Kid does: if the comment text starts with a `!` character, it is stripped from the output. cmlenz parents: 85 diff changeset	372
136 b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	373 elif kind is DOCTYPE and not have_doctype:
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	374 name, pubid, sysid = data
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	375 buf = ['<!DOCTYPE %s']
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	376 if pubid:
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	377 buf += [' PUBLIC "%s"']
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	378 elif sysid:
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	379 buf += [' SYSTEM']
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	380 if sysid:
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	381 buf += [' "%s"']
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	382 buf += ['>\n']
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	383 yield Markup(''.join(buf), *filter(None, data))
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	384 have_doctype = True
109 230ee6a2c6b2 Reorder the conditional branches in the serializers so that the more common event kinds are on top. cmlenz parents: 105 diff changeset	385
136 b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	386 elif kind is START_NS and data[1] not in ns_mapping:
b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	387 ns_mapping[data[1]] = data[0]
109 230ee6a2c6b2 Reorder the conditional branches in the serializers so that the more common event kinds are on top. cmlenz parents: 105 diff changeset	388
105 71f3db26eecb Include processing instructions in serialized streams. cmlenz parents: 96 diff changeset	389 elif kind is PI:
71f3db26eecb Include processing instructions in serialized streams. cmlenz parents: 96 diff changeset	390 yield Markup('<?%s %s?>' % data)
71f3db26eecb Include processing instructions in serialized streams. cmlenz parents: 96 diff changeset	391
1 5479aae32f5a Initial import. cmlenz parents: diff changeset	392
200 5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	393 class TextSerializer(object):
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	394 """Produces plain text from an event stream.
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	395
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	396 Only text events are included in the output. Unlike the other serializer,
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	397 special XML characters are not escaped:
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	398
230 84168828b074 Renamed Markup to Genshi in repository. cmlenz parents: 219 diff changeset	399 >>> from genshi.builder import tag
200 5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	400 >>> elem = tag.div(tag.a('<Hello!>', href='foo'), tag.br)
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	401 >>> print elem
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	402 <div><a href="foo"><Hello!></a><br/></div>
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	403 >>> print ''.join(TextSerializer()(elem.generate()))
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	404 <Hello!>
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	405
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	406 If text events contain literal markup (instances of the `Markup` class),
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	407 tags or entities are stripped from the output:
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	408
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	409 >>> elem = tag.div(Markup('<a href="foo">Hello!</a><br/>'))
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	410 >>> print elem
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	411 <div><a href="foo">Hello!</a><br/></div>
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	412 >>> print ''.join(TextSerializer()(elem.generate()))
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	413 Hello!
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	414 """
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	415
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	416 def __call__(self, stream):
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	417 for kind, data, pos in stream:
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	418 if kind is TEXT:
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	419 if type(data) is Markup:
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	420 data = data.striptags().stripentities()
201 c5e0a1c86173 The `TextSerializer` should produce `unicode` objects, not `Markup` objects. cmlenz parents: 200 diff changeset	421 yield unicode(data)
200 5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	422
5861f4446c26 Add serialization to plain text, based on cboos' patch. Closes #41. cmlenz parents: 178 diff changeset	423
212 0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	424 class EmptyTagFilter(object):
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	425 """Combines `START` and `STOP` events into `EMPTY` events for elements that
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	426 have no contents.
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	427 """
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	428
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	429 EMPTY = StreamEventKind('EMPTY')
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	430
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	431 def __call__(self, stream):
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	432 prev = (None, None, None)
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	433 for kind, data, pos in stream:
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	434 if prev[0] is START:
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	435 if kind is END:
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	436 prev = EMPTY, prev[1], prev[2]
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	437 yield prev
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	438 continue
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	439 else:
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	440 yield prev
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	441 if kind is not START:
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	442 yield kind, data, pos
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	443 prev = kind, data, pos
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	444
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	445
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	446 EMPTY = EmptyTagFilter.EMPTY
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	447
0141f45c18e1 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator. cmlenz parents: 201 diff changeset	448
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	449 class WhitespaceFilter(object):
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	450 """A filter that removes extraneous ignorable white space from the
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	451 stream."""
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	452
143 3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	453 def __init__(self, preserve=None, noescape=None, escape_cdata=False):
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	454 """Initialize the filter.
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	455
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	456 @param preserve: a set or sequence of tag names for which white-space
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	457 should be ignored.
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	458 @param noescape: a set or sequence of tag names for which text content
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	459 should not be escaped
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	460
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	461 Both the `preserve` and `noescape` sets are expected to refer to
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	462 elements that cannot contain further child elements.
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	463 """
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	464 if preserve is None:
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	465 preserve = []
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	466 self.preserve = frozenset(preserve)
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	467 if noescape is None:
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	468 noescape = []
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	469 self.noescape = frozenset(noescape)
143 3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	470 self.escape_cdata = escape_cdata
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	471
219 ebceef564b79 Minor improvements to `WhitespaceFilter`. cmlenz parents: 213 diff changeset	472 def __call__(self, stream, ctxt=None, space=XML_NAMESPACE['space'],
ebceef564b79 Minor improvements to `WhitespaceFilter`. cmlenz parents: 213 diff changeset	473 trim_trailing_space=re.compile('[ \t]+(?=\n)').sub,
ebceef564b79 Minor improvements to `WhitespaceFilter`. cmlenz parents: 213 diff changeset	474 collapse_lines=re.compile('\n{2,}').sub):
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	475 mjoin = Markup('').join
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	476 preserve_elems = self.preserve
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	477 preserve = False
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	478 noescape_elems = self.noescape
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	479 noescape = False
143 3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	480 escape_cdata = self.escape_cdata
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	481
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	482 textbuf = []
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	483 push_text = textbuf.append
136 b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	484 pop_text = textbuf.pop
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	485 for kind, data, pos in chain(stream, [(None, None, None)]):
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	486 if kind is TEXT:
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	487 if noescape:
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	488 data = Markup(data)
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	489 push_text(data)
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	490 else:
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	491 if textbuf:
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	492 if len(textbuf) > 1:
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	493 text = mjoin(textbuf, escape_quotes=False)
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	494 del textbuf[:]
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	495 else:
136 b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	496 text = escape(pop_text(), quotes=False)
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	497 if not preserve:
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	498 text = collapse_lines('\n', trim_trailing_space('', text))
10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	499 yield TEXT, Markup(text), pos
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	500
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	501 if kind is START:
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	502 tag, attrib = data
219 ebceef564b79 Minor improvements to `WhitespaceFilter`. cmlenz parents: 213 diff changeset	503 if not preserve and (tag in preserve_elems or
ebceef564b79 Minor improvements to `WhitespaceFilter`. cmlenz parents: 213 diff changeset	504 attrib.get(space) == 'preserve'):
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	505 preserve = True
219 ebceef564b79 Minor improvements to `WhitespaceFilter`. cmlenz parents: 213 diff changeset	506 if not noescape and tag in noescape_elems:
141 520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	507 noescape = True
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	508
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	509 elif kind is END:
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	510 preserve = noescape = False
520a5b7dd6d2 * No escaping of `<script>` or `<style>` tags in HTML output (see #24) cmlenz parents: 140 diff changeset	511
143 3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	512 elif kind is START_CDATA and not escape_cdata:
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	513 noescape = True
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	514
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	515 elif kind is END_CDATA and not escape_cdata:
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	516 noescape = False
3d4c214c979a CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24. cmlenz parents: 141 diff changeset	517
136 b86f496f6035 Minor performance improvements in serialization. cmlenz parents: 123 diff changeset	518 if kind:
123 10279d2eeec9 Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved. cmlenz parents: 109 diff changeset	519 yield kind, data, pos

Mercurial > genshi > mirror

annotate genshi/output.py @ 230:84168828b074 trunk