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