blob: 9c18fb2af3d50d488381bd503e817deca818203e [file] [log] [blame]
Fred Drake1f549022000-09-24 05:21:58 +00001"""\
Fred Drakef7cf40d2000-12-14 18:16:11 +00002minidom.py -- a lightweight DOM implementation.
Fred Drake55c38192000-06-29 19:39:57 +00003
Paul Prescod623511b2000-07-21 22:05:49 +00004parse( "foo.xml" )
5
6parseString( "<foo><bar/></foo>" )
7
Fred Drake55c38192000-06-29 19:39:57 +00008Todo:
9=====
10 * convenience methods for getting elements and text.
11 * more testing
12 * bring some of the writer and linearizer code into conformance with this
13 interface
14 * SAX 2 namespaces
15"""
16
Fred Drake1f549022000-09-24 05:21:58 +000017import string
Fred Drake4ccf4a12000-11-21 22:02:22 +000018_string = string
19del string
20
Andrew M. Kuchling291ed4f2000-12-31 03:50:23 +000021from xml.dom import HierarchyRequestErr
22
Fred Drake4ccf4a12000-11-21 22:02:22 +000023# localize the types, and allow support for Unicode values if available:
Fred Drake1f549022000-09-24 05:21:58 +000024import types
Fred Drake4ccf4a12000-11-21 22:02:22 +000025_TupleType = types.TupleType
26try:
27 _StringTypes = (types.StringType, types.UnicodeType)
28except AttributeError:
29 _StringTypes = (types.StringType,)
30del types
31
Fred Drakef7cf40d2000-12-14 18:16:11 +000032import xml.dom
33_Node = xml.dom.Node
Fred Drake55c38192000-06-29 19:39:57 +000034
Fred Drakef7cf40d2000-12-14 18:16:11 +000035class Node(_Node):
Fred Drake1f549022000-09-24 05:21:58 +000036 allnodes = {}
37 _debug = 0
38 _makeParentNodes = 1
39 debug = None
Andrew M. Kuchling291ed4f2000-12-31 03:50:23 +000040 childNodeTypes = ()
Martin v. Löwis52ce0d02001-01-27 08:47:37 +000041
Fred Drake1f549022000-09-24 05:21:58 +000042 def __init__(self):
43 self.childNodes = []
Andrew M. Kuchling04a45e92000-12-20 14:47:24 +000044 self.parentNode = None
Fred Drake16f63292000-10-23 18:09:50 +000045 if Node._debug:
Fred Drake1f549022000-09-24 05:21:58 +000046 index = repr(id(self)) + repr(self.__class__)
47 Node.allnodes[index] = repr(self.__dict__)
48 if Node.debug is None:
Fred Drake4ccf4a12000-11-21 22:02:22 +000049 Node.debug = _get_StringIO()
Paul Prescod6c4753f2000-07-04 03:39:33 +000050 #open( "debug4.out", "w" )
Fred Drake1f549022000-09-24 05:21:58 +000051 Node.debug.write("create %s\n" % index)
Fred Drake55c38192000-06-29 19:39:57 +000052
Fred Drake1f549022000-09-24 05:21:58 +000053 def __getattr__(self, key):
54 if key[0:2] == "__":
Fred Drakef7cf40d2000-12-14 18:16:11 +000055 raise AttributeError, key
Fred Drake55c38192000-06-29 19:39:57 +000056 # getattr should never call getattr!
Fred Drake16f63292000-10-23 18:09:50 +000057 if self.__dict__.has_key("inGetAttr"):
Fred Drake55c38192000-06-29 19:39:57 +000058 del self.inGetAttr
59 raise AttributeError, key
60
Fred Drake1f549022000-09-24 05:21:58 +000061 prefix, attrname = key[:5], key[5:]
62 if prefix == "_get_":
63 self.inGetAttr = 1
Fred Drake16f63292000-10-23 18:09:50 +000064 if hasattr(self, attrname):
Fred Drake55c38192000-06-29 19:39:57 +000065 del self.inGetAttr
Fred Drake16f63292000-10-23 18:09:50 +000066 return (lambda self=self, attrname=attrname:
Fred Drake1f549022000-09-24 05:21:58 +000067 getattr(self, attrname))
Fred Drake55c38192000-06-29 19:39:57 +000068 else:
69 del self.inGetAttr
70 raise AttributeError, key
71 else:
Fred Drake1f549022000-09-24 05:21:58 +000072 self.inGetAttr = 1
Fred Drake55c38192000-06-29 19:39:57 +000073 try:
Fred Drake1f549022000-09-24 05:21:58 +000074 func = getattr(self, "_get_" + key)
Fred Drake55c38192000-06-29 19:39:57 +000075 except AttributeError:
76 raise AttributeError, key
77 del self.inGetAttr
78 return func()
79
Fred Drake1f549022000-09-24 05:21:58 +000080 def __nonzero__(self):
81 return 1
Fred Drake55c38192000-06-29 19:39:57 +000082
Fred Drake1f549022000-09-24 05:21:58 +000083 def toxml(self):
Fred Drake4ccf4a12000-11-21 22:02:22 +000084 writer = _get_StringIO()
Fred Drake1f549022000-09-24 05:21:58 +000085 self.writexml(writer)
Fred Drake55c38192000-06-29 19:39:57 +000086 return writer.getvalue()
87
Fred Drake1f549022000-09-24 05:21:58 +000088 def hasChildNodes(self):
89 if self.childNodes:
90 return 1
91 else:
92 return 0
Fred Drake55c38192000-06-29 19:39:57 +000093
Fred Drake1f549022000-09-24 05:21:58 +000094 def _get_firstChild(self):
Fred Drake4ccf4a12000-11-21 22:02:22 +000095 if self.childNodes:
96 return self.childNodes[0]
Paul Prescod73678da2000-07-01 04:58:47 +000097
Fred Drake1f549022000-09-24 05:21:58 +000098 def _get_lastChild(self):
Fred Drake4ccf4a12000-11-21 22:02:22 +000099 if self.childNodes:
100 return self.childNodes[-1]
Paul Prescod73678da2000-07-01 04:58:47 +0000101
Fred Drake1f549022000-09-24 05:21:58 +0000102 def insertBefore(self, newChild, refChild):
Andrew M. Kuchling291ed4f2000-12-31 03:50:23 +0000103 if newChild.nodeType not in self.childNodeTypes:
104 raise HierarchyRequestErr, \
105 "%s cannot be child of %s" % (repr(newChild), repr(self) )
Andrew M. Kuchling04a45e92000-12-20 14:47:24 +0000106 if newChild.parentNode is not None:
107 newChild.parentNode.removeChild(newChild)
Fred Drake4ccf4a12000-11-21 22:02:22 +0000108 if refChild is None:
109 self.appendChild(newChild)
110 else:
111 index = self.childNodes.index(refChild)
112 self.childNodes.insert(index, newChild)
113 newChild.nextSibling = refChild
114 refChild.previousSibling = newChild
115 if index:
116 node = self.childNodes[index-1]
117 node.nextSibling = newChild
118 newChild.previousSibling = node
119 else:
120 newChild.previousSibling = None
121 if self._makeParentNodes:
122 newChild.parentNode = self
123 return newChild
Fred Drake55c38192000-06-29 19:39:57 +0000124
Fred Drake1f549022000-09-24 05:21:58 +0000125 def appendChild(self, node):
Andrew M. Kuchling291ed4f2000-12-31 03:50:23 +0000126 if node.nodeType not in self.childNodeTypes:
127 raise HierarchyRequestErr, \
128 "%s cannot be child of %s" % (repr(node), repr(self) )
Andrew M. Kuchling04a45e92000-12-20 14:47:24 +0000129 if node.parentNode is not None:
130 node.parentNode.removeChild(node)
Fred Drake13a30692000-10-09 20:04:16 +0000131 if self.childNodes:
132 last = self.lastChild
133 node.previousSibling = last
134 last.nextSibling = node
135 else:
136 node.previousSibling = None
137 node.nextSibling = None
Fred Drake1f549022000-09-24 05:21:58 +0000138 self.childNodes.append(node)
Fred Drake4ccf4a12000-11-21 22:02:22 +0000139 if self._makeParentNodes:
140 node.parentNode = self
Paul Prescod73678da2000-07-01 04:58:47 +0000141 return node
142
Fred Drake1f549022000-09-24 05:21:58 +0000143 def replaceChild(self, newChild, oldChild):
Andrew M. Kuchling291ed4f2000-12-31 03:50:23 +0000144 if newChild.nodeType not in self.childNodeTypes:
145 raise HierarchyRequestErr, \
146 "%s cannot be child of %s" % (repr(newChild), repr(self) )
Andrew M. Kuchling04a45e92000-12-20 14:47:24 +0000147 if newChild.parentNode is not None:
148 newChild.parentNode.removeChild(newChild)
Fred Drake4ccf4a12000-11-21 22:02:22 +0000149 if newChild is oldChild:
150 return
Fred Drake1f549022000-09-24 05:21:58 +0000151 index = self.childNodes.index(oldChild)
Fred Drake4ccf4a12000-11-21 22:02:22 +0000152 self.childNodes[index] = newChild
153 if self._makeParentNodes:
154 newChild.parentNode = self
155 oldChild.parentNode = None
156 newChild.nextSibling = oldChild.nextSibling
157 newChild.previousSibling = oldChild.previousSibling
Martin v. Löwis156c3372000-12-28 18:40:56 +0000158 oldChild.nextSibling = None
Fred Drake4ccf4a12000-11-21 22:02:22 +0000159 oldChild.previousSibling = None
Martin v. Löwis156c3372000-12-28 18:40:56 +0000160 if newChild.previousSibling:
161 newChild.previousSibling.nextSibling = newChild
162 if newChild.nextSibling:
163 newChild.nextSibling.previousSibling = newChild
Fred Drake4ccf4a12000-11-21 22:02:22 +0000164 return oldChild
Paul Prescod73678da2000-07-01 04:58:47 +0000165
Fred Drake1f549022000-09-24 05:21:58 +0000166 def removeChild(self, oldChild):
Fred Drake4ccf4a12000-11-21 22:02:22 +0000167 self.childNodes.remove(oldChild)
Andrew M. Kuchling04a45e92000-12-20 14:47:24 +0000168 if oldChild.nextSibling is not None:
169 oldChild.nextSibling.previousSibling = oldChild.previousSibling
170 if oldChild.previousSibling is not None:
Martin v. Löwis52ce0d02001-01-27 08:47:37 +0000171 oldChild.previousSibling.nextSibling = oldChild.nextSibling
Andrew M. Kuchling04a45e92000-12-20 14:47:24 +0000172 oldChild.nextSibling = oldChild.previousSibling = None
Martin v. Löwis52ce0d02001-01-27 08:47:37 +0000173
Fred Drake4ccf4a12000-11-21 22:02:22 +0000174 if self._makeParentNodes:
175 oldChild.parentNode = None
176 return oldChild
177
178 def normalize(self):
Fred Drakef7cf40d2000-12-14 18:16:11 +0000179 L = []
180 for child in self.childNodes:
181 if child.nodeType == Node.TEXT_NODE:
182 data = child.data
183 if data and L and L[-1].nodeType == child.nodeType:
Fred Drake4ccf4a12000-11-21 22:02:22 +0000184 # collapse text node
185 node = L[-1]
186 node.data = node.nodeValue = node.data + child.data
187 node.nextSibling = child.nextSibling
188 child.unlink()
Fred Drakef7cf40d2000-12-14 18:16:11 +0000189 elif data:
190 if L:
191 L[-1].nextSibling = child
192 child.previousSibling = L[-1]
193 else:
194 child.previousSibling = None
195 L.append(child)
Fred Drake4ccf4a12000-11-21 22:02:22 +0000196 else:
Fred Drakef7cf40d2000-12-14 18:16:11 +0000197 # empty text node; discard
198 child.unlink()
199 else:
200 if L:
Fred Drake4ccf4a12000-11-21 22:02:22 +0000201 L[-1].nextSibling = child
202 child.previousSibling = L[-1]
Fred Drakef7cf40d2000-12-14 18:16:11 +0000203 else:
204 child.previousSibling = None
205 L.append(child)
206 if child.nodeType == Node.ELEMENT_NODE:
Fred Drake4ccf4a12000-11-21 22:02:22 +0000207 child.normalize()
Fred Drakef7cf40d2000-12-14 18:16:11 +0000208 self.childNodes[:] = L
Paul Prescod73678da2000-07-01 04:58:47 +0000209
Fred Drake1f549022000-09-24 05:21:58 +0000210 def cloneNode(self, deep):
Paul Prescod73678da2000-07-01 04:58:47 +0000211 import new
Fred Drake4ccf4a12000-11-21 22:02:22 +0000212 clone = new.instance(self.__class__, self.__dict__.copy())
213 if self._makeParentNodes:
214 clone.parentNode = None
215 clone.childNodes = []
216 if deep:
217 for child in self.childNodes:
218 clone.appendChild(child.cloneNode(1))
Paul Prescod73678da2000-07-01 04:58:47 +0000219 return clone
Fred Drake55c38192000-06-29 19:39:57 +0000220
Fred Drake1f549022000-09-24 05:21:58 +0000221 def unlink(self):
222 self.parentNode = None
Fred Drake4ccf4a12000-11-21 22:02:22 +0000223 for child in self.childNodes:
224 child.unlink()
Fred Drake1f549022000-09-24 05:21:58 +0000225 self.childNodes = None
Paul Prescod4221ff02000-10-13 20:11:42 +0000226 self.previousSibling = None
227 self.nextSibling = None
Paul Prescod73678da2000-07-01 04:58:47 +0000228 if Node._debug:
Fred Drake1f549022000-09-24 05:21:58 +0000229 index = repr(id(self)) + repr(self.__class__)
230 self.debug.write("Deleting: %s\n" % index)
Paul Prescod73678da2000-07-01 04:58:47 +0000231 del Node.allnodes[index]
Fred Drake55c38192000-06-29 19:39:57 +0000232
Fred Drake1f549022000-09-24 05:21:58 +0000233def _write_data(writer, data):
Fred Drake55c38192000-06-29 19:39:57 +0000234 "Writes datachars to writer."
Fred Drake4ccf4a12000-11-21 22:02:22 +0000235 replace = _string.replace
236 data = replace(data, "&", "&amp;")
237 data = replace(data, "<", "&lt;")
238 data = replace(data, "\"", "&quot;")
239 data = replace(data, ">", "&gt;")
Fred Drake55c38192000-06-29 19:39:57 +0000240 writer.write(data)
241
Fred Drake1f549022000-09-24 05:21:58 +0000242def _getElementsByTagNameHelper(parent, name, rc):
Fred Drake55c38192000-06-29 19:39:57 +0000243 for node in parent.childNodes:
Fred Drake1f549022000-09-24 05:21:58 +0000244 if node.nodeType == Node.ELEMENT_NODE and \
245 (name == "*" or node.tagName == name):
246 rc.append(node)
247 _getElementsByTagNameHelper(node, name, rc)
Fred Drake55c38192000-06-29 19:39:57 +0000248 return rc
249
Fred Drake1f549022000-09-24 05:21:58 +0000250def _getElementsByTagNameNSHelper(parent, nsURI, localName, rc):
Fred Drake55c38192000-06-29 19:39:57 +0000251 for node in parent.childNodes:
Fred Drake1f549022000-09-24 05:21:58 +0000252 if node.nodeType == Node.ELEMENT_NODE:
253 if ((localName == "*" or node.tagName == localName) and
254 (nsURI == "*" or node.namespaceURI == nsURI)):
255 rc.append(node)
Fred Drakef7cf40d2000-12-14 18:16:11 +0000256 _getElementsByTagNameNSHelper(node, nsURI, localName, rc)
257 return rc
Fred Drake55c38192000-06-29 19:39:57 +0000258
259class Attr(Node):
Fred Drake1f549022000-09-24 05:21:58 +0000260 nodeType = Node.ATTRIBUTE_NODE
Fred Drake4ccf4a12000-11-21 22:02:22 +0000261 attributes = None
262 ownerElement = None
Andrew M. Kuchling291ed4f2000-12-31 03:50:23 +0000263 childNodeTypes = (Node.TEXT_NODE, Node.ENTITY_REFERENCE_NODE)
Martin v. Löwis52ce0d02001-01-27 08:47:37 +0000264
Fred Drake1f549022000-09-24 05:21:58 +0000265 def __init__(self, qName, namespaceURI="", localName=None, prefix=None):
Fred Drake55c38192000-06-29 19:39:57 +0000266 # skip setattr for performance
Fred Drake4ccf4a12000-11-21 22:02:22 +0000267 d = self.__dict__
268 d["localName"] = localName or qName
269 d["nodeName"] = d["name"] = qName
270 d["namespaceURI"] = namespaceURI
271 d["prefix"] = prefix
Fred Drake1f549022000-09-24 05:21:58 +0000272 Node.__init__(self)
Paul Prescod73678da2000-07-01 04:58:47 +0000273 # nodeValue and value are set elsewhere
Fred Drake55c38192000-06-29 19:39:57 +0000274
Fred Drake1f549022000-09-24 05:21:58 +0000275 def __setattr__(self, name, value):
Fred Drakef7cf40d2000-12-14 18:16:11 +0000276 d = self.__dict__
Fred Drake1f549022000-09-24 05:21:58 +0000277 if name in ("value", "nodeValue"):
Fred Drakef7cf40d2000-12-14 18:16:11 +0000278 d["value"] = d["nodeValue"] = value
279 elif name in ("name", "nodeName"):
280 d["name"] = d["nodeName"] = value
Fred Drake55c38192000-06-29 19:39:57 +0000281 else:
Fred Drakef7cf40d2000-12-14 18:16:11 +0000282 d[name] = value
Fred Drake55c38192000-06-29 19:39:57 +0000283
Fred Drake4ccf4a12000-11-21 22:02:22 +0000284 def cloneNode(self, deep):
285 clone = Node.cloneNode(self, deep)
286 if clone.__dict__.has_key("ownerElement"):
287 del clone.ownerElement
288 return clone
289
Fred Drakef7cf40d2000-12-14 18:16:11 +0000290
291class NamedNodeMap:
Fred Drake4ccf4a12000-11-21 22:02:22 +0000292 """The attribute list is a transient interface to the underlying
293 dictionaries. Mutations here will change the underlying element's
Fred Drakef7cf40d2000-12-14 18:16:11 +0000294 dictionary.
295
296 Ordering is imposed artificially and does not reflect the order of
297 attributes as found in an input document.
298 """
Fred Drake4ccf4a12000-11-21 22:02:22 +0000299
Fred Drake1f549022000-09-24 05:21:58 +0000300 def __init__(self, attrs, attrsNS):
301 self._attrs = attrs
302 self._attrsNS = attrsNS
Fred Drakef7cf40d2000-12-14 18:16:11 +0000303
304 def __getattr__(self, name):
305 if name == "length":
306 return len(self._attrs)
307 raise AttributeError, name
Fred Drake55c38192000-06-29 19:39:57 +0000308
Fred Drake1f549022000-09-24 05:21:58 +0000309 def item(self, index):
Fred Drake55c38192000-06-29 19:39:57 +0000310 try:
Fred Drakef7cf40d2000-12-14 18:16:11 +0000311 return self[self._attrs.keys()[index]]
Fred Drake55c38192000-06-29 19:39:57 +0000312 except IndexError:
313 return None
Fred Drake55c38192000-06-29 19:39:57 +0000314
Fred Drake1f549022000-09-24 05:21:58 +0000315 def items(self):
Fred Drake4ccf4a12000-11-21 22:02:22 +0000316 L = []
317 for node in self._attrs.values():
Martin v. Löwisd5fb58f2001-01-27 08:38:34 +0000318 L.append((node.nodeName, node.value))
Fred Drake4ccf4a12000-11-21 22:02:22 +0000319 return L
Fred Drake1f549022000-09-24 05:21:58 +0000320
321 def itemsNS(self):
Fred Drake4ccf4a12000-11-21 22:02:22 +0000322 L = []
323 for node in self._attrs.values():
324 L.append(((node.URI, node.localName), node.value))
325 return L
Fred Drake16f63292000-10-23 18:09:50 +0000326
Fred Drake1f549022000-09-24 05:21:58 +0000327 def keys(self):
Paul Prescod73678da2000-07-01 04:58:47 +0000328 return self._attrs.keys()
Fred Drake55c38192000-06-29 19:39:57 +0000329
Fred Drake1f549022000-09-24 05:21:58 +0000330 def keysNS(self):
Paul Prescod73678da2000-07-01 04:58:47 +0000331 return self._attrsNS.keys()
Fred Drake55c38192000-06-29 19:39:57 +0000332
Fred Drake1f549022000-09-24 05:21:58 +0000333 def values(self):
Paul Prescod73678da2000-07-01 04:58:47 +0000334 return self._attrs.values()
Fred Drake55c38192000-06-29 19:39:57 +0000335
Martin v. Löwisd5fb58f2001-01-27 08:38:34 +0000336 def get(self, name, value = None):
337 return self._attrs.get(name, value)
338
Fred Drake1f549022000-09-24 05:21:58 +0000339 def __len__(self):
Fred Drake55c38192000-06-29 19:39:57 +0000340 return self.length
341
Fred Drake1f549022000-09-24 05:21:58 +0000342 def __cmp__(self, other):
343 if self._attrs is getattr(other, "_attrs", None):
Fred Drake55c38192000-06-29 19:39:57 +0000344 return 0
Fred Drake16f63292000-10-23 18:09:50 +0000345 else:
Fred Drake1f549022000-09-24 05:21:58 +0000346 return cmp(id(self), id(other))
Fred Drake55c38192000-06-29 19:39:57 +0000347
348 #FIXME: is it appropriate to return .value?
Fred Drake1f549022000-09-24 05:21:58 +0000349 def __getitem__(self, attname_or_tuple):
Fred Drake4ccf4a12000-11-21 22:02:22 +0000350 if type(attname_or_tuple) is _TupleType:
Paul Prescod73678da2000-07-01 04:58:47 +0000351 return self._attrsNS[attname_or_tuple]
Fred Drake55c38192000-06-29 19:39:57 +0000352 else:
Paul Prescod73678da2000-07-01 04:58:47 +0000353 return self._attrs[attname_or_tuple]
Fred Drake55c38192000-06-29 19:39:57 +0000354
Paul Prescod1e688272000-07-01 19:21:47 +0000355 # same as set
Fred Drake1f549022000-09-24 05:21:58 +0000356 def __setitem__(self, attname, value):
Fred Drake4ccf4a12000-11-21 22:02:22 +0000357 if type(value) in _StringTypes:
Fred Drake1f549022000-09-24 05:21:58 +0000358 node = Attr(attname)
Fred Drake4ccf4a12000-11-21 22:02:22 +0000359 node.value = value
Paul Prescod1e688272000-07-01 19:21:47 +0000360 else:
Fred Drake4ccf4a12000-11-21 22:02:22 +0000361 if not isinstance(value, Attr):
362 raise TypeError, "value must be a string or Attr object"
Fred Drake1f549022000-09-24 05:21:58 +0000363 node = value
Fred Drakef7cf40d2000-12-14 18:16:11 +0000364 self.setNamedItem(node)
365
366 def setNamedItem(self, node):
367 old = self._attrs.get(node.name)
Paul Prescod1e688272000-07-01 19:21:47 +0000368 if old:
369 old.unlink()
Fred Drake1f549022000-09-24 05:21:58 +0000370 self._attrs[node.name] = node
371 self._attrsNS[(node.namespaceURI, node.localName)] = node
Fred Drakef7cf40d2000-12-14 18:16:11 +0000372 return old
373
374 def setNamedItemNS(self, node):
375 return self.setNamedItem(node)
Paul Prescod73678da2000-07-01 04:58:47 +0000376
Fred Drake1f549022000-09-24 05:21:58 +0000377 def __delitem__(self, attname_or_tuple):
378 node = self[attname_or_tuple]
Paul Prescod73678da2000-07-01 04:58:47 +0000379 node.unlink()
380 del self._attrs[node.name]
381 del self._attrsNS[(node.namespaceURI, node.localName)]
Fred Drakef7cf40d2000-12-14 18:16:11 +0000382 self.length = len(self._attrs)
383
384AttributeList = NamedNodeMap
385
Fred Drake1f549022000-09-24 05:21:58 +0000386
Martin v. Löwisa2fda0d2000-10-07 12:10:28 +0000387class Element(Node):
Fred Drake1f549022000-09-24 05:21:58 +0000388 nodeType = Node.ELEMENT_NODE
Fred Drake4ccf4a12000-11-21 22:02:22 +0000389 nextSibling = None
390 previousSibling = None
Andrew M. Kuchling291ed4f2000-12-31 03:50:23 +0000391 childNodeTypes = (Node.ELEMENT_NODE, Node.PROCESSING_INSTRUCTION_NODE,
392 Node.COMMENT_NODE, Node.TEXT_NODE,
393 Node.CDATA_SECTION_NODE, Node.ENTITY_REFERENCE_NODE)
Martin v. Löwis52ce0d02001-01-27 08:47:37 +0000394
Fred Drake1f549022000-09-24 05:21:58 +0000395 def __init__(self, tagName, namespaceURI="", prefix="",
396 localName=None):
397 Node.__init__(self)
Fred Drake55c38192000-06-29 19:39:57 +0000398 self.tagName = self.nodeName = tagName
Fred Drake1f549022000-09-24 05:21:58 +0000399 self.localName = localName or tagName
400 self.prefix = prefix
401 self.namespaceURI = namespaceURI
402 self.nodeValue = None
Fred Drake55c38192000-06-29 19:39:57 +0000403
Fred Drake4ccf4a12000-11-21 22:02:22 +0000404 self._attrs = {} # attributes are double-indexed:
405 self._attrsNS = {} # tagName -> Attribute
406 # URI,localName -> Attribute
407 # in the future: consider lazy generation
408 # of attribute objects this is too tricky
409 # for now because of headaches with
410 # namespaces.
411
412 def cloneNode(self, deep):
413 clone = Node.cloneNode(self, deep)
414 clone._attrs = {}
415 clone._attrsNS = {}
416 for attr in self._attrs.values():
417 node = attr.cloneNode(1)
418 clone._attrs[node.name] = node
419 clone._attrsNS[(node.namespaceURI, node.localName)] = node
420 node.ownerElement = clone
421 return clone
422
423 def unlink(self):
424 for attr in self._attrs.values():
425 attr.unlink()
426 self._attrs = None
427 self._attrsNS = None
428 Node.unlink(self)
Fred Drake55c38192000-06-29 19:39:57 +0000429
Fred Drake1f549022000-09-24 05:21:58 +0000430 def getAttribute(self, attname):
Paul Prescod73678da2000-07-01 04:58:47 +0000431 return self._attrs[attname].value
Fred Drake55c38192000-06-29 19:39:57 +0000432
Fred Drake1f549022000-09-24 05:21:58 +0000433 def getAttributeNS(self, namespaceURI, localName):
Paul Prescod73678da2000-07-01 04:58:47 +0000434 return self._attrsNS[(namespaceURI, localName)].value
Fred Drake1f549022000-09-24 05:21:58 +0000435
436 def setAttribute(self, attname, value):
437 attr = Attr(attname)
Fred Drake55c38192000-06-29 19:39:57 +0000438 # for performance
Fred Drake1f549022000-09-24 05:21:58 +0000439 attr.__dict__["value"] = attr.__dict__["nodeValue"] = value
440 self.setAttributeNode(attr)
Fred Drake55c38192000-06-29 19:39:57 +0000441
Fred Drake1f549022000-09-24 05:21:58 +0000442 def setAttributeNS(self, namespaceURI, qualifiedName, value):
443 prefix, localname = _nssplit(qualifiedName)
Fred Drake55c38192000-06-29 19:39:57 +0000444 # for performance
Fred Drake1f549022000-09-24 05:21:58 +0000445 attr = Attr(qualifiedName, namespaceURI, localname, prefix)
446 attr.__dict__["value"] = attr.__dict__["nodeValue"] = value
447 self.setAttributeNode(attr)
Fred Drake55c38192000-06-29 19:39:57 +0000448
Fred Drake1f549022000-09-24 05:21:58 +0000449 def getAttributeNode(self, attrname):
450 return self._attrs.get(attrname)
Paul Prescod73678da2000-07-01 04:58:47 +0000451
Fred Drake1f549022000-09-24 05:21:58 +0000452 def getAttributeNodeNS(self, namespaceURI, localName):
Paul Prescod73678da2000-07-01 04:58:47 +0000453 return self._attrsNS[(namespaceURI, localName)]
454
Fred Drake1f549022000-09-24 05:21:58 +0000455 def setAttributeNode(self, attr):
Fred Drake4ccf4a12000-11-21 22:02:22 +0000456 if attr.ownerElement not in (None, self):
Martin v. Löwisd5fb58f2001-01-27 08:38:34 +0000457 raise xml.dom.InuseAttributeErr("attribute node already owned")
Fred Drake1f549022000-09-24 05:21:58 +0000458 old = self._attrs.get(attr.name, None)
Paul Prescod73678da2000-07-01 04:58:47 +0000459 if old:
460 old.unlink()
Fred Drake1f549022000-09-24 05:21:58 +0000461 self._attrs[attr.name] = attr
462 self._attrsNS[(attr.namespaceURI, attr.localName)] = attr
Fred Drake4ccf4a12000-11-21 22:02:22 +0000463
464 # This creates a circular reference, but Element.unlink()
465 # breaks the cycle since the references to the attribute
466 # dictionaries are tossed.
467 attr.ownerElement = self
468
469 if old is not attr:
470 # It might have already been part of this node, in which case
471 # it doesn't represent a change, and should not be returned.
472 return old
Fred Drake55c38192000-06-29 19:39:57 +0000473
Fred Drake1f549022000-09-24 05:21:58 +0000474 def removeAttribute(self, name):
Paul Prescod73678da2000-07-01 04:58:47 +0000475 attr = self._attrs[name]
Fred Drake1f549022000-09-24 05:21:58 +0000476 self.removeAttributeNode(attr)
Fred Drake55c38192000-06-29 19:39:57 +0000477
Fred Drake1f549022000-09-24 05:21:58 +0000478 def removeAttributeNS(self, namespaceURI, localName):
Paul Prescod73678da2000-07-01 04:58:47 +0000479 attr = self._attrsNS[(namespaceURI, localName)]
Fred Drake1f549022000-09-24 05:21:58 +0000480 self.removeAttributeNode(attr)
Fred Drake55c38192000-06-29 19:39:57 +0000481
Fred Drake1f549022000-09-24 05:21:58 +0000482 def removeAttributeNode(self, node):
Paul Prescod73678da2000-07-01 04:58:47 +0000483 node.unlink()
484 del self._attrs[node.name]
485 del self._attrsNS[(node.namespaceURI, node.localName)]
Fred Drake16f63292000-10-23 18:09:50 +0000486
Martin v. Löwis156c3372000-12-28 18:40:56 +0000487 def hasAttribute(self, name):
488 return self._attrs.has_key(name)
Martin v. Löwis52ce0d02001-01-27 08:47:37 +0000489
Martin v. Löwis156c3372000-12-28 18:40:56 +0000490 def hasAttributeNS(self, namespaceURI, localName):
Martin v. Löwis52ce0d02001-01-27 08:47:37 +0000491 return self._attrsNS.has_key((namespaceURI, localName))
492
Fred Drake1f549022000-09-24 05:21:58 +0000493 def getElementsByTagName(self, name):
494 return _getElementsByTagNameHelper(self, name, [])
Fred Drake55c38192000-06-29 19:39:57 +0000495
Fred Drake1f549022000-09-24 05:21:58 +0000496 def getElementsByTagNameNS(self, namespaceURI, localName):
497 _getElementsByTagNameNSHelper(self, namespaceURI, localName, [])
Fred Drake55c38192000-06-29 19:39:57 +0000498
Fred Drake1f549022000-09-24 05:21:58 +0000499 def __repr__(self):
500 return "<DOM Element: %s at %s>" % (self.tagName, id(self))
Fred Drake55c38192000-06-29 19:39:57 +0000501
502 def writexml(self, writer):
Fred Drake1f549022000-09-24 05:21:58 +0000503 writer.write("<" + self.tagName)
Fred Drake16f63292000-10-23 18:09:50 +0000504
Fred Drake4ccf4a12000-11-21 22:02:22 +0000505 attrs = self._get_attributes()
506 a_names = attrs.keys()
Fred Drake55c38192000-06-29 19:39:57 +0000507 a_names.sort()
508
509 for a_name in a_names:
Fred Drake1f549022000-09-24 05:21:58 +0000510 writer.write(" %s=\"" % a_name)
Fred Drake4ccf4a12000-11-21 22:02:22 +0000511 _write_data(writer, attrs[a_name].value)
Fred Drake55c38192000-06-29 19:39:57 +0000512 writer.write("\"")
513 if self.childNodes:
514 writer.write(">")
515 for node in self.childNodes:
Fred Drake1f549022000-09-24 05:21:58 +0000516 node.writexml(writer)
517 writer.write("</%s>" % self.tagName)
Fred Drake55c38192000-06-29 19:39:57 +0000518 else:
519 writer.write("/>")
520
Fred Drake1f549022000-09-24 05:21:58 +0000521 def _get_attributes(self):
522 return AttributeList(self._attrs, self._attrsNS)
Fred Drake55c38192000-06-29 19:39:57 +0000523
Fred Drake1f549022000-09-24 05:21:58 +0000524class Comment(Node):
525 nodeType = Node.COMMENT_NODE
Fred Drake4ccf4a12000-11-21 22:02:22 +0000526 nodeName = "#comment"
527 attributes = None
Andrew M. Kuchling291ed4f2000-12-31 03:50:23 +0000528 childNodeTypes = ()
Martin v. Löwis52ce0d02001-01-27 08:47:37 +0000529
Fred Drake1f549022000-09-24 05:21:58 +0000530 def __init__(self, data):
531 Node.__init__(self)
532 self.data = self.nodeValue = data
Fred Drake55c38192000-06-29 19:39:57 +0000533
Fred Drake1f549022000-09-24 05:21:58 +0000534 def writexml(self, writer):
535 writer.write("<!--%s-->" % self.data)
536
537class ProcessingInstruction(Node):
538 nodeType = Node.PROCESSING_INSTRUCTION_NODE
Fred Drake4ccf4a12000-11-21 22:02:22 +0000539 attributes = None
Andrew M. Kuchling291ed4f2000-12-31 03:50:23 +0000540 childNodeTypes = ()
Martin v. Löwis52ce0d02001-01-27 08:47:37 +0000541
Fred Drake1f549022000-09-24 05:21:58 +0000542 def __init__(self, target, data):
543 Node.__init__(self)
Fred Drake55c38192000-06-29 19:39:57 +0000544 self.target = self.nodeName = target
545 self.data = self.nodeValue = data
Fred Drake55c38192000-06-29 19:39:57 +0000546
Fred Drake1f549022000-09-24 05:21:58 +0000547 def writexml(self, writer):
548 writer.write("<?%s %s?>" % (self.target, self.data))
Fred Drake55c38192000-06-29 19:39:57 +0000549
Fred Drake1f549022000-09-24 05:21:58 +0000550class Text(Node):
551 nodeType = Node.TEXT_NODE
552 nodeName = "#text"
Fred Drake4ccf4a12000-11-21 22:02:22 +0000553 attributes = None
Andrew M. Kuchling291ed4f2000-12-31 03:50:23 +0000554 childNodeTypes = ()
Martin v. Löwis52ce0d02001-01-27 08:47:37 +0000555
Fred Drake1f549022000-09-24 05:21:58 +0000556 def __init__(self, data):
Fred Drakedaa823a2001-01-08 04:04:34 +0000557 if type(data) not in _StringTypes:
558 raise TypeError, "node contents must be a string"
Fred Drake1f549022000-09-24 05:21:58 +0000559 Node.__init__(self)
Fred Drake55c38192000-06-29 19:39:57 +0000560 self.data = self.nodeValue = data
Fred Drake55c38192000-06-29 19:39:57 +0000561
562 def __repr__(self):
Fred Drake1f549022000-09-24 05:21:58 +0000563 if len(self.data) > 10:
564 dotdotdot = "..."
Fred Drake55c38192000-06-29 19:39:57 +0000565 else:
Fred Drake1f549022000-09-24 05:21:58 +0000566 dotdotdot = ""
567 return "<DOM Text node \"%s%s\">" % (self.data[0:10], dotdotdot)
Fred Drake55c38192000-06-29 19:39:57 +0000568
Fred Drakef7cf40d2000-12-14 18:16:11 +0000569 def splitText(self, offset):
570 if offset < 0 or offset > len(self.data):
Martin v. Löwisd5fb58f2001-01-27 08:38:34 +0000571 raise xml.dom.IndexSizeErr("illegal offset value")
Fred Drakef7cf40d2000-12-14 18:16:11 +0000572 newText = Text(self.data[offset:])
573 next = self.nextSibling
574 if self.parentNode and self in self.parentNode.childNodes:
575 if next is None:
576 self.parentNode.appendChild(newText)
577 else:
578 self.parentNode.insertBefore(newText, next)
579 self.data = self.data[:offset]
580 return newText
581
Fred Drake1f549022000-09-24 05:21:58 +0000582 def writexml(self, writer):
583 _write_data(writer, self.data)
Fred Drake55c38192000-06-29 19:39:57 +0000584
Fred Drake1f549022000-09-24 05:21:58 +0000585def _nssplit(qualifiedName):
Fred Drake4ccf4a12000-11-21 22:02:22 +0000586 fields = _string.split(qualifiedName, ':', 1)
Paul Prescod73678da2000-07-01 04:58:47 +0000587 if len(fields) == 2:
588 return fields
589 elif len(fields) == 1:
Fred Drake1f549022000-09-24 05:21:58 +0000590 return ('', fields[0])
Paul Prescod73678da2000-07-01 04:58:47 +0000591
Fred Drakef7cf40d2000-12-14 18:16:11 +0000592
593class DocumentType(Node):
594 nodeType = Node.DOCUMENT_TYPE_NODE
595 nodeValue = None
596 attributes = None
597 name = None
598 publicId = None
599 systemId = None
600 internalSubset = ""
601 entities = None
602 notations = None
603
604 def __init__(self, qualifiedName):
605 Node.__init__(self)
606 if qualifiedName:
607 prefix, localname = _nssplit(qualifiedName)
608 self.name = localname
609
610
611class DOMImplementation:
612 def hasFeature(self, feature, version):
613 if version not in ("1.0", "2.0"):
614 return 0
615 feature = _string.lower(feature)
616 return feature == "core"
617
618 def createDocument(self, namespaceURI, qualifiedName, doctype):
619 if doctype and doctype.parentNode is not None:
Martin v. Löwisd5fb58f2001-01-27 08:38:34 +0000620 raise xml.dom.WrongDocumentErr("doctype object owned by another DOM tree")
Fred Drakef7cf40d2000-12-14 18:16:11 +0000621 doc = Document()
622 if doctype is None:
623 doctype = self.createDocumentType(qualifiedName, None, None)
624 if qualifiedName:
625 prefix, localname = _nssplit(qualifiedName)
626 if prefix == "xml" \
627 and namespaceURI != "http://www.w3.org/XML/1998/namespace":
Martin v. Löwisd5fb58f2001-01-27 08:38:34 +0000628 raise xml.dom.NamespaceErr("illegal use of 'xml' prefix")
Fred Drakef7cf40d2000-12-14 18:16:11 +0000629 if prefix and not namespaceURI:
Martin v. Löwisd5fb58f2001-01-27 08:38:34 +0000630 raise xml.dom.NamespaceErr("illegal use of prefix without namespaces")
Fred Drakef7cf40d2000-12-14 18:16:11 +0000631 doctype.parentNode = doc
632 doc.doctype = doctype
633 doc.implementation = self
634 return doc
635
636 def createDocumentType(self, qualifiedName, publicId, systemId):
637 doctype = DocumentType(qualifiedName)
638 doctype.publicId = publicId
639 doctype.systemId = systemId
640 return doctype
641
642
Fred Drake1f549022000-09-24 05:21:58 +0000643class Document(Node):
644 nodeType = Node.DOCUMENT_NODE
Fred Drake4ccf4a12000-11-21 22:02:22 +0000645 nodeName = "#document"
646 nodeValue = None
647 attributes = None
Fred Drakef7cf40d2000-12-14 18:16:11 +0000648 doctype = None
649 parentNode = None
650
651 implementation = DOMImplementation()
Andrew M. Kuchling291ed4f2000-12-31 03:50:23 +0000652 childNodeTypes = (Node.ELEMENT_NODE, Node.PROCESSING_INSTRUCTION_NODE,
653 Node.COMMENT_NODE, Node.DOCUMENT_TYPE_NODE)
Fred Drake55c38192000-06-29 19:39:57 +0000654
Fred Drake1f549022000-09-24 05:21:58 +0000655 def appendChild(self, node):
Andrew M. Kuchling291ed4f2000-12-31 03:50:23 +0000656 if node.nodeType not in self.childNodeTypes:
657 raise HierarchyRequestErr, \
658 "%s cannot be child of %s" % (repr(node), repr(self) )
Andrew M. Kuchling04a45e92000-12-20 14:47:24 +0000659 if node.parentNode is not None:
660 node.parentNode.removeChild(node)
661
Fred Drakef7cf40d2000-12-14 18:16:11 +0000662 if node.nodeType == Node.ELEMENT_NODE \
663 and self._get_documentElement():
Martin v. Löwisd5fb58f2001-01-27 08:38:34 +0000664 raise xml.dom.HierarchyRequestErr("two document elements disallowed")
Fred Drake4ccf4a12000-11-21 22:02:22 +0000665 return Node.appendChild(self, node)
Paul Prescod73678da2000-07-01 04:58:47 +0000666
Andrew M. Kuchling04a45e92000-12-20 14:47:24 +0000667 def removeChild(self, oldChild):
668 self.childNodes.remove(oldChild)
669 oldChild.nextSibling = oldChild.previousSibling = None
670 oldChild.parentNode = None
671 if self.documentElement is oldChild:
672 self.documentElement = None
Martin v. Löwis52ce0d02001-01-27 08:47:37 +0000673
Andrew M. Kuchling04a45e92000-12-20 14:47:24 +0000674 return oldChild
675
Fred Drakef7cf40d2000-12-14 18:16:11 +0000676 def _get_documentElement(self):
677 for node in self.childNodes:
678 if node.nodeType == Node.ELEMENT_NODE:
679 return node
680
681 def unlink(self):
682 if self.doctype is not None:
683 self.doctype.unlink()
684 self.doctype = None
685 Node.unlink(self)
686
Fred Drake1f549022000-09-24 05:21:58 +0000687 createElement = Element
Fred Drake55c38192000-06-29 19:39:57 +0000688
Fred Drake1f549022000-09-24 05:21:58 +0000689 createTextNode = Text
Fred Drake55c38192000-06-29 19:39:57 +0000690
Fred Drake1f549022000-09-24 05:21:58 +0000691 createComment = Comment
Fred Drake55c38192000-06-29 19:39:57 +0000692
Fred Drake1f549022000-09-24 05:21:58 +0000693 createProcessingInstruction = ProcessingInstruction
Fred Drake55c38192000-06-29 19:39:57 +0000694
Fred Drake1f549022000-09-24 05:21:58 +0000695 createAttribute = Attr
Fred Drake55c38192000-06-29 19:39:57 +0000696
697 def createElementNS(self, namespaceURI, qualifiedName):
Fred Drake4ccf4a12000-11-21 22:02:22 +0000698 prefix, localName = _nssplit(qualifiedName)
699 return self.createElement(qualifiedName, namespaceURI,
700 prefix, localName)
Fred Drake55c38192000-06-29 19:39:57 +0000701
702 def createAttributeNS(self, namespaceURI, qualifiedName):
Fred Drake4ccf4a12000-11-21 22:02:22 +0000703 prefix, localName = _nssplit(qualifiedName)
704 return self.createAttribute(qualifiedName, namespaceURI,
705 localName, prefix)
Fred Drake55c38192000-06-29 19:39:57 +0000706
Fred Drake1f549022000-09-24 05:21:58 +0000707 def getElementsByTagNameNS(self, namespaceURI, localName):
708 _getElementsByTagNameNSHelper(self, namespaceURI, localName)
Fred Drake55c38192000-06-29 19:39:57 +0000709
Fred Drake1f549022000-09-24 05:21:58 +0000710 def getElementsByTagName(self, name):
711 rc = []
712 _getElementsByTagNameHelper(self, name, rc)
Fred Drake55c38192000-06-29 19:39:57 +0000713 return rc
714
Fred Drake1f549022000-09-24 05:21:58 +0000715 def writexml(self, writer):
Fred Drake55c38192000-06-29 19:39:57 +0000716 for node in self.childNodes:
Fred Drake1f549022000-09-24 05:21:58 +0000717 node.writexml(writer)
Fred Drake55c38192000-06-29 19:39:57 +0000718
Fred Drake4ccf4a12000-11-21 22:02:22 +0000719def _get_StringIO():
Fred Drakef7cf40d2000-12-14 18:16:11 +0000720 # we can't use cStringIO since it doesn't support Unicode strings
721 from StringIO import StringIO
Fred Drake4ccf4a12000-11-21 22:02:22 +0000722 return StringIO()
723
Fred Drake1f549022000-09-24 05:21:58 +0000724def _doparse(func, args, kwargs):
725 events = apply(func, args, kwargs)
726 toktype, rootNode = events.getEvent()
727 events.expandNode(rootNode)
Fred Drake55c38192000-06-29 19:39:57 +0000728 return rootNode
729
Fred Drake1f549022000-09-24 05:21:58 +0000730def parse(*args, **kwargs):
Fred Drakef7cf40d2000-12-14 18:16:11 +0000731 """Parse a file into a DOM by filename or file object."""
Fred Drake4ccf4a12000-11-21 22:02:22 +0000732 from xml.dom import pulldom
Fred Drake1f549022000-09-24 05:21:58 +0000733 return _doparse(pulldom.parse, args, kwargs)
Fred Drake55c38192000-06-29 19:39:57 +0000734
Fred Drake1f549022000-09-24 05:21:58 +0000735def parseString(*args, **kwargs):
Fred Drakef7cf40d2000-12-14 18:16:11 +0000736 """Parse a file into a DOM from a string."""
Fred Drake4ccf4a12000-11-21 22:02:22 +0000737 from xml.dom import pulldom
Fred Drake1f549022000-09-24 05:21:58 +0000738 return _doparse(pulldom.parseString, args, kwargs)