Mercurial > genshi > genshi-test
annotate genshi/builder.py @ 737:686bbeecb9ac
Implement the `__html__` protocol as suggested in #202. This would allow Genshi to be used in combination with other markup generating tools, as long as they support the same protocol.
author | cmlenz |
---|---|
date | Thu, 05 Jun 2008 17:00:15 +0000 |
parents | 92e2fb9c056f |
children | f7da2de9b293 |
rev | line source |
---|---|
1 | 1 # -*- coding: utf-8 -*- |
2 # | |
408 | 3 # Copyright (C) 2006-2007 Edgewall Software |
1 | 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 | |
230 | 8 # are also available at http://genshi.edgewall.org/wiki/License. |
1 | 9 # |
10 # This software consists of voluntary contributions made by many | |
11 # individuals. For the exact contribution history, see the revision | |
230 | 12 # history and logs, available at http://genshi.edgewall.org/log/. |
1 | 13 |
430 | 14 """Support for programmatically generating markup streams from Python code using |
15 a very simple syntax. The main entry point to this module is the `tag` object | |
16 (which is actually an instance of the ``ElementFactory`` class). You should | |
17 rarely (if ever) need to directly import and use any of the other classes in | |
18 this module. | |
19 | |
20 Elements can be created using the `tag` object using attribute access. For | |
21 example: | |
22 | |
23 >>> doc = tag.p('Some text and ', tag.a('a link', href='http://example.org/'), '.') | |
24 >>> doc | |
25 <Element "p"> | |
26 | |
27 This produces an `Element` instance which can be further modified to add child | |
28 nodes and attributes. This is done by "calling" the element: positional | |
29 arguments are added as child nodes (alternatively, the `Element.append` method | |
30 can be used for that purpose), whereas keywords arguments are added as | |
31 attributes: | |
32 | |
33 >>> doc(tag.br) | |
34 <Element "p"> | |
35 >>> print doc | |
36 <p>Some text and <a href="http://example.org/">a link</a>.<br/></p> | |
37 | |
38 If an attribute name collides with a Python keyword, simply append an underscore | |
39 to the name: | |
40 | |
41 >>> doc(class_='intro') | |
42 <Element "p"> | |
43 >>> print doc | |
44 <p class="intro">Some text and <a href="http://example.org/">a link</a>.<br/></p> | |
45 | |
46 As shown above, an `Element` can easily be directly rendered to XML text by | |
47 printing it or using the Python ``str()`` function. This is basically a | |
48 shortcut for converting the `Element` to a stream and serializing that | |
49 stream: | |
50 | |
51 >>> stream = doc.generate() | |
431
747baa1cd597
* Don't allow `style` attributes by default in the `HTMLSanitizer`. Closes #97.
cmlenz
parents:
430
diff
changeset
|
52 >>> stream #doctest: +ELLIPSIS |
430 | 53 <genshi.core.Stream object at ...> |
54 >>> print stream | |
55 <p class="intro">Some text and <a href="http://example.org/">a link</a>.<br/></p> | |
56 | |
57 | |
58 The `tag` object also allows creating "fragments", which are basically lists | |
59 of nodes (elements or text) that don't have a parent element. This can be useful | |
60 for creating snippets of markup that are attached to a parent element later (for | |
61 example in a template). Fragments are created by calling the `tag` object, which | |
62 returns an object of type `Fragment`: | |
63 | |
64 >>> fragment = tag('Hello, ', tag.em('world'), '!') | |
65 >>> fragment | |
66 <Fragment> | |
67 >>> print fragment | |
68 Hello, <em>world</em>! | |
69 """ | |
425
5b248708bbed
Try to use proper reStructuredText for docstrings throughout.
cmlenz
parents:
410
diff
changeset
|
70 |
730
a424b2443e11
Fix for potential duplicate attributes making it through the builder API. Closes #216.
cmlenz
parents:
506
diff
changeset
|
71 try: |
a424b2443e11
Fix for potential duplicate attributes making it through the builder API. Closes #216.
cmlenz
parents:
506
diff
changeset
|
72 set |
a424b2443e11
Fix for potential duplicate attributes making it through the builder API. Closes #216.
cmlenz
parents:
506
diff
changeset
|
73 except NameError: |
a424b2443e11
Fix for potential duplicate attributes making it through the builder API. Closes #216.
cmlenz
parents:
506
diff
changeset
|
74 from sets import Set as set |
a424b2443e11
Fix for potential duplicate attributes making it through the builder API. Closes #216.
cmlenz
parents:
506
diff
changeset
|
75 |
737
686bbeecb9ac
Implement the `__html__` protocol as suggested in #202. This would allow Genshi to be used in combination with other markup generating tools, as long as they support the same protocol.
cmlenz
parents:
735
diff
changeset
|
76 from genshi.core import Attrs, Markup, Namespace, QName, Stream, \ |
686bbeecb9ac
Implement the `__html__` protocol as suggested in #202. This would allow Genshi to be used in combination with other markup generating tools, as long as they support the same protocol.
cmlenz
parents:
735
diff
changeset
|
77 START, END, TEXT |
1 | 78 |
433 | 79 __all__ = ['Fragment', 'Element', 'ElementFactory', 'tag'] |
425
5b248708bbed
Try to use proper reStructuredText for docstrings throughout.
cmlenz
parents:
410
diff
changeset
|
80 __docformat__ = 'restructuredtext en' |
1 | 81 |
82 | |
83 class Fragment(object): | |
28 | 84 """Represents a markup fragment, which is basically just a list of element |
85 or text nodes. | |
86 """ | |
1 | 87 __slots__ = ['children'] |
88 | |
89 def __init__(self): | |
433 | 90 """Create a new fragment.""" |
1 | 91 self.children = [] |
92 | |
65
5c024cf58ecb
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
34
diff
changeset
|
93 def __add__(self, other): |
5c024cf58ecb
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
34
diff
changeset
|
94 return Fragment()(self, other) |
5c024cf58ecb
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
34
diff
changeset
|
95 |
5c024cf58ecb
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
34
diff
changeset
|
96 def __call__(self, *args): |
433 | 97 """Append any positional arguments as child nodes. |
98 | |
99 :see: `append` | |
100 """ | |
133
b9a0031d4bbb
Minor cleanup and performance improvement for the builder module.
cmlenz
parents:
119
diff
changeset
|
101 map(self.append, args) |
65
5c024cf58ecb
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
34
diff
changeset
|
102 return self |
5c024cf58ecb
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
34
diff
changeset
|
103 |
5c024cf58ecb
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
34
diff
changeset
|
104 def __iter__(self): |
98
bc73d3ab823f
Bugfix in `builder` module: attribute values need to be converted to strings when generating streams.
cmlenz
parents:
94
diff
changeset
|
105 return self._generate() |
65
5c024cf58ecb
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
34
diff
changeset
|
106 |
5c024cf58ecb
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
34
diff
changeset
|
107 def __repr__(self): |
5c024cf58ecb
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
34
diff
changeset
|
108 return '<%s>' % self.__class__.__name__ |
5c024cf58ecb
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
34
diff
changeset
|
109 |
5c024cf58ecb
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
34
diff
changeset
|
110 def __str__(self): |
5c024cf58ecb
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
34
diff
changeset
|
111 return str(self.generate()) |
5c024cf58ecb
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
34
diff
changeset
|
112 |
5c024cf58ecb
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
34
diff
changeset
|
113 def __unicode__(self): |
5c024cf58ecb
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
34
diff
changeset
|
114 return unicode(self.generate()) |
5c024cf58ecb
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
34
diff
changeset
|
115 |
737
686bbeecb9ac
Implement the `__html__` protocol as suggested in #202. This would allow Genshi to be used in combination with other markup generating tools, as long as they support the same protocol.
cmlenz
parents:
735
diff
changeset
|
116 def __html__(self): |
686bbeecb9ac
Implement the `__html__` protocol as suggested in #202. This would allow Genshi to be used in combination with other markup generating tools, as long as they support the same protocol.
cmlenz
parents:
735
diff
changeset
|
117 return Markup(self.generate()) |
686bbeecb9ac
Implement the `__html__` protocol as suggested in #202. This would allow Genshi to be used in combination with other markup generating tools, as long as they support the same protocol.
cmlenz
parents:
735
diff
changeset
|
118 |
1 | 119 def append(self, node): |
433 | 120 """Append an element or string as child node. |
121 | |
122 :param node: the node to append; can be an `Element`, `Fragment`, or a | |
123 `Stream`, or a Python string or number | |
124 """ | |
379
d8c5045b547a
The builder API now accepts streams as children of elements and fragments.
cmlenz
parents:
345
diff
changeset
|
125 if isinstance(node, (Stream, Element, basestring, int, float, long)): |
1 | 126 # For objects of a known/primitive type, we avoid the check for |
127 # whether it is iterable for better performance | |
128 self.children.append(node) | |
129 elif isinstance(node, Fragment): | |
133
b9a0031d4bbb
Minor cleanup and performance improvement for the builder module.
cmlenz
parents:
119
diff
changeset
|
130 self.children.extend(node.children) |
1 | 131 elif node is not None: |
132 try: | |
506
f1bfa8a09d99
Use explicit buffer class in transformer filter, and revert the breaking change to the builder module.
cmlenz
parents:
501
diff
changeset
|
133 map(self.append, iter(node)) |
1 | 134 except TypeError: |
135 self.children.append(node) | |
94
80c72e936e72
Some bugfixes and minor performance improvements for the builder module.
cmlenz
parents:
91
diff
changeset
|
136 |
80c72e936e72
Some bugfixes and minor performance improvements for the builder module.
cmlenz
parents:
91
diff
changeset
|
137 def _generate(self): |
80c72e936e72
Some bugfixes and minor performance improvements for the builder module.
cmlenz
parents:
91
diff
changeset
|
138 for child in self.children: |
80c72e936e72
Some bugfixes and minor performance improvements for the builder module.
cmlenz
parents:
91
diff
changeset
|
139 if isinstance(child, Fragment): |
80c72e936e72
Some bugfixes and minor performance improvements for the builder module.
cmlenz
parents:
91
diff
changeset
|
140 for event in child._generate(): |
80c72e936e72
Some bugfixes and minor performance improvements for the builder module.
cmlenz
parents:
91
diff
changeset
|
141 yield event |
379
d8c5045b547a
The builder API now accepts streams as children of elements and fragments.
cmlenz
parents:
345
diff
changeset
|
142 elif isinstance(child, Stream): |
d8c5045b547a
The builder API now accepts streams as children of elements and fragments.
cmlenz
parents:
345
diff
changeset
|
143 for event in child: |
d8c5045b547a
The builder API now accepts streams as children of elements and fragments.
cmlenz
parents:
345
diff
changeset
|
144 yield event |
94
80c72e936e72
Some bugfixes and minor performance improvements for the builder module.
cmlenz
parents:
91
diff
changeset
|
145 else: |
80c72e936e72
Some bugfixes and minor performance improvements for the builder module.
cmlenz
parents:
91
diff
changeset
|
146 if not isinstance(child, basestring): |
80c72e936e72
Some bugfixes and minor performance improvements for the builder module.
cmlenz
parents:
91
diff
changeset
|
147 child = unicode(child) |
133
b9a0031d4bbb
Minor cleanup and performance improvement for the builder module.
cmlenz
parents:
119
diff
changeset
|
148 yield TEXT, child, (None, -1, -1) |
1 | 149 |
150 def generate(self): | |
498 | 151 """Return a markup event stream for the fragment. |
152 | |
153 :rtype: `Stream` | |
154 """ | |
94
80c72e936e72
Some bugfixes and minor performance improvements for the builder module.
cmlenz
parents:
91
diff
changeset
|
155 return Stream(self._generate()) |
1 | 156 |
157 | |
345 | 158 def _kwargs_to_attrs(kwargs): |
735
92e2fb9c056f
Tweak to [854] to not change the ordering of attributes compared to how they were previously ordered, to avoid breaking any tests that rely on the order. See #216.
cmlenz
parents:
730
diff
changeset
|
159 attrs = [] |
92e2fb9c056f
Tweak to [854] to not change the ordering of attributes compared to how they were previously ordered, to avoid breaking any tests that rely on the order. See #216.
cmlenz
parents:
730
diff
changeset
|
160 names = set() |
730
a424b2443e11
Fix for potential duplicate attributes making it through the builder API. Closes #216.
cmlenz
parents:
506
diff
changeset
|
161 for name, value in kwargs.items(): |
a424b2443e11
Fix for potential duplicate attributes making it through the builder API. Closes #216.
cmlenz
parents:
506
diff
changeset
|
162 name = name.rstrip('_').replace('_', '-') |
735
92e2fb9c056f
Tweak to [854] to not change the ordering of attributes compared to how they were previously ordered, to avoid breaking any tests that rely on the order. See #216.
cmlenz
parents:
730
diff
changeset
|
163 if value is not None and name not in names: |
92e2fb9c056f
Tweak to [854] to not change the ordering of attributes compared to how they were previously ordered, to avoid breaking any tests that rely on the order. See #216.
cmlenz
parents:
730
diff
changeset
|
164 attrs.append((QName(name), unicode(value))) |
92e2fb9c056f
Tweak to [854] to not change the ordering of attributes compared to how they were previously ordered, to avoid breaking any tests that rely on the order. See #216.
cmlenz
parents:
730
diff
changeset
|
165 names.add(name) |
92e2fb9c056f
Tweak to [854] to not change the ordering of attributes compared to how they were previously ordered, to avoid breaking any tests that rely on the order. See #216.
cmlenz
parents:
730
diff
changeset
|
166 return Attrs(attrs) |
345 | 167 |
168 | |
1 | 169 class Element(Fragment): |
170 """Simple XML output generator based on the builder pattern. | |
171 | |
172 Construct XML elements by passing the tag name to the constructor: | |
173 | |
174 >>> print Element('strong') | |
175 <strong/> | |
176 | |
177 Attributes can be specified using keyword arguments. The values of the | |
178 arguments will be converted to strings and any special XML characters | |
179 escaped: | |
180 | |
181 >>> print Element('textarea', rows=10, cols=60) | |
182 <textarea rows="10" cols="60"/> | |
183 >>> print Element('span', title='1 < 2') | |
184 <span title="1 < 2"/> | |
185 >>> print Element('span', title='"baz"') | |
186 <span title=""baz""/> | |
187 | |
188 The " character is escaped using a numerical entity. | |
189 The order in which attributes are rendered is undefined. | |
190 | |
191 If an attribute value evaluates to `None`, that attribute is not included | |
192 in the output: | |
193 | |
194 >>> print Element('a', name=None) | |
195 <a/> | |
196 | |
197 Attribute names that conflict with Python keywords can be specified by | |
198 appending an underscore: | |
199 | |
200 >>> print Element('div', class_='warning') | |
201 <div class="warning"/> | |
202 | |
203 Nested elements can be added to an element using item access notation. | |
204 The call notation can also be used for this and for adding attributes | |
205 using keyword arguments, as one would do in the constructor. | |
206 | |
207 >>> print Element('ul')(Element('li'), Element('li')) | |
208 <ul><li/><li/></ul> | |
209 >>> print Element('a')('Label') | |
210 <a>Label</a> | |
211 >>> print Element('a')('Label', href="target") | |
212 <a href="target">Label</a> | |
213 | |
214 Text nodes can be nested in an element by adding strings instead of | |
215 elements. Any special characters in the strings are escaped automatically: | |
216 | |
217 >>> print Element('em')('Hello world') | |
218 <em>Hello world</em> | |
219 >>> print Element('em')(42) | |
220 <em>42</em> | |
221 >>> print Element('em')('1 < 2') | |
222 <em>1 < 2</em> | |
223 | |
224 This technique also allows mixed content: | |
225 | |
226 >>> print Element('p')('Hello ', Element('b')('world')) | |
227 <p>Hello <b>world</b></p> | |
228 | |
34 | 229 Quotes are not escaped inside text nodes: |
230 >>> print Element('p')('"Hello"') | |
231 <p>"Hello"</p> | |
232 | |
1 | 233 Elements can also be combined with other elements or strings using the |
234 addition operator, which results in a `Fragment` object that contains the | |
235 operands: | |
236 | |
237 >>> print Element('br') + 'some text' + Element('br') | |
238 <br/>some text<br/> | |
239 | |
240 Elements with a namespace can be generated using the `Namespace` and/or | |
241 `QName` classes: | |
242 | |
230 | 243 >>> from genshi.core import Namespace |
1 | 244 >>> xhtml = Namespace('http://www.w3.org/1999/xhtml') |
245 >>> print Element(xhtml.html, lang='en') | |
410
3460b04daeac
Improve the handling of namespaces in serialization.
cmlenz
parents:
408
diff
changeset
|
246 <html xmlns="http://www.w3.org/1999/xhtml" lang="en"/> |
1 | 247 """ |
248 __slots__ = ['tag', 'attrib'] | |
249 | |
250 def __init__(self, tag_, **attrib): | |
251 Fragment.__init__(self) | |
252 self.tag = QName(tag_) | |
730
a424b2443e11
Fix for potential duplicate attributes making it through the builder API. Closes #216.
cmlenz
parents:
506
diff
changeset
|
253 self.attrib = _kwargs_to_attrs(attrib) |
1 | 254 |
255 def __call__(self, *args, **kwargs): | |
433 | 256 """Append any positional arguments as child nodes, and keyword arguments |
257 as attributes. | |
258 | |
498 | 259 :return: the element itself so that calls can be chained |
260 :rtype: `Element` | |
433 | 261 :see: `Fragment.append` |
262 """ | |
730
a424b2443e11
Fix for potential duplicate attributes making it through the builder API. Closes #216.
cmlenz
parents:
506
diff
changeset
|
263 self.attrib |= _kwargs_to_attrs(kwargs) |
98
bc73d3ab823f
Bugfix in `builder` module: attribute values need to be converted to strings when generating streams.
cmlenz
parents:
94
diff
changeset
|
264 Fragment.__call__(self, *args) |
bc73d3ab823f
Bugfix in `builder` module: attribute values need to be converted to strings when generating streams.
cmlenz
parents:
94
diff
changeset
|
265 return self |
1 | 266 |
65
5c024cf58ecb
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
34
diff
changeset
|
267 def __repr__(self): |
5c024cf58ecb
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
34
diff
changeset
|
268 return '<%s "%s">' % (self.__class__.__name__, self.tag) |
5c024cf58ecb
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
34
diff
changeset
|
269 |
94
80c72e936e72
Some bugfixes and minor performance improvements for the builder module.
cmlenz
parents:
91
diff
changeset
|
270 def _generate(self): |
133
b9a0031d4bbb
Minor cleanup and performance improvement for the builder module.
cmlenz
parents:
119
diff
changeset
|
271 yield START, (self.tag, self.attrib), (None, -1, -1) |
94
80c72e936e72
Some bugfixes and minor performance improvements for the builder module.
cmlenz
parents:
91
diff
changeset
|
272 for kind, data, pos in Fragment._generate(self): |
80c72e936e72
Some bugfixes and minor performance improvements for the builder module.
cmlenz
parents:
91
diff
changeset
|
273 yield kind, data, pos |
133
b9a0031d4bbb
Minor cleanup and performance improvement for the builder module.
cmlenz
parents:
119
diff
changeset
|
274 yield END, self.tag, (None, -1, -1) |
94
80c72e936e72
Some bugfixes and minor performance improvements for the builder module.
cmlenz
parents:
91
diff
changeset
|
275 |
1 | 276 def generate(self): |
498 | 277 """Return a markup event stream for the fragment. |
278 | |
279 :rtype: `Stream` | |
280 """ | |
94
80c72e936e72
Some bugfixes and minor performance improvements for the builder module.
cmlenz
parents:
91
diff
changeset
|
281 return Stream(self._generate()) |
1 | 282 |
283 | |
284 class ElementFactory(object): | |
28 | 285 """Factory for `Element` objects. |
286 | |
287 A new element is created simply by accessing a correspondingly named | |
288 attribute of the factory object: | |
289 | |
290 >>> factory = ElementFactory() | |
291 >>> print factory.foo | |
292 <foo/> | |
293 >>> print factory.foo(id=2) | |
294 <foo id="2"/> | |
295 | |
119
61b133ed95b2
Allow creating fragments from the `tag` object in `markup.builder`.
cmlenz
parents:
98
diff
changeset
|
296 Markup fragments (lists of nodes without a parent element) can be created |
61b133ed95b2
Allow creating fragments from the `tag` object in `markup.builder`.
cmlenz
parents:
98
diff
changeset
|
297 by calling the factory: |
61b133ed95b2
Allow creating fragments from the `tag` object in `markup.builder`.
cmlenz
parents:
98
diff
changeset
|
298 |
61b133ed95b2
Allow creating fragments from the `tag` object in `markup.builder`.
cmlenz
parents:
98
diff
changeset
|
299 >>> print factory('Hello, ', factory.em('world'), '!') |
61b133ed95b2
Allow creating fragments from the `tag` object in `markup.builder`.
cmlenz
parents:
98
diff
changeset
|
300 Hello, <em>world</em>! |
61b133ed95b2
Allow creating fragments from the `tag` object in `markup.builder`.
cmlenz
parents:
98
diff
changeset
|
301 |
28 | 302 A factory can also be bound to a specific namespace: |
303 | |
304 >>> factory = ElementFactory('http://www.w3.org/1999/xhtml') | |
305 >>> print factory.html(lang="en") | |
410
3460b04daeac
Improve the handling of namespaces in serialization.
cmlenz
parents:
408
diff
changeset
|
306 <html xmlns="http://www.w3.org/1999/xhtml" lang="en"/> |
28 | 307 |
308 The namespace for a specific element can be altered on an existing factory | |
309 by specifying the new namespace using item access: | |
310 | |
311 >>> factory = ElementFactory() | |
312 >>> print factory.html(factory['http://www.w3.org/2000/svg'].g(id=3)) | |
410
3460b04daeac
Improve the handling of namespaces in serialization.
cmlenz
parents:
408
diff
changeset
|
313 <html><g xmlns="http://www.w3.org/2000/svg" id="3"/></html> |
28 | 314 |
315 Usually, the `ElementFactory` class is not be used directly. Rather, the | |
316 `tag` instance should be used to create elements. | |
317 """ | |
1 | 318 |
19
7b589453b797
Enable `ElementFactory` to create namespaced elements.
cmlenz
parents:
17
diff
changeset
|
319 def __init__(self, namespace=None): |
28 | 320 """Create the factory, optionally bound to the given namespace. |
321 | |
425
5b248708bbed
Try to use proper reStructuredText for docstrings throughout.
cmlenz
parents:
410
diff
changeset
|
322 :param namespace: the namespace URI for any created elements, or `None` |
5b248708bbed
Try to use proper reStructuredText for docstrings throughout.
cmlenz
parents:
410
diff
changeset
|
323 for no namespace |
28 | 324 """ |
20 | 325 if namespace and not isinstance(namespace, Namespace): |
19
7b589453b797
Enable `ElementFactory` to create namespaced elements.
cmlenz
parents:
17
diff
changeset
|
326 namespace = Namespace(namespace) |
7b589453b797
Enable `ElementFactory` to create namespaced elements.
cmlenz
parents:
17
diff
changeset
|
327 self.namespace = namespace |
7b589453b797
Enable `ElementFactory` to create namespaced elements.
cmlenz
parents:
17
diff
changeset
|
328 |
119
61b133ed95b2
Allow creating fragments from the `tag` object in `markup.builder`.
cmlenz
parents:
98
diff
changeset
|
329 def __call__(self, *args): |
433 | 330 """Create a fragment that has the given positional arguments as child |
331 nodes. | |
332 | |
333 :return: the created `Fragment` | |
498 | 334 :rtype: `Fragment` |
433 | 335 """ |
119
61b133ed95b2
Allow creating fragments from the `tag` object in `markup.builder`.
cmlenz
parents:
98
diff
changeset
|
336 return Fragment()(*args) |
61b133ed95b2
Allow creating fragments from the `tag` object in `markup.builder`.
cmlenz
parents:
98
diff
changeset
|
337 |
19
7b589453b797
Enable `ElementFactory` to create namespaced elements.
cmlenz
parents:
17
diff
changeset
|
338 def __getitem__(self, namespace): |
433 | 339 """Return a new factory that is bound to the specified namespace. |
340 | |
341 :param namespace: the namespace URI or `Namespace` object | |
342 :return: an `ElementFactory` that produces elements bound to the given | |
343 namespace | |
498 | 344 :rtype: `ElementFactory` |
433 | 345 """ |
19
7b589453b797
Enable `ElementFactory` to create namespaced elements.
cmlenz
parents:
17
diff
changeset
|
346 return ElementFactory(namespace) |
7b589453b797
Enable `ElementFactory` to create namespaced elements.
cmlenz
parents:
17
diff
changeset
|
347 |
7b589453b797
Enable `ElementFactory` to create namespaced elements.
cmlenz
parents:
17
diff
changeset
|
348 def __getattr__(self, name): |
433 | 349 """Create an `Element` with the given name. |
350 | |
351 :param name: the tag name of the element to create | |
352 :return: an `Element` with the specified name | |
498 | 353 :rtype: `Element` |
433 | 354 """ |
19
7b589453b797
Enable `ElementFactory` to create namespaced elements.
cmlenz
parents:
17
diff
changeset
|
355 return Element(self.namespace and self.namespace[name] or name) |
1 | 356 |
357 | |
358 tag = ElementFactory() | |
498 | 359 """Global `ElementFactory` bound to the default namespace. |
360 | |
361 :type: `ElementFactory` | |
362 """ |