paulb@1 | 1 | #!/usr/bin/env python |
paulb@1 | 2 | |
paulb@1 | 3 | """ |
paulb@1 | 4 | DOM wrapper around libxml2. |
paulb@1 | 5 | """ |
paulb@1 | 6 | |
paulb@1 | 7 | import xml.dom |
paulb@3 | 8 | import libxml2 |
paulb@1 | 9 | |
paulb@3 | 10 | # NOTE: Consider a generator instead. |
paulb@3 | 11 | |
paulb@3 | 12 | class NamedNodeMap(object): |
paulb@1 | 13 | |
paulb@1 | 14 | def __init__(self, node): |
paulb@3 | 15 | self.node = node |
paulb@3 | 16 | |
paulb@3 | 17 | def getNamedItem(self, name): |
paulb@5 | 18 | return self.node.getAttributeNode(name) |
paulb@3 | 19 | |
paulb@3 | 20 | def getNamedItemNS(self, ns, localName): |
paulb@5 | 21 | return self.node.getAttributeNodeNS(ns, localName) |
paulb@3 | 22 | |
paulb@3 | 23 | def setNamedItem(self, node): |
paulb@5 | 24 | self.node.setAttributeNode(node.name, node) |
paulb@3 | 25 | |
paulb@3 | 26 | def setNamedItemNS(self, node): |
paulb@5 | 27 | self.node.setAttributeNodeNS(node.namespaceURI, node.localName, node) |
paulb@3 | 28 | |
paulb@3 | 29 | def __getitem__(self, name): |
paulb@6 | 30 | return self.getNamedItem(name) |
paulb@3 | 31 | |
paulb@3 | 32 | def __setitem__(self, name, node): |
paulb@6 | 33 | if name == node.nodeName: |
paulb@6 | 34 | self.setNamedItem(node) |
paulb@6 | 35 | else: |
paulb@6 | 36 | raise KeyError, name |
paulb@3 | 37 | |
paulb@3 | 38 | def __delitem__(self, name): |
paulb@6 | 39 | # NOTE: To be implemented. |
paulb@3 | 40 | pass |
paulb@3 | 41 | |
paulb@3 | 42 | def values(self): |
paulb@3 | 43 | attributes = [] |
paulb@3 | 44 | _attribute = self.node._node.properties |
paulb@3 | 45 | while _attribute is not None: |
paulb@3 | 46 | attributes.append(Node(_attribute, ownerElement=self.node)) |
paulb@3 | 47 | _attribute = _attribute.next |
paulb@3 | 48 | return attributes |
paulb@3 | 49 | |
paulb@3 | 50 | def keys(self): |
paulb@3 | 51 | return [(attr.namespaceURI, attr.localName) for attr in self.values()] |
paulb@3 | 52 | |
paulb@3 | 53 | def items(self): |
paulb@3 | 54 | return [((attr.namespaceURI, attr.localName), attr) for attr in self.values()] |
paulb@3 | 55 | |
paulb@3 | 56 | def __repr__(self): |
paulb@3 | 57 | return str(self) |
paulb@3 | 58 | |
paulb@3 | 59 | def __str__(self): |
paulb@3 | 60 | return "{%s}" % ",\n".join(["%s : %s" % (repr(key), repr(value)) for key, value in self.items()]) |
paulb@3 | 61 | |
paulb@3 | 62 | def _get_prefix_and_localName(name): |
paulb@3 | 63 | t = name.split(":") |
paulb@3 | 64 | if len(t) == 1: |
paulb@3 | 65 | return None, name |
paulb@3 | 66 | elif len(t) == 2: |
paulb@3 | 67 | return t |
paulb@3 | 68 | else: |
paulb@3 | 69 | # NOTE: Should raise an exception. |
paulb@3 | 70 | return None, None |
paulb@3 | 71 | |
paulb@3 | 72 | class TemporaryNode(object): |
paulb@3 | 73 | def __init__(self, ns, name, nodeType): |
paulb@3 | 74 | self.ns = ns |
paulb@3 | 75 | self.name = name |
paulb@3 | 76 | self.nodeType = nodeType |
paulb@3 | 77 | self.prefix, self.localName = _get_prefix_and_localName(self.name) |
paulb@1 | 78 | |
paulb@4 | 79 | class TemporaryText(object): |
paulb@4 | 80 | def __init__(self, _text): |
paulb@4 | 81 | self.ns = self.name = self.prefix = self.localName = None |
paulb@4 | 82 | self.nodeType = xml.dom.Node.TEXT_NODE |
paulb@4 | 83 | self._text = _text |
paulb@4 | 84 | |
paulb@1 | 85 | class Node(object): |
paulb@1 | 86 | |
paulb@1 | 87 | _nodeTypes = { |
paulb@1 | 88 | "attribute" : xml.dom.Node.ATTRIBUTE_NODE, |
paulb@1 | 89 | "comment" : xml.dom.Node.COMMENT_NODE, |
paulb@1 | 90 | "document_xml" : xml.dom.Node.DOCUMENT_NODE, |
paulb@1 | 91 | "doctype" : xml.dom.Node.DOCUMENT_TYPE_NODE, |
paulb@1 | 92 | "element" : xml.dom.Node.ELEMENT_NODE, |
paulb@1 | 93 | "entity" : xml.dom.Node.ENTITY_NODE, |
paulb@1 | 94 | "entity_ref" : xml.dom.Node.ENTITY_REFERENCE_NODE, |
paulb@1 | 95 | "notation" : xml.dom.Node.NOTATION_NODE, |
paulb@1 | 96 | "pi" : xml.dom.Node.PROCESSING_INSTRUCTION_NODE, |
paulb@1 | 97 | "text" : xml.dom.Node.TEXT_NODE |
paulb@1 | 98 | } |
paulb@1 | 99 | |
paulb@3 | 100 | def __init__(self, node, ownerElement=None): |
paulb@1 | 101 | self._node = node |
paulb@3 | 102 | self.ownerElement = ownerElement |
paulb@1 | 103 | |
paulb@1 | 104 | def _ownerDocument(self): |
paulb@1 | 105 | return self._node.doc |
paulb@1 | 106 | |
paulb@1 | 107 | def _nodeType(self): |
paulb@1 | 108 | return self._nodeTypes[self._node.type] |
paulb@1 | 109 | |
paulb@1 | 110 | def _childNodes(self): |
paulb@3 | 111 | |
paulb@3 | 112 | # NOTE: Consider a generator instead. |
paulb@3 | 113 | |
paulb@1 | 114 | child_nodes = [] |
paulb@5 | 115 | _node = self._node.children |
paulb@5 | 116 | while _node is not None: |
paulb@5 | 117 | child_nodes.append(Node(_node)) |
paulb@5 | 118 | _node = _node.next |
paulb@1 | 119 | return child_nodes |
paulb@1 | 120 | |
paulb@1 | 121 | def _attributes(self): |
paulb@3 | 122 | return NamedNodeMap(self) |
paulb@3 | 123 | |
paulb@3 | 124 | def _getNs(self): |
paulb@3 | 125 | |
paulb@3 | 126 | "Internal namespace information retrieval." |
paulb@3 | 127 | |
paulb@3 | 128 | try: |
paulb@3 | 129 | return self._node.ns() |
paulb@3 | 130 | except libxml2.treeError: |
paulb@3 | 131 | return None |
paulb@3 | 132 | |
paulb@3 | 133 | def _namespaceURI(self): |
paulb@3 | 134 | ns = self._getNs() |
paulb@3 | 135 | if ns is not None: |
paulb@3 | 136 | return ns.content |
paulb@3 | 137 | else: |
paulb@3 | 138 | return None |
paulb@3 | 139 | |
paulb@3 | 140 | def _nodeValue(self): |
paulb@3 | 141 | return self._node.content |
paulb@3 | 142 | |
paulb@3 | 143 | def _prefix(self): |
paulb@3 | 144 | ns = self._getNs() |
paulb@3 | 145 | if ns is not None: |
paulb@3 | 146 | return ns.name |
paulb@3 | 147 | else: |
paulb@3 | 148 | return None |
paulb@3 | 149 | |
paulb@3 | 150 | def _nodeName(self): |
paulb@3 | 151 | prefix = self._prefix() |
paulb@3 | 152 | if prefix is not None: |
paulb@3 | 153 | return prefix + ":" + self._localName() |
paulb@3 | 154 | else: |
paulb@3 | 155 | return self._localName() |
paulb@1 | 156 | |
paulb@1 | 157 | def _tagName(self): |
paulb@1 | 158 | if self._node.type == "element": |
paulb@3 | 159 | return self._nodeName() |
paulb@1 | 160 | else: |
paulb@1 | 161 | return None |
paulb@1 | 162 | |
paulb@3 | 163 | def _localName(self): |
paulb@3 | 164 | return self._node.name |
paulb@3 | 165 | |
paulb@3 | 166 | def _parentNode(self): |
paulb@5 | 167 | if self.nodeType == xml.dom.Node.DOCUMENT_NODE: |
paulb@5 | 168 | return None |
paulb@5 | 169 | else: |
paulb@5 | 170 | return Node(self._node.parent) |
paulb@3 | 171 | |
paulb@3 | 172 | def getAttributeNS(self, ns, localName): |
paulb@3 | 173 | return self._node.nsProp(localName, ns) |
paulb@3 | 174 | |
paulb@3 | 175 | def getAttribute(self, name): |
paulb@3 | 176 | return self._node.prop(localName) |
paulb@3 | 177 | |
paulb@3 | 178 | def getAttributeNodeNS(self, ns, localName): |
paulb@3 | 179 | return self.attributes[(ns, localName)] |
paulb@3 | 180 | |
paulb@3 | 181 | def getAttributeNode(self, localName): |
paulb@3 | 182 | # NOTE: Needs verifying. |
paulb@3 | 183 | return self.attributes[(None, localName)] |
paulb@3 | 184 | |
paulb@3 | 185 | def setAttributeNS(self, ns, name, value): |
paulb@3 | 186 | prefix, localName = _get_prefix_and_localName(name) |
paulb@3 | 187 | if localName: |
paulb@3 | 188 | self._node.setNsProp(self._node.newNs(ns, prefix), localName, value) |
paulb@3 | 189 | |
paulb@3 | 190 | def setAttribute(self, name, value): |
paulb@3 | 191 | self._node.setProp(name, value) |
paulb@3 | 192 | |
paulb@3 | 193 | def setAttributeNodeNS(self, ns, name, node): |
paulb@3 | 194 | # NOTE: Not actually putting the node on the element. |
paulb@3 | 195 | self.setAttributeNS(ns, name, node.nodeValue) |
paulb@3 | 196 | |
paulb@3 | 197 | def setAttributeNode(self, name, node): |
paulb@3 | 198 | # NOTE: Not actually putting the node on the element. |
paulb@3 | 199 | self.setAttribute(name, node.nodeValue) |
paulb@3 | 200 | |
paulb@3 | 201 | def createElementNS(self, ns, name): |
paulb@3 | 202 | prefix, localName = _get_prefix_and_localName(name) |
paulb@3 | 203 | return TemporaryNode(ns, name, xml.dom.Node.ELEMENT_NODE) |
paulb@3 | 204 | |
paulb@3 | 205 | def createElement(self, name): |
paulb@3 | 206 | return TemporaryNode(None, name, xml.dom.Node.ELEMENT_NODE) |
paulb@3 | 207 | |
paulb@3 | 208 | def createAttributeNS(self, ns, name): |
paulb@3 | 209 | prefix, localName = _get_prefix_and_localName(name) |
paulb@3 | 210 | return TemporaryNode(ns, name, xml.dom.Node.ATTRIBUTE_NODE) |
paulb@3 | 211 | |
paulb@3 | 212 | def createAttribute(self, name): |
paulb@3 | 213 | return TemporaryNode(ns, name, xml.dom.Node.ATTRIBUTE_NODE) |
paulb@3 | 214 | |
paulb@4 | 215 | def createTextNode(self, value): |
paulb@4 | 216 | return TemporaryText(self._node.doc.newDocText(value)) |
paulb@4 | 217 | |
paulb@3 | 218 | def _add_node(self, tmp): |
paulb@3 | 219 | if tmp.ns is not None: |
paulb@3 | 220 | if tmp.nodeType == xml.dom.Node.ELEMENT_NODE: |
paulb@3 | 221 | _child = self._node.newChild(None, tmp.localName, None) |
paulb@3 | 222 | elif tmp.nodeType == xml.dom.Node.ATTRIBUTE_NODE: |
paulb@3 | 223 | _child = self._node.newNsProp(None, tmp.localName, None) |
paulb@3 | 224 | else: |
paulb@3 | 225 | _child = None |
paulb@3 | 226 | |
paulb@3 | 227 | if _child is not None: |
paulb@3 | 228 | _ns = _child.newNs(tmp.ns, tmp.prefix) |
paulb@3 | 229 | _child.setNs(_ns) |
paulb@1 | 230 | else: |
paulb@3 | 231 | if tmp.nodeType == xml.dom.Node.ELEMENT_NODE: |
paulb@3 | 232 | _child = self._node.newChild(None, tmp.name, None) |
paulb@3 | 233 | elif tmp.nodeType == xml.dom.Node.ATTRIBUTE_NODE: |
paulb@3 | 234 | _child = self._node.newProp(None, tmp.name, None) |
paulb@3 | 235 | else: |
paulb@3 | 236 | _child = None |
paulb@3 | 237 | |
paulb@3 | 238 | return _child |
paulb@1 | 239 | |
paulb@3 | 240 | def insertBefore(self, tmp, oldNode): |
paulb@4 | 241 | if tmp.nodeType == xml.dom.Node.TEXT_NODE: |
paulb@4 | 242 | _child = tmp._text |
paulb@4 | 243 | else: |
paulb@4 | 244 | _child = self._add_node(tmp) |
paulb@4 | 245 | _child.unlinkNode() |
paulb@3 | 246 | return Node(oldNode._node.addPrevSibling(_child)) |
paulb@3 | 247 | |
paulb@3 | 248 | def replaceChild(self, tmp, oldNode): |
paulb@4 | 249 | if tmp.nodeType == xml.dom.Node.TEXT_NODE: |
paulb@4 | 250 | _child = tmp._text |
paulb@4 | 251 | else: |
paulb@4 | 252 | _child = self._add_node(tmp) |
paulb@4 | 253 | _child.unlinkNode() |
paulb@3 | 254 | return Node(oldNode._node.replaceNode(_child)) |
paulb@3 | 255 | |
paulb@3 | 256 | def appendChild(self, tmp): |
paulb@4 | 257 | if tmp.nodeType == xml.dom.Node.TEXT_NODE: |
paulb@4 | 258 | _child = self._node.addChild(tmp._text) |
paulb@4 | 259 | else: |
paulb@4 | 260 | _child = self._add_node(tmp) |
paulb@4 | 261 | return Node(_child) |
paulb@3 | 262 | |
paulb@3 | 263 | #doctype = property(_doctype) |
paulb@4 | 264 | #ownerElement defined in __init__ |
paulb@1 | 265 | ownerDocument = property(_ownerDocument) |
paulb@1 | 266 | childNodes = property(_childNodes) |
paulb@3 | 267 | value = data = nodeValue = property(_nodeValue) |
paulb@3 | 268 | name = nodeName = property(_nodeName) |
paulb@1 | 269 | tagName = property(_tagName) |
paulb@1 | 270 | namespaceURI = property(_namespaceURI) |
paulb@3 | 271 | prefix = property(_prefix) |
paulb@3 | 272 | localName = property(_localName) |
paulb@3 | 273 | parentNode = property(_parentNode) |
paulb@3 | 274 | nodeType = property(_nodeType) |
paulb@3 | 275 | attributes = property(_attributes) |
paulb@3 | 276 | |
paulb@3 | 277 | def isSameNode(self, other): |
paulb@3 | 278 | return self._node.nodePath() == other._node.nodePath() |
paulb@3 | 279 | |
paulb@3 | 280 | def __eq__(self, other): |
paulb@3 | 281 | return self._node.nodePath() == other._node.nodePath() |
paulb@1 | 282 | |
paulb@1 | 283 | # vim: tabstop=4 expandtab shiftwidth=4 |