paulb@18 | 1 | #!/usr/bin/env python |
paulb@18 | 2 | |
paulb@18 | 3 | """ |
paulb@75 | 4 | DOM wrapper around libxml2, specifically the libxml2mod Python extension module. |
paulb@18 | 5 | """ |
paulb@18 | 6 | |
paulb@72 | 7 | __version__ = "0.2" |
paulb@27 | 8 | |
paulb@18 | 9 | import libxml2 |
paulb@72 | 10 | from libxml2dom.macrolib import * |
paulb@72 | 11 | from libxml2dom.macrolib import \ |
paulb@72 | 12 | createDocument as Node_createDocument, \ |
paulb@72 | 13 | parseString as Node_parseString, parseURI as Node_parseURI, \ |
paulb@72 | 14 | parseFile as Node_parseFile, \ |
paulb@72 | 15 | toString as Node_toString, toStream as Node_toStream, \ |
paulb@72 | 16 | toFile as Node_toFile |
paulb@75 | 17 | import weakref |
paulb@18 | 18 | |
paulb@86 | 19 | # Attribute and node list wrappers. |
paulb@18 | 20 | |
paulb@18 | 21 | class NamedNodeMap(object): |
paulb@18 | 22 | |
paulb@75 | 23 | """ |
paulb@75 | 24 | A wrapper around Node objects providing DOM and dictionary convenience |
paulb@75 | 25 | methods. |
paulb@75 | 26 | """ |
paulb@75 | 27 | |
paulb@18 | 28 | def __init__(self, node): |
paulb@18 | 29 | self.node = node |
paulb@18 | 30 | |
paulb@18 | 31 | def getNamedItem(self, name): |
paulb@72 | 32 | return self.node.getAttributeNode(name) |
paulb@18 | 33 | |
paulb@18 | 34 | def getNamedItemNS(self, ns, localName): |
paulb@72 | 35 | return self.node.getAttributeNodeNS(ns, localName) |
paulb@18 | 36 | |
paulb@18 | 37 | def setNamedItem(self, node): |
paulb@91 | 38 | try: |
paulb@91 | 39 | old = self.getNamedItem(node.nodeName) |
paulb@91 | 40 | except KeyError: |
paulb@91 | 41 | old = None |
paulb@86 | 42 | self.node.setAttributeNode(node) |
paulb@91 | 43 | return old |
paulb@18 | 44 | |
paulb@18 | 45 | def setNamedItemNS(self, node): |
paulb@91 | 46 | try: |
paulb@91 | 47 | old = self.getNamedItemNS(node.namespaceURI, node.localName) |
paulb@91 | 48 | except KeyError: |
paulb@91 | 49 | old = None |
paulb@86 | 50 | self.node.setAttributeNodeNS(node) |
paulb@91 | 51 | return old |
paulb@91 | 52 | |
paulb@91 | 53 | def removeNamedItem(self, name): |
paulb@91 | 54 | try: |
paulb@91 | 55 | old = self.getNamedItem(name) |
paulb@91 | 56 | except KeyError: |
paulb@91 | 57 | old = None |
paulb@91 | 58 | self.node.removeAttribute(name) |
paulb@91 | 59 | return old |
paulb@91 | 60 | |
paulb@91 | 61 | def removeNamedItemNS(self, ns, localName): |
paulb@91 | 62 | try: |
paulb@91 | 63 | old = self.getNamedItemNS(ns, localName) |
paulb@91 | 64 | except KeyError: |
paulb@91 | 65 | old = None |
paulb@91 | 66 | self.node.removeAttributeNS(ns, localName) |
paulb@91 | 67 | return old |
paulb@86 | 68 | |
paulb@86 | 69 | # Dictionary emulation methods. |
paulb@18 | 70 | |
paulb@18 | 71 | def __getitem__(self, name): |
paulb@18 | 72 | return self.getNamedItem(name) |
paulb@18 | 73 | |
paulb@18 | 74 | def __setitem__(self, name, node): |
paulb@18 | 75 | if name == node.nodeName: |
paulb@18 | 76 | self.setNamedItem(node) |
paulb@18 | 77 | else: |
paulb@18 | 78 | raise KeyError, name |
paulb@18 | 79 | |
paulb@18 | 80 | def __delitem__(self, name): |
paulb@18 | 81 | # NOTE: To be implemented. |
paulb@18 | 82 | pass |
paulb@18 | 83 | |
paulb@18 | 84 | def values(self): |
paulb@88 | 85 | return [Attribute(_node, self.node.ownerDocument) for _node in Node_attributes(self.node.as_native_node()).values()] |
paulb@18 | 86 | |
paulb@18 | 87 | def keys(self): |
paulb@18 | 88 | return [(attr.namespaceURI, attr.localName) for attr in self.values()] |
paulb@18 | 89 | |
paulb@18 | 90 | def items(self): |
paulb@18 | 91 | return [((attr.namespaceURI, attr.localName), attr) for attr in self.values()] |
paulb@18 | 92 | |
paulb@18 | 93 | def __repr__(self): |
paulb@18 | 94 | return str(self) |
paulb@18 | 95 | |
paulb@18 | 96 | def __str__(self): |
paulb@18 | 97 | return "{%s}" % ",\n".join(["%s : %s" % (repr(key), repr(value)) for key, value in self.items()]) |
paulb@18 | 98 | |
paulb@86 | 99 | class NodeList(list): |
paulb@86 | 100 | |
paulb@86 | 101 | "A wrapper around node lists." |
paulb@86 | 102 | |
paulb@86 | 103 | def item(self, index): |
paulb@86 | 104 | return self[index] |
paulb@86 | 105 | |
paulb@86 | 106 | def length(self): |
paulb@86 | 107 | return len(self) |
paulb@86 | 108 | |
paulb@86 | 109 | # Node classes. |
paulb@86 | 110 | |
paulb@18 | 111 | class Node(object): |
paulb@18 | 112 | |
paulb@75 | 113 | """ |
paulb@75 | 114 | A DOM-style wrapper around libxml2mod objects. |
paulb@75 | 115 | """ |
paulb@75 | 116 | |
paulb@81 | 117 | ATTRIBUTE_NODE = xml.dom.Node.ATTRIBUTE_NODE |
paulb@81 | 118 | COMMENT_NODE = xml.dom.Node.COMMENT_NODE |
paulb@81 | 119 | DOCUMENT_NODE = xml.dom.Node.DOCUMENT_NODE |
paulb@81 | 120 | DOCUMENT_TYPE_NODE = xml.dom.Node.DOCUMENT_TYPE_NODE |
paulb@81 | 121 | ELEMENT_NODE = xml.dom.Node.ELEMENT_NODE |
paulb@81 | 122 | ENTITY_NODE = xml.dom.Node.ENTITY_NODE |
paulb@81 | 123 | ENTITY_REFERENCE_NODE = xml.dom.Node.ENTITY_REFERENCE_NODE |
paulb@81 | 124 | NOTATION_NODE = xml.dom.Node.NOTATION_NODE |
paulb@81 | 125 | PROCESSING_INSTRUCTION_NODE = xml.dom.Node.PROCESSING_INSTRUCTION_NODE |
paulb@81 | 126 | TEXT_NODE = xml.dom.Node.TEXT_NODE |
paulb@81 | 127 | |
paulb@75 | 128 | def __init__(self, node, ownerDocument=None): |
paulb@18 | 129 | self._node = node |
paulb@75 | 130 | self.ownerDocument = ownerDocument |
paulb@18 | 131 | |
paulb@18 | 132 | def as_native_node(self): |
paulb@18 | 133 | return self._node |
paulb@18 | 134 | |
paulb@18 | 135 | def _nodeType(self): |
paulb@72 | 136 | return Node_nodeType(self._node) |
paulb@18 | 137 | |
paulb@18 | 138 | def _childNodes(self): |
paulb@18 | 139 | |
paulb@18 | 140 | # NOTE: Consider a generator instead. |
paulb@18 | 141 | |
paulb@86 | 142 | return NodeList([Node(_node, self.ownerDocument) for _node in Node_childNodes(self._node)]) |
paulb@18 | 143 | |
paulb@18 | 144 | def _attributes(self): |
paulb@18 | 145 | return NamedNodeMap(self) |
paulb@18 | 146 | |
paulb@18 | 147 | def _namespaceURI(self): |
paulb@72 | 148 | return Node_namespaceURI(self._node) |
paulb@18 | 149 | |
paulb@18 | 150 | def _nodeValue(self): |
paulb@72 | 151 | return Node_nodeValue(self._node) |
paulb@18 | 152 | |
paulb@86 | 153 | def _setNodeValue(self, value): |
paulb@86 | 154 | Node_setNodeValue(self._node, value) |
paulb@86 | 155 | |
paulb@18 | 156 | def _prefix(self): |
paulb@72 | 157 | return Node_prefix(self._node) |
paulb@18 | 158 | |
paulb@18 | 159 | def _nodeName(self): |
paulb@72 | 160 | return Node_nodeName(self._node) |
paulb@18 | 161 | |
paulb@18 | 162 | def _tagName(self): |
paulb@72 | 163 | return Node_tagName(self._node) |
paulb@18 | 164 | |
paulb@18 | 165 | def _localName(self): |
paulb@72 | 166 | return Node_localName(self._node) |
paulb@18 | 167 | |
paulb@18 | 168 | def _parentNode(self): |
paulb@88 | 169 | return get_node(Node_parentNode(self._node), self) |
paulb@18 | 170 | |
paulb@24 | 171 | def _previousSibling(self): |
paulb@75 | 172 | return Node(Node_previousSibling(self._node), self.ownerDocument) |
paulb@24 | 173 | |
paulb@18 | 174 | def _nextSibling(self): |
paulb@75 | 175 | return Node(Node_nextSibling(self._node), self.ownerDocument) |
paulb@18 | 176 | |
paulb@18 | 177 | def hasAttributeNS(self, ns, localName): |
paulb@72 | 178 | return Node_hasAttributeNS(self._node, ns, localName) |
paulb@18 | 179 | |
paulb@18 | 180 | def hasAttribute(self, name): |
paulb@72 | 181 | return Node_hasAttribute(self._node, name) |
paulb@18 | 182 | |
paulb@18 | 183 | def getAttributeNS(self, ns, localName): |
paulb@72 | 184 | return Node_getAttributeNS(self._node, ns, localName) |
paulb@18 | 185 | |
paulb@18 | 186 | def getAttribute(self, name): |
paulb@72 | 187 | return Node_getAttribute(self._node, name) |
paulb@18 | 188 | |
paulb@18 | 189 | def getAttributeNodeNS(self, ns, localName): |
paulb@88 | 190 | return Attribute(Node_getAttributeNodeNS(self._node, ns, localName), self.ownerDocument) |
paulb@18 | 191 | |
paulb@18 | 192 | def getAttributeNode(self, localName): |
paulb@88 | 193 | return Attribute(Node_getAttributeNode(self._node, localName), self.ownerDocument) |
paulb@18 | 194 | |
paulb@18 | 195 | def setAttributeNS(self, ns, name, value): |
paulb@72 | 196 | Node_setAttributeNS(self._node, ns, name, value) |
paulb@18 | 197 | |
paulb@18 | 198 | def setAttribute(self, name, value): |
paulb@72 | 199 | Node_setAttribute(self._node, name, value) |
paulb@18 | 200 | |
paulb@86 | 201 | def setAttributeNodeNS(self, node): |
paulb@88 | 202 | Node_setAttributeNodeNS(self._node, node._node) |
paulb@18 | 203 | |
paulb@86 | 204 | def setAttributeNode(self, node): |
paulb@88 | 205 | Node_setAttributeNode(self._node, node._node) |
paulb@18 | 206 | |
paulb@91 | 207 | def removeAttributeNS(self, ns, localName): |
paulb@91 | 208 | Node_removeAttributeNS(self._node, ns, localName) |
paulb@91 | 209 | |
paulb@91 | 210 | def removeAttribute(self, name): |
paulb@91 | 211 | Node_removeAttribute(self._node, name) |
paulb@91 | 212 | |
paulb@18 | 213 | def createElementNS(self, ns, name): |
paulb@75 | 214 | return Node(Node_createElementNS(self._node, ns, name), self.ownerDocument) |
paulb@18 | 215 | |
paulb@18 | 216 | def createElement(self, name): |
paulb@75 | 217 | return Node(Node_createElement(self._node, name), self.ownerDocument) |
paulb@18 | 218 | |
paulb@88 | 219 | def createAttributeNS(self, ns, name): |
paulb@88 | 220 | tmp = self.createElement("tmp") |
paulb@88 | 221 | return Attribute(Node_createAttributeNS(tmp._node, ns, name)) |
paulb@18 | 222 | |
paulb@88 | 223 | def createAttribute(self, name): |
paulb@88 | 224 | tmp = self.createElement("tmp") |
paulb@88 | 225 | return Attribute(Node_createAttribute(tmp._node, name)) |
paulb@18 | 226 | |
paulb@18 | 227 | def createTextNode(self, value): |
paulb@75 | 228 | return Node(Node_createTextNode(self._node, value), self.ownerDocument) |
paulb@18 | 229 | |
paulb@34 | 230 | def createComment(self, value): |
paulb@75 | 231 | return Node(Node_createComment(self._node, value), self.ownerDocument) |
paulb@18 | 232 | |
paulb@18 | 233 | def importNode(self, node, deep): |
paulb@72 | 234 | if hasattr(node, "as_native_node"): |
paulb@75 | 235 | return Node(Node_importNode(self._node, node.as_native_node(), deep), self.ownerDocument) |
paulb@72 | 236 | else: |
paulb@75 | 237 | return Node(Node_importNode_DOM(self._node, node, deep), self.ownerDocument) |
paulb@18 | 238 | |
paulb@18 | 239 | def insertBefore(self, tmp, oldNode): |
paulb@72 | 240 | if hasattr(tmp, "as_native_node"): |
paulb@75 | 241 | return Node(Node_insertBefore(self._node, tmp.as_native_node(), oldNode.as_native_node()), self.ownerDocument) |
paulb@18 | 242 | else: |
paulb@75 | 243 | return Node(Node_insertBefore(self._node, tmp, oldNode.as_native_node()), self.ownerDocument) |
paulb@18 | 244 | |
paulb@18 | 245 | def replaceChild(self, tmp, oldNode): |
paulb@72 | 246 | if hasattr(tmp, "as_native_node"): |
paulb@75 | 247 | return Node(Node_replaceChild(self._node, tmp.as_native_node(), oldNode.as_native_node()), self.ownerDocument) |
paulb@18 | 248 | else: |
paulb@75 | 249 | return Node(Node_replaceChild(self._node, tmp, oldNode.as_native_node()), self.ownerDocument) |
paulb@18 | 250 | |
paulb@18 | 251 | def appendChild(self, tmp): |
paulb@72 | 252 | if hasattr(tmp, "as_native_node"): |
paulb@75 | 253 | return Node(Node_appendChild(self._node, tmp.as_native_node()), self.ownerDocument) |
paulb@18 | 254 | else: |
paulb@75 | 255 | return Node(Node_appendChild(self._node, tmp), self.ownerDocument) |
paulb@18 | 256 | |
paulb@18 | 257 | def removeChild(self, tmp): |
paulb@72 | 258 | if hasattr(tmp, "as_native_node"): |
paulb@72 | 259 | Node_removeChild(self._node, tmp.as_native_node()) |
paulb@72 | 260 | else: |
paulb@72 | 261 | Node_removeChild(self._node, tmp) |
paulb@18 | 262 | |
paulb@18 | 263 | childNodes = property(_childNodes) |
paulb@86 | 264 | value = data = nodeValue = property(_nodeValue, _setNodeValue) |
paulb@18 | 265 | name = nodeName = property(_nodeName) |
paulb@18 | 266 | tagName = property(_tagName) |
paulb@18 | 267 | namespaceURI = property(_namespaceURI) |
paulb@18 | 268 | prefix = property(_prefix) |
paulb@18 | 269 | localName = property(_localName) |
paulb@88 | 270 | parentNode = property(_parentNode) |
paulb@18 | 271 | nodeType = property(_nodeType) |
paulb@18 | 272 | attributes = property(_attributes) |
paulb@24 | 273 | previousSibling = property(_previousSibling) |
paulb@18 | 274 | nextSibling = property(_nextSibling) |
paulb@18 | 275 | |
paulb@72 | 276 | #def isSameNode(self, other): |
paulb@72 | 277 | # return self._node.nodePath() == other._node.nodePath() |
paulb@18 | 278 | |
paulb@72 | 279 | #def __eq__(self, other): |
paulb@72 | 280 | # return self._node.nodePath() == other._node.nodePath() |
paulb@18 | 281 | |
paulb@86 | 282 | def getElementsByTagName(self, tagName): |
paulb@86 | 283 | return self.xpath("//" + tagName) |
paulb@86 | 284 | |
paulb@32 | 285 | # 4DOM extensions to the usual PyXML API. |
paulb@32 | 286 | # NOTE: To be finished. |
paulb@32 | 287 | |
paulb@32 | 288 | def xpath(self, expr, variables=None, namespaces=None): |
paulb@81 | 289 | result = Node_xpath(self._node, expr, variables, namespaces) |
paulb@83 | 290 | if hasattr(result, "__len__"): |
paulb@88 | 291 | return NodeList([get_node(_node, self) for _node in result]) |
paulb@81 | 292 | else: |
paulb@81 | 293 | return result |
paulb@81 | 294 | |
paulb@81 | 295 | # Convenience methods. |
paulb@81 | 296 | |
paulb@81 | 297 | def toString(self, encoding=None): |
paulb@81 | 298 | return toString(self, encoding) |
paulb@81 | 299 | |
paulb@81 | 300 | def toStream(self, stream, encoding=None): |
paulb@81 | 301 | toStream(self, stream, encoding) |
paulb@81 | 302 | |
paulb@81 | 303 | def toFile(self, f, encoding=None): |
paulb@81 | 304 | toFile(self, f, encoding) |
paulb@75 | 305 | |
paulb@88 | 306 | # Attribute nodes. |
paulb@88 | 307 | |
paulb@88 | 308 | class Attribute(Node): |
paulb@88 | 309 | |
paulb@88 | 310 | "A class providing attribute access." |
paulb@88 | 311 | |
paulb@88 | 312 | def __init__(self, node, ownerDocument=None, ownerElement=None): |
paulb@88 | 313 | Node.__init__(self, node, ownerDocument) |
paulb@88 | 314 | self.ownerElement = ownerElement |
paulb@88 | 315 | |
paulb@88 | 316 | def _parentNode(self): |
paulb@88 | 317 | return self.ownerElement |
paulb@88 | 318 | |
paulb@88 | 319 | parentNode = property(_parentNode) |
paulb@88 | 320 | |
paulb@75 | 321 | # Document housekeeping mechanisms. |
paulb@75 | 322 | |
paulb@75 | 323 | class Document(Node): |
paulb@75 | 324 | |
paulb@75 | 325 | "A class providing document-level housekeeping." |
paulb@75 | 326 | |
paulb@75 | 327 | def __init__(self, node): |
paulb@75 | 328 | self._node = node |
paulb@75 | 329 | self.weakref_ownerDocument = weakref.ref(self) |
paulb@75 | 330 | |
paulb@75 | 331 | def _ownerDocument(self): |
paulb@75 | 332 | return self.weakref_ownerDocument() |
paulb@75 | 333 | |
paulb@75 | 334 | def __del__(self): |
paulb@84 | 335 | #print "Freeing document", self._node |
paulb@75 | 336 | libxml2mod.xmlFreeDoc(self._node) |
paulb@75 | 337 | |
paulb@75 | 338 | ownerDocument = property(_ownerDocument) |
paulb@32 | 339 | |
paulb@88 | 340 | # Factory functions. |
paulb@88 | 341 | |
paulb@88 | 342 | def get_node(_node, context_node): |
paulb@88 | 343 | if Node_nodeType(_node) == context_node.DOCUMENT_NODE: |
paulb@88 | 344 | return context_node.ownerDocument |
paulb@88 | 345 | elif Node_nodeType(_node) == context_node.ATTRIBUTE_NODE: |
paulb@88 | 346 | return Attribute(_node, context_node.ownerDocument, context_node) |
paulb@88 | 347 | else: |
paulb@88 | 348 | return Node(_node, context_node.ownerDocument) |
paulb@88 | 349 | |
paulb@18 | 350 | # Utility functions. |
paulb@18 | 351 | |
paulb@18 | 352 | def createDocumentType(localName, publicId, systemId): |
paulb@18 | 353 | return None |
paulb@18 | 354 | |
paulb@18 | 355 | def createDocument(namespaceURI, localName, doctype): |
paulb@75 | 356 | return Document(Node_createDocument(namespaceURI, localName, doctype)) |
paulb@18 | 357 | |
paulb@18 | 358 | def parse(stream_or_string): |
paulb@18 | 359 | if hasattr(stream_or_string, "read"): |
paulb@18 | 360 | stream = stream_or_string |
paulb@32 | 361 | return parseString(stream.read()) |
paulb@18 | 362 | else: |
paulb@32 | 363 | return parseFile(stream_or_string) |
paulb@32 | 364 | |
paulb@32 | 365 | def parseFile(s): |
paulb@75 | 366 | return Document(Node_parseFile(s)) |
paulb@18 | 367 | |
paulb@18 | 368 | def parseString(s): |
paulb@75 | 369 | return Document(Node_parseString(s)) |
paulb@18 | 370 | |
paulb@18 | 371 | def parseURI(uri): |
paulb@75 | 372 | return Document(Node_parseURI(uri)) |
paulb@18 | 373 | |
paulb@26 | 374 | def toString(node, encoding=None): |
paulb@72 | 375 | return Node_toString(node.as_native_node(), encoding) |
paulb@18 | 376 | |
paulb@72 | 377 | def toStream(node, stream, encoding=None): |
paulb@72 | 378 | Node_toStream(node.as_native_node(), stream, encoding) |
paulb@72 | 379 | |
paulb@72 | 380 | def toFile(node, f, encoding=None): |
paulb@72 | 381 | Node_toFile(node.as_native_node(), f, encoding) |
paulb@18 | 382 | |
paulb@81 | 383 | def adoptNodes(nodes): |
paulb@81 | 384 | if len(nodes) == 0: |
paulb@81 | 385 | return [] |
paulb@81 | 386 | doc = Document(libxml2mod.doc(nodes[0])) |
paulb@81 | 387 | results = [] |
paulb@81 | 388 | for node in nodes: |
paulb@81 | 389 | results.append(Node(node, doc)) |
paulb@81 | 390 | return results |
paulb@81 | 391 | |
paulb@18 | 392 | # vim: tabstop=4 expandtab shiftwidth=4 |