annotate genshi/builder.py @ 730:5e9d250ad3ad trunk

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