Mercurial > genshi > mirror
annotate markup/output.py @ 19:704f10b06507 trunk
Enable `ElementFactory` to create namespaced elements.
| author | cmlenz |
|---|---|
| date | Mon, 19 Jun 2006 16:34:00 +0000 |
| parents | 5420cfe42d36 |
| children | cc92d74ce9e5 |
| rev | line source |
|---|---|
| 1 | 1 # -*- coding: utf-8 -*- |
| 2 # | |
| 3 # Copyright (C) 2006 Christopher Lenz | |
| 4 # All rights reserved. | |
| 5 # | |
| 6 # This software is licensed as described in the file COPYING, which | |
| 7 # you should have received as part of this distribution. The terms | |
| 8 # are also available at http://trac.edgewall.com/license.html. | |
| 9 # | |
| 10 # This software consists of voluntary contributions made by many | |
| 11 # individuals. For the exact contribution history, see the revision | |
| 12 # history and logs, available at http://projects.edgewall.com/trac/. | |
| 13 | |
| 14 """This module provides different kinds of serialization methods for XML event | |
| 15 streams. | |
| 16 """ | |
| 17 | |
| 18 try: | |
| 19 frozenset | |
| 20 except NameError: | |
| 21 from sets import ImmutableSet as frozenset | |
| 22 | |
|
18
5420cfe42d36
Actually make use of the `markup.core.Namespace` class, and add a couple of doctests.
cmlenz
parents:
1
diff
changeset
|
23 from markup.core import Markup, Namespace, QName, Stream |
| 1 | 24 from markup.filters import WhitespaceFilter |
| 25 | |
| 26 __all__ = ['Serializer', 'XMLSerializer', 'HTMLSerializer'] | |
| 27 | |
| 28 | |
| 29 class Serializer(object): | |
| 30 """Base class for serializers.""" | |
| 31 | |
| 32 def serialize(self, stream): | |
| 33 raise NotImplementedError | |
| 34 | |
| 35 | |
| 36 class XMLSerializer(Serializer): | |
| 37 """Produces XML text from an event stream. | |
| 38 | |
| 39 >>> from markup.builder import tag | |
| 40 >>> elem = tag.DIV(tag.A(href='foo'), tag.BR, tag.HR(noshade=True)) | |
| 41 >>> print ''.join(XMLSerializer().serialize(elem.generate())) | |
| 42 <div><a href="foo"/><br/><hr noshade="True"/></div> | |
| 43 """ | |
| 44 | |
| 45 def serialize(self, stream): | |
| 46 ns_attrib = [] | |
| 47 ns_mapping = {} | |
| 48 | |
| 49 stream = PushbackIterator(stream) | |
| 50 for kind, data, pos in stream: | |
| 51 | |
| 52 if kind is Stream.DOCTYPE: | |
| 53 # FIXME: what if there's no system or public ID in the input? | |
| 54 yield Markup('<!DOCTYPE %s "%s" "%s">\n' % data) | |
| 55 | |
| 56 elif kind is Stream.START_NS: | |
| 57 prefix, uri = data | |
| 58 if uri not in ns_mapping: | |
| 59 ns_mapping[uri] = prefix | |
| 60 if not prefix: | |
| 61 ns_attrib.append((QName('xmlns'), uri)) | |
| 62 else: | |
| 63 ns_attrib.append((QName('xmlns:%s' % prefix), uri)) | |
| 64 | |
| 65 elif kind is Stream.START: | |
| 66 tag, attrib = data | |
| 67 | |
| 68 tagname = tag.localname | |
| 69 if tag.namespace: | |
| 70 try: | |
| 71 prefix = ns_mapping[tag.namespace] | |
| 72 if prefix: | |
| 73 tagname = prefix + ':' + tag.localname | |
| 74 except KeyError: | |
| 75 ns_attrib.append((QName('xmlns'), tag.namespace)) | |
| 76 buf = ['<', tagname] | |
| 77 | |
| 78 if ns_attrib: | |
| 79 attrib.extend(ns_attrib) | |
| 80 ns_attrib = [] | |
| 81 for attr, value in attrib: | |
| 82 attrname = attr.localname | |
| 83 if attr.namespace: | |
| 84 try: | |
| 85 prefix = ns_mapping[attr.namespace] | |
| 86 except KeyError: | |
| 87 # FIXME: synthesize a prefix for the attribute? | |
| 88 prefix = '' | |
| 89 if prefix: | |
| 90 attrname = prefix + ':' + attrname | |
| 91 buf.append(' %s="%s"' % (attrname, Markup.escape(value))) | |
| 92 | |
| 93 kind, data, pos = stream.next() | |
| 94 if kind is Stream.END: | |
| 95 buf.append('/>') | |
| 96 else: | |
| 97 buf.append('>') | |
| 98 stream.pushback((kind, data, pos)) | |
| 99 | |
| 100 yield Markup(''.join(buf)) | |
| 101 | |
| 102 elif kind is Stream.END: | |
| 103 tag = data | |
| 104 tagname = tag.localname | |
| 105 if tag.namespace: | |
|
19
704f10b06507
Enable `ElementFactory` to create namespaced elements.
cmlenz
parents:
18
diff
changeset
|
106 try: |
|
704f10b06507
Enable `ElementFactory` to create namespaced elements.
cmlenz
parents:
18
diff
changeset
|
107 prefix = ns_mapping[tag.namespace] |
|
704f10b06507
Enable `ElementFactory` to create namespaced elements.
cmlenz
parents:
18
diff
changeset
|
108 if prefix: |
|
704f10b06507
Enable `ElementFactory` to create namespaced elements.
cmlenz
parents:
18
diff
changeset
|
109 tagname = prefix + ':' + tag.localname |
|
704f10b06507
Enable `ElementFactory` to create namespaced elements.
cmlenz
parents:
18
diff
changeset
|
110 except KeyError: |
|
704f10b06507
Enable `ElementFactory` to create namespaced elements.
cmlenz
parents:
18
diff
changeset
|
111 pass |
| 1 | 112 yield Markup('</%s>' % tagname) |
| 113 | |
| 114 elif kind is Stream.TEXT: | |
| 115 yield Markup.escape(data, quotes=False) | |
| 116 | |
| 117 | |
| 118 class HTMLSerializer(Serializer): | |
| 119 """Produces HTML text from an event stream. | |
| 120 | |
| 121 >>> from markup.builder import tag | |
| 122 >>> elem = tag.DIV(tag.A(href='foo'), tag.BR, tag.HR(noshade=True)) | |
| 123 >>> print ''.join(HTMLSerializer().serialize(elem.generate())) | |
| 124 <div><a href="foo"></a><br><hr noshade></div> | |
| 125 """ | |
| 126 | |
|
18
5420cfe42d36
Actually make use of the `markup.core.Namespace` class, and add a couple of doctests.
cmlenz
parents:
1
diff
changeset
|
127 NAMESPACE = Namespace('http://www.w3.org/1999/xhtml') |
| 1 | 128 |
| 129 _EMPTY_ELEMS = frozenset(['area', 'base', 'basefont', 'br', 'col', 'frame', | |
| 130 'hr', 'img', 'input', 'isindex', 'link', 'meta', | |
| 131 'param']) | |
| 132 _BOOLEAN_ATTRS = frozenset(['selected', 'checked', 'compact', 'declare', | |
| 133 'defer', 'disabled', 'ismap', 'multiple', | |
| 134 'nohref', 'noresize', 'noshade', 'nowrap']) | |
| 135 | |
| 136 def serialize(self, stream): | |
| 137 ns_mapping = {} | |
| 138 | |
| 139 stream = PushbackIterator(stream) | |
| 140 for kind, data, pos in stream: | |
| 141 | |
| 142 if kind is Stream.DOCTYPE: | |
| 143 yield Markup('<!DOCTYPE %s "%s" "%s">\n' % data) | |
| 144 | |
| 145 elif kind is Stream.START_NS: | |
| 146 prefix, uri = data | |
| 147 if uri not in ns_mapping: | |
| 148 ns_mapping[uri] = prefix | |
| 149 | |
| 150 elif kind is Stream.START: | |
| 151 tag, attrib = data | |
|
18
5420cfe42d36
Actually make use of the `markup.core.Namespace` class, and add a couple of doctests.
cmlenz
parents:
1
diff
changeset
|
152 if tag.namespace and tag not in self.NAMESPACE: |
| 1 | 153 continue # not in the HTML namespace, so don't emit |
| 154 buf = ['<', tag.localname] | |
| 155 for attr, value in attrib: | |
|
18
5420cfe42d36
Actually make use of the `markup.core.Namespace` class, and add a couple of doctests.
cmlenz
parents:
1
diff
changeset
|
156 if attr.namespace and attr not in self.NAMESPACE: |
| 1 | 157 continue # not in the HTML namespace, so don't emit |
| 158 if attr.localname in self._BOOLEAN_ATTRS: | |
| 159 if value: | |
| 160 buf.append(' %s' % attr.localname) | |
| 161 else: | |
| 162 buf.append(' %s="%s"' % (attr.localname, | |
| 163 Markup.escape(value))) | |
| 164 | |
| 165 if tag.localname in self._EMPTY_ELEMS: | |
| 166 kind, data, pos = stream.next() | |
| 167 if kind is not Stream.END: | |
| 168 stream.pushback((kind, data, pos)) | |
| 169 | |
| 170 yield Markup(''.join(buf + ['>'])) | |
| 171 | |
| 172 elif kind is Stream.END: | |
| 173 tag = data | |
|
18
5420cfe42d36
Actually make use of the `markup.core.Namespace` class, and add a couple of doctests.
cmlenz
parents:
1
diff
changeset
|
174 if tag.namespace and tag not in self.NAMESPACE: |
| 1 | 175 continue # not in the HTML namespace, so don't emit |
| 176 yield Markup('</%s>' % tag.localname) | |
| 177 | |
| 178 elif kind is Stream.TEXT: | |
| 179 yield Markup.escape(data, quotes=False) | |
| 180 | |
| 181 | |
| 182 class PushbackIterator(object): | |
| 183 """A simple wrapper for iterators that allows pushing items back on the | |
| 184 queue via the `pushback()` method. | |
| 185 | |
| 186 That can effectively be used to peek at the next item.""" | |
| 187 __slots__ = ['iterable', 'buf'] | |
| 188 | |
| 189 def __init__(self, iterable): | |
| 190 self.iterable = iter(iterable) | |
| 191 self.buf = [] | |
| 192 | |
| 193 def __iter__(self): | |
| 194 return self | |
| 195 | |
| 196 def next(self): | |
| 197 if self.buf: | |
| 198 return self.buf.pop(0) | |
| 199 return self.iterable.next() | |
| 200 | |
| 201 def pushback(self, item): | |
| 202 self.buf.append(item) |