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