Mercurial > genshi > genshi-test
annotate markup/builder.py @ 28:15e59a9cb362
More docstrings for the builder module.
| author | cmlenz |
|---|---|
| date | Wed, 28 Jun 2006 09:41:58 +0000 |
| parents | b8456279c444 |
| children | ae293292cbb1 |
| 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 | |
| 27 | 8 # are also available at http://markup.cmlenz.net/wiki/License. |
| 1 | 9 # |
| 10 # This software consists of voluntary contributions made by many | |
| 11 # individuals. For the exact contribution history, see the revision | |
| 27 | 12 # history and logs, available at http://markup.cmlenz.net/log/. |
| 1 | 13 |
|
19
7b589453b797
Enable `ElementFactory` to create namespaced elements.
cmlenz
parents:
17
diff
changeset
|
14 from markup.core import Attributes, Namespace, QName, Stream |
| 1 | 15 |
| 16 __all__ = ['Fragment', 'Element', 'tag'] | |
| 17 | |
| 18 | |
| 19 class Fragment(object): | |
| 28 | 20 """Represents a markup fragment, which is basically just a list of element |
| 21 or text nodes. | |
| 22 """ | |
| 1 | 23 __slots__ = ['children'] |
| 24 | |
| 25 def __init__(self): | |
| 26 self.children = [] | |
| 27 | |
| 28 def append(self, node): | |
| 29 """Append an element or string as child node.""" | |
| 30 if isinstance(node, (Element, basestring, int, float, long)): | |
| 31 # For objects of a known/primitive type, we avoid the check for | |
| 32 # whether it is iterable for better performance | |
| 33 self.children.append(node) | |
| 34 elif isinstance(node, Fragment): | |
| 35 self.children += node.children | |
| 36 elif node is not None: | |
| 37 try: | |
| 38 children = iter(node) | |
| 39 except TypeError: | |
| 40 self.children.append(node) | |
| 41 else: | |
| 42 for child in node: | |
| 43 self.append(children) | |
| 44 | |
| 45 def __add__(self, other): | |
| 46 return Fragment()(self, other) | |
| 47 | |
| 48 def __call__(self, *args): | |
| 49 for arg in args: | |
| 50 self.append(arg) | |
| 51 return self | |
| 52 | |
| 53 def generate(self): | |
| 28 | 54 """Return a markup event stream for the fragment.""" |
| 1 | 55 def _generate(): |
| 56 for child in self.children: | |
| 57 if isinstance(child, Fragment): | |
| 58 for event in child.generate(): | |
| 59 yield event | |
| 60 else: | |
|
17
ad63ad459524
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
1
diff
changeset
|
61 yield Stream.TEXT, unicode(child), (-1, -1) |
| 1 | 62 return Stream(_generate()) |
| 63 | |
| 64 def __iter__(self): | |
| 65 return iter(self.generate()) | |
| 66 | |
| 67 def __str__(self): | |
| 68 return str(self.generate()) | |
| 69 | |
| 70 def __unicode__(self): | |
| 71 return unicode(self.generate()) | |
| 72 | |
| 73 | |
| 74 class Element(Fragment): | |
| 75 """Simple XML output generator based on the builder pattern. | |
| 76 | |
| 77 Construct XML elements by passing the tag name to the constructor: | |
| 78 | |
| 79 >>> print Element('strong') | |
| 80 <strong/> | |
| 81 | |
| 82 Attributes can be specified using keyword arguments. The values of the | |
| 83 arguments will be converted to strings and any special XML characters | |
| 84 escaped: | |
| 85 | |
| 86 >>> print Element('textarea', rows=10, cols=60) | |
| 87 <textarea rows="10" cols="60"/> | |
| 88 >>> print Element('span', title='1 < 2') | |
| 89 <span title="1 < 2"/> | |
| 90 >>> print Element('span', title='"baz"') | |
| 91 <span title=""baz""/> | |
| 92 | |
| 93 The " character is escaped using a numerical entity. | |
| 94 The order in which attributes are rendered is undefined. | |
| 95 | |
| 96 If an attribute value evaluates to `None`, that attribute is not included | |
| 97 in the output: | |
| 98 | |
| 99 >>> print Element('a', name=None) | |
| 100 <a/> | |
| 101 | |
| 102 Attribute names that conflict with Python keywords can be specified by | |
| 103 appending an underscore: | |
| 104 | |
| 105 >>> print Element('div', class_='warning') | |
| 106 <div class="warning"/> | |
| 107 | |
| 108 Nested elements can be added to an element using item access notation. | |
| 109 The call notation can also be used for this and for adding attributes | |
| 110 using keyword arguments, as one would do in the constructor. | |
| 111 | |
| 112 >>> print Element('ul')(Element('li'), Element('li')) | |
| 113 <ul><li/><li/></ul> | |
| 114 >>> print Element('a')('Label') | |
| 115 <a>Label</a> | |
| 116 >>> print Element('a')('Label', href="target") | |
| 117 <a href="target">Label</a> | |
| 118 | |
| 119 Text nodes can be nested in an element by adding strings instead of | |
| 120 elements. Any special characters in the strings are escaped automatically: | |
| 121 | |
| 122 >>> print Element('em')('Hello world') | |
| 123 <em>Hello world</em> | |
| 124 >>> print Element('em')(42) | |
| 125 <em>42</em> | |
| 126 >>> print Element('em')('1 < 2') | |
| 127 <em>1 < 2</em> | |
| 128 | |
| 129 This technique also allows mixed content: | |
| 130 | |
| 131 >>> print Element('p')('Hello ', Element('b')('world')) | |
| 132 <p>Hello <b>world</b></p> | |
| 133 | |
| 134 Elements can also be combined with other elements or strings using the | |
| 135 addition operator, which results in a `Fragment` object that contains the | |
| 136 operands: | |
| 137 | |
| 138 >>> print Element('br') + 'some text' + Element('br') | |
| 139 <br/>some text<br/> | |
| 140 | |
| 141 Elements with a namespace can be generated using the `Namespace` and/or | |
| 142 `QName` classes: | |
| 143 | |
| 144 >>> from markup.core import Namespace | |
| 145 >>> xhtml = Namespace('http://www.w3.org/1999/xhtml') | |
| 146 >>> print Element(xhtml.html, lang='en') | |
| 147 <html lang="en" xmlns="http://www.w3.org/1999/xhtml"/> | |
| 148 """ | |
| 149 __slots__ = ['tag', 'attrib'] | |
| 150 | |
| 151 def __init__(self, tag_, **attrib): | |
| 152 Fragment.__init__(self) | |
| 153 self.tag = QName(tag_) | |
| 154 self.attrib = Attributes() | |
| 155 self(**attrib) | |
| 156 | |
| 157 def __call__(self, *args, **kwargs): | |
| 158 for attr, value in kwargs.items(): | |
| 159 if value is None: | |
| 160 continue | |
| 161 attr = attr.rstrip('_').replace('_', '-') | |
| 162 self.attrib.set(attr, value) | |
| 163 return Fragment.__call__(self, *args) | |
| 164 | |
| 165 def generate(self): | |
| 28 | 166 """Return a markup event stream for the fragment.""" |
| 1 | 167 def _generate(): |
| 168 yield Stream.START, (self.tag, self.attrib), (-1, -1) | |
| 169 for kind, data, pos in Fragment.generate(self): | |
| 170 yield kind, data, pos | |
| 171 yield Stream.END, self.tag, (-1, -1) | |
| 172 return Stream(_generate()) | |
| 173 | |
| 174 | |
| 175 class ElementFactory(object): | |
| 28 | 176 """Factory for `Element` objects. |
| 177 | |
| 178 A new element is created simply by accessing a correspondingly named | |
| 179 attribute of the factory object: | |
| 180 | |
| 181 >>> factory = ElementFactory() | |
| 182 >>> print factory.foo | |
| 183 <foo/> | |
| 184 >>> print factory.foo(id=2) | |
| 185 <foo id="2"/> | |
| 186 | |
| 187 A factory can also be bound to a specific namespace: | |
| 188 | |
| 189 >>> factory = ElementFactory('http://www.w3.org/1999/xhtml') | |
| 190 >>> print factory.html(lang="en") | |
| 191 <html lang="en" xmlns="http://www.w3.org/1999/xhtml"/> | |
| 192 | |
| 193 The namespace for a specific element can be altered on an existing factory | |
| 194 by specifying the new namespace using item access: | |
| 195 | |
| 196 >>> factory = ElementFactory() | |
| 197 >>> print factory.html(factory['http://www.w3.org/2000/svg'].g(id=3)) | |
| 198 <html><g id="3" xmlns="http://www.w3.org/2000/svg"/></html> | |
| 199 | |
| 200 Usually, the `ElementFactory` class is not be used directly. Rather, the | |
| 201 `tag` instance should be used to create elements. | |
| 202 """ | |
| 1 | 203 |
|
19
7b589453b797
Enable `ElementFactory` to create namespaced elements.
cmlenz
parents:
17
diff
changeset
|
204 def __init__(self, namespace=None): |
| 28 | 205 """Create the factory, optionally bound to the given namespace. |
| 206 | |
| 207 @param namespace: the namespace URI for any created elements, or `None` | |
| 208 for no namespace | |
| 209 """ | |
| 20 | 210 if namespace and not isinstance(namespace, Namespace): |
|
19
7b589453b797
Enable `ElementFactory` to create namespaced elements.
cmlenz
parents:
17
diff
changeset
|
211 namespace = Namespace(namespace) |
|
7b589453b797
Enable `ElementFactory` to create namespaced elements.
cmlenz
parents:
17
diff
changeset
|
212 self.namespace = namespace |
|
7b589453b797
Enable `ElementFactory` to create namespaced elements.
cmlenz
parents:
17
diff
changeset
|
213 |
|
7b589453b797
Enable `ElementFactory` to create namespaced elements.
cmlenz
parents:
17
diff
changeset
|
214 def __getitem__(self, namespace): |
| 28 | 215 """Return a new factory that is bound to the specified namespace.""" |
|
19
7b589453b797
Enable `ElementFactory` to create namespaced elements.
cmlenz
parents:
17
diff
changeset
|
216 return ElementFactory(namespace) |
|
7b589453b797
Enable `ElementFactory` to create namespaced elements.
cmlenz
parents:
17
diff
changeset
|
217 |
|
7b589453b797
Enable `ElementFactory` to create namespaced elements.
cmlenz
parents:
17
diff
changeset
|
218 def __getattr__(self, name): |
| 28 | 219 """Create an `Element` with the given name.""" |
|
19
7b589453b797
Enable `ElementFactory` to create namespaced elements.
cmlenz
parents:
17
diff
changeset
|
220 return Element(self.namespace and self.namespace[name] or name) |
| 1 | 221 |
| 222 | |
| 223 tag = ElementFactory() |