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 xml.dom |
paulb@18 | 10 | import libxml2 |
paulb@72 | 11 | from libxml2dom.macrolib import * |
paulb@72 | 12 | from libxml2dom.macrolib import \ |
paulb@72 | 13 | createDocument as Node_createDocument, \ |
paulb@72 | 14 | parseString as Node_parseString, parseURI as Node_parseURI, \ |
paulb@72 | 15 | parseFile as Node_parseFile, \ |
paulb@72 | 16 | toString as Node_toString, toStream as Node_toStream, \ |
paulb@72 | 17 | toFile as Node_toFile |
paulb@75 | 18 | import weakref |
paulb@18 | 19 | |
paulb@18 | 20 | # NOTE: Consider a generator instead. |
paulb@18 | 21 | |
paulb@18 | 22 | class NamedNodeMap(object): |
paulb@18 | 23 | |
paulb@75 | 24 | """ |
paulb@75 | 25 | A wrapper around Node objects providing DOM and dictionary convenience |
paulb@75 | 26 | methods. |
paulb@75 | 27 | """ |
paulb@75 | 28 | |
paulb@18 | 29 | def __init__(self, node): |
paulb@18 | 30 | self.node = node |
paulb@18 | 31 | |
paulb@18 | 32 | def getNamedItem(self, name): |
paulb@72 | 33 | return self.node.getAttributeNode(name) |
paulb@18 | 34 | |
paulb@18 | 35 | def getNamedItemNS(self, ns, localName): |
paulb@72 | 36 | return self.node.getAttributeNodeNS(ns, localName) |
paulb@18 | 37 | |
paulb@18 | 38 | def setNamedItem(self, node): |
paulb@18 | 39 | self.node.setAttributeNode(node.name, node) |
paulb@18 | 40 | |
paulb@18 | 41 | def setNamedItemNS(self, node): |
paulb@18 | 42 | self.node.setAttributeNodeNS(node.namespaceURI, node.localName, node) |
paulb@18 | 43 | |
paulb@18 | 44 | def __getitem__(self, name): |
paulb@18 | 45 | return self.getNamedItem(name) |
paulb@18 | 46 | |
paulb@18 | 47 | def __setitem__(self, name, node): |
paulb@18 | 48 | if name == node.nodeName: |
paulb@18 | 49 | self.setNamedItem(node) |
paulb@18 | 50 | else: |
paulb@18 | 51 | raise KeyError, name |
paulb@18 | 52 | |
paulb@18 | 53 | def __delitem__(self, name): |
paulb@18 | 54 | # NOTE: To be implemented. |
paulb@18 | 55 | pass |
paulb@18 | 56 | |
paulb@18 | 57 | def values(self): |
paulb@75 | 58 | return [Node(_node, self.ownerDocument) for _node in Node_attributes(self.node.as_native_node()).values()] |
paulb@18 | 59 | |
paulb@18 | 60 | def keys(self): |
paulb@18 | 61 | return [(attr.namespaceURI, attr.localName) for attr in self.values()] |
paulb@18 | 62 | |
paulb@18 | 63 | def items(self): |
paulb@18 | 64 | return [((attr.namespaceURI, attr.localName), attr) for attr in self.values()] |
paulb@18 | 65 | |
paulb@18 | 66 | def __repr__(self): |
paulb@18 | 67 | return str(self) |
paulb@18 | 68 | |
paulb@18 | 69 | def __str__(self): |
paulb@18 | 70 | return "{%s}" % ",\n".join(["%s : %s" % (repr(key), repr(value)) for key, value in self.items()]) |
paulb@18 | 71 | |
paulb@18 | 72 | class Node(object): |
paulb@18 | 73 | |
paulb@75 | 74 | """ |
paulb@75 | 75 | A DOM-style wrapper around libxml2mod objects. |
paulb@75 | 76 | """ |
paulb@75 | 77 | |
paulb@75 | 78 | def __init__(self, node, ownerDocument=None): |
paulb@18 | 79 | self._node = node |
paulb@75 | 80 | self.ownerDocument = ownerDocument |
paulb@18 | 81 | |
paulb@18 | 82 | def as_native_node(self): |
paulb@18 | 83 | return self._node |
paulb@18 | 84 | |
paulb@18 | 85 | def _nodeType(self): |
paulb@72 | 86 | return Node_nodeType(self._node) |
paulb@18 | 87 | |
paulb@18 | 88 | def _childNodes(self): |
paulb@18 | 89 | |
paulb@18 | 90 | # NOTE: Consider a generator instead. |
paulb@18 | 91 | |
paulb@75 | 92 | return [Node(_node, self.ownerDocument) for _node in Node_childNodes(self._node)] |
paulb@18 | 93 | |
paulb@18 | 94 | def _attributes(self): |
paulb@18 | 95 | return NamedNodeMap(self) |
paulb@18 | 96 | |
paulb@18 | 97 | def _namespaceURI(self): |
paulb@72 | 98 | return Node_namespaceURI(self._node) |
paulb@18 | 99 | |
paulb@18 | 100 | def _nodeValue(self): |
paulb@72 | 101 | return Node_nodeValue(self._node) |
paulb@18 | 102 | |
paulb@18 | 103 | def _prefix(self): |
paulb@72 | 104 | return Node_prefix(self._node) |
paulb@18 | 105 | |
paulb@18 | 106 | def _nodeName(self): |
paulb@72 | 107 | return Node_nodeName(self._node) |
paulb@18 | 108 | |
paulb@18 | 109 | def _tagName(self): |
paulb@72 | 110 | return Node_tagName(self._node) |
paulb@18 | 111 | |
paulb@18 | 112 | def _localName(self): |
paulb@72 | 113 | return Node_localName(self._node) |
paulb@18 | 114 | |
paulb@18 | 115 | def _parentNode(self): |
paulb@72 | 116 | return Node_parentNode(self._node) |
paulb@18 | 117 | |
paulb@24 | 118 | def _previousSibling(self): |
paulb@75 | 119 | return Node(Node_previousSibling(self._node), self.ownerDocument) |
paulb@24 | 120 | |
paulb@18 | 121 | def _nextSibling(self): |
paulb@75 | 122 | return Node(Node_nextSibling(self._node), self.ownerDocument) |
paulb@18 | 123 | |
paulb@18 | 124 | def hasAttributeNS(self, ns, localName): |
paulb@72 | 125 | return Node_hasAttributeNS(self._node, ns, localName) |
paulb@18 | 126 | |
paulb@18 | 127 | def hasAttribute(self, name): |
paulb@72 | 128 | return Node_hasAttribute(self._node, name) |
paulb@18 | 129 | |
paulb@18 | 130 | def getAttributeNS(self, ns, localName): |
paulb@72 | 131 | return Node_getAttributeNS(self._node, ns, localName) |
paulb@18 | 132 | |
paulb@18 | 133 | def getAttribute(self, name): |
paulb@72 | 134 | return Node_getAttribute(self._node, name) |
paulb@18 | 135 | |
paulb@18 | 136 | def getAttributeNodeNS(self, ns, localName): |
paulb@75 | 137 | return Node(Node_getAttributeNodeNS(self._node, ns, localName), self.ownerDocument) |
paulb@18 | 138 | |
paulb@18 | 139 | def getAttributeNode(self, localName): |
paulb@75 | 140 | return Node(Node_getAttributeNode(self._node, localName), self.ownerDocument) |
paulb@18 | 141 | |
paulb@18 | 142 | def setAttributeNS(self, ns, name, value): |
paulb@72 | 143 | Node_setAttributeNS(self._node, ns, name, value) |
paulb@18 | 144 | |
paulb@18 | 145 | def setAttribute(self, name, value): |
paulb@72 | 146 | Node_setAttribute(self._node, name, value) |
paulb@18 | 147 | |
paulb@18 | 148 | def setAttributeNodeNS(self, ns, name, node): |
paulb@72 | 149 | Node_setAttributeNodeNS(self._node, ns, name, node) |
paulb@18 | 150 | |
paulb@18 | 151 | def setAttributeNode(self, name, node): |
paulb@72 | 152 | Node_setAttributeNode(self._node, name, node) |
paulb@18 | 153 | |
paulb@18 | 154 | def createElementNS(self, ns, name): |
paulb@75 | 155 | return Node(Node_createElementNS(self._node, ns, name), self.ownerDocument) |
paulb@18 | 156 | |
paulb@18 | 157 | def createElement(self, name): |
paulb@75 | 158 | return Node(Node_createElement(self._node, name), self.ownerDocument) |
paulb@18 | 159 | |
paulb@18 | 160 | def createAttributeNS(self, ns, name): |
paulb@72 | 161 | # Returns a special temporary node. |
paulb@72 | 162 | return Node_createAttributeNS(self._node, ns, name) |
paulb@18 | 163 | |
paulb@18 | 164 | def createAttribute(self, name): |
paulb@72 | 165 | # Returns a special temporary node. |
paulb@72 | 166 | return Node_createAttribute(self._node, name) |
paulb@18 | 167 | |
paulb@18 | 168 | def createTextNode(self, value): |
paulb@75 | 169 | return Node(Node_createTextNode(self._node, value), self.ownerDocument) |
paulb@18 | 170 | |
paulb@34 | 171 | def createComment(self, value): |
paulb@75 | 172 | return Node(Node_createComment(self._node, value), self.ownerDocument) |
paulb@18 | 173 | |
paulb@18 | 174 | def importNode(self, node, deep): |
paulb@72 | 175 | if hasattr(node, "as_native_node"): |
paulb@75 | 176 | return Node(Node_importNode(self._node, node.as_native_node(), deep), self.ownerDocument) |
paulb@72 | 177 | else: |
paulb@75 | 178 | return Node(Node_importNode_DOM(self._node, node, deep), self.ownerDocument) |
paulb@18 | 179 | |
paulb@18 | 180 | def insertBefore(self, tmp, oldNode): |
paulb@72 | 181 | if hasattr(tmp, "as_native_node"): |
paulb@75 | 182 | return Node(Node_insertBefore(self._node, tmp.as_native_node(), oldNode.as_native_node()), self.ownerDocument) |
paulb@18 | 183 | else: |
paulb@75 | 184 | return Node(Node_insertBefore(self._node, tmp, oldNode.as_native_node()), self.ownerDocument) |
paulb@18 | 185 | |
paulb@18 | 186 | def replaceChild(self, tmp, oldNode): |
paulb@72 | 187 | if hasattr(tmp, "as_native_node"): |
paulb@75 | 188 | return Node(Node_replaceChild(self._node, tmp.as_native_node(), oldNode.as_native_node()), self.ownerDocument) |
paulb@18 | 189 | else: |
paulb@75 | 190 | return Node(Node_replaceChild(self._node, tmp, oldNode.as_native_node()), self.ownerDocument) |
paulb@18 | 191 | |
paulb@18 | 192 | def appendChild(self, tmp): |
paulb@72 | 193 | if hasattr(tmp, "as_native_node"): |
paulb@75 | 194 | return Node(Node_appendChild(self._node, tmp.as_native_node()), self.ownerDocument) |
paulb@18 | 195 | else: |
paulb@75 | 196 | return Node(Node_appendChild(self._node, tmp), self.ownerDocument) |
paulb@18 | 197 | |
paulb@18 | 198 | def removeChild(self, tmp): |
paulb@72 | 199 | if hasattr(tmp, "as_native_node"): |
paulb@72 | 200 | Node_removeChild(self._node, tmp.as_native_node()) |
paulb@72 | 201 | else: |
paulb@72 | 202 | Node_removeChild(self._node, tmp) |
paulb@18 | 203 | |
paulb@18 | 204 | childNodes = property(_childNodes) |
paulb@18 | 205 | value = data = nodeValue = property(_nodeValue) |
paulb@18 | 206 | name = nodeName = property(_nodeName) |
paulb@18 | 207 | tagName = property(_tagName) |
paulb@18 | 208 | namespaceURI = property(_namespaceURI) |
paulb@18 | 209 | prefix = property(_prefix) |
paulb@18 | 210 | localName = property(_localName) |
paulb@75 | 211 | ownerElement = parentNode = property(_parentNode) |
paulb@18 | 212 | nodeType = property(_nodeType) |
paulb@18 | 213 | attributes = property(_attributes) |
paulb@24 | 214 | previousSibling = property(_previousSibling) |
paulb@18 | 215 | nextSibling = property(_nextSibling) |
paulb@18 | 216 | |
paulb@72 | 217 | #def isSameNode(self, other): |
paulb@72 | 218 | # return self._node.nodePath() == other._node.nodePath() |
paulb@18 | 219 | |
paulb@72 | 220 | #def __eq__(self, other): |
paulb@72 | 221 | # return self._node.nodePath() == other._node.nodePath() |
paulb@18 | 222 | |
paulb@32 | 223 | # 4DOM extensions to the usual PyXML API. |
paulb@32 | 224 | # NOTE: To be finished. |
paulb@32 | 225 | |
paulb@32 | 226 | def xpath(self, expr, variables=None, namespaces=None): |
paulb@75 | 227 | return [Node(_node, self.ownerDocument) for _node in Node_xpath(self._node, expr, variables, namespaces)] |
paulb@75 | 228 | |
paulb@75 | 229 | # Document housekeeping mechanisms. |
paulb@75 | 230 | |
paulb@75 | 231 | class Document(Node): |
paulb@75 | 232 | |
paulb@75 | 233 | "A class providing document-level housekeeping." |
paulb@75 | 234 | |
paulb@75 | 235 | def __init__(self, node): |
paulb@75 | 236 | self._node = node |
paulb@75 | 237 | self.weakref_ownerDocument = weakref.ref(self) |
paulb@75 | 238 | |
paulb@75 | 239 | def _ownerDocument(self): |
paulb@75 | 240 | return self.weakref_ownerDocument() |
paulb@75 | 241 | |
paulb@75 | 242 | def __del__(self): |
paulb@75 | 243 | print "Freeing document", self._node |
paulb@75 | 244 | libxml2mod.xmlFreeDoc(self._node) |
paulb@75 | 245 | |
paulb@75 | 246 | ownerDocument = property(_ownerDocument) |
paulb@32 | 247 | |
paulb@18 | 248 | # Utility functions. |
paulb@18 | 249 | |
paulb@18 | 250 | def createDocumentType(localName, publicId, systemId): |
paulb@18 | 251 | return None |
paulb@18 | 252 | |
paulb@18 | 253 | def createDocument(namespaceURI, localName, doctype): |
paulb@75 | 254 | return Document(Node_createDocument(namespaceURI, localName, doctype)) |
paulb@18 | 255 | |
paulb@18 | 256 | def parse(stream_or_string): |
paulb@18 | 257 | if hasattr(stream_or_string, "read"): |
paulb@18 | 258 | stream = stream_or_string |
paulb@32 | 259 | return parseString(stream.read()) |
paulb@18 | 260 | else: |
paulb@32 | 261 | return parseFile(stream_or_string) |
paulb@32 | 262 | |
paulb@32 | 263 | def parseFile(s): |
paulb@75 | 264 | return Document(Node_parseFile(s)) |
paulb@18 | 265 | |
paulb@18 | 266 | def parseString(s): |
paulb@75 | 267 | return Document(Node_parseString(s)) |
paulb@18 | 268 | |
paulb@18 | 269 | def parseURI(uri): |
paulb@75 | 270 | return Document(Node_parseURI(uri)) |
paulb@18 | 271 | |
paulb@26 | 272 | def toString(node, encoding=None): |
paulb@72 | 273 | return Node_toString(node.as_native_node(), encoding) |
paulb@18 | 274 | |
paulb@72 | 275 | def toStream(node, stream, encoding=None): |
paulb@72 | 276 | Node_toStream(node.as_native_node(), stream, encoding) |
paulb@72 | 277 | |
paulb@72 | 278 | def toFile(node, f, encoding=None): |
paulb@72 | 279 | Node_toFile(node.as_native_node(), f, encoding) |
paulb@18 | 280 | |
paulb@18 | 281 | # vim: tabstop=4 expandtab shiftwidth=4 |