2 from types import StringTypes
4 from StringIO import StringIO
5 from sfa.util.faults import InvalidXML
10 def filter_value(key, value):
12 if isinstance(value, str):
14 value = value.replace('*', '')
15 xpath = 'contains(%s, "%s")' % (key, value)
17 xpath = '%s="%s"' % (key, value)
25 for (key, value) in filter.items():
30 if isinstance(value, str):
31 filter_list.append(XpathFilter.filter_value(key, value))
32 elif isinstance(value, list):
33 stmt = ' or '.join([XpathFilter.filter_value(key, str(val)) for val in value])
34 filter_list.append(stmt)
36 xpath = ' and '.join(filter_list)
37 xpath = '[' + xpath + ']'
41 def __init__(self, node, namespaces):
44 self.namespaces = namespaces
45 self.attrib = node.attrib
48 def xpath(self, xpath, namespaces=None):
50 namespaces = self.namespaces
51 elems = self.node.xpath(xpath, namespaces=namespaces)
52 return [XmlNode(elem, namespaces) for elem in elems]
54 def add_element(self, name, **kwds):
55 element = etree.SubElement(self.node, name, **kwds)
56 return XmlNode(element, self.namespaces)
58 def append(self, elem):
59 self.node.append(elem)
61 def remove_elements(name):
63 Removes all occurences of an element from the tree. Start at
64 specified root_node if specified, otherwise start at tree's root.
67 if not element_name.startswith('//'):
68 element_name = '//' + element_name
69 elements = self.node.xpath('%s ' % name, namespaces=self.namespaces)
70 for element in elements:
71 parent = element.getparent()
72 parent.remove(element)
75 self.node.remove(element)
77 def set(self, key, value):
78 self.node.set(key, value)
80 def set_text(self, text):
84 del self.node.attrib[key]
86 def iterchildren(self):
87 return self.node.iterchildren()
90 return etree.tostring(self.node, encoding='UTF-8', pretty_print=True)
97 def __init__(self, xml=None, namespaces=None):
99 self.namespaces = namespaces
100 self.default_namespace = None
102 if isinstance(xml, basestring):
104 if isinstance(xml, XmlNode):
106 self.namespaces = xml.namespaces
107 elif isinstance(xml, etree._ElementTree) or isinstance(xml, etree._Element):
108 self.parse_xml(etree.tostring(xml))
110 def parse_xml(self, xml):
112 parse rspec into etree
114 parser = etree.XMLParser(remove_blank_text=True)
116 tree = etree.parse(xml, parser)
118 # 'rspec' file doesnt exist. 'rspec' is proably an xml string
120 tree = etree.parse(StringIO(xml), parser)
122 raise InvalidXML(str(e))
123 root = tree.getroot()
124 self.namespaces = dict(root.nsmap)
126 if 'default' not in self.namespaces and None in self.namespaces:
127 # If the 'None' exist, then it's pointing to the default namespace. This makes
128 # it hard for us to write xpath queries for the default naemspace because lxml
129 # wont understand a None prefix. We will just associate the default namespeace
130 # with a key named 'default'.
131 self.namespaces['default'] = self.namespaces.pop(None)
134 self.namespaces['default'] = 'default'
136 self.root = XmlNode(root, self.namespaces)
138 for key in self.root.attrib.keys():
139 if key.endswith('schemaLocation'):
140 # schema location should be at the end of the list
141 schema_parts = self.root.attrib[key].split(' ')
142 self.schema = schema_parts[1]
143 namespace, schema = schema_parts[0], schema_parts[1]
146 def parse_dict(self, d, root_tag_name='xml', element = None):
148 if self.root is None:
149 self.parse_xml('<%s/>' % root_tag_name)
156 # handle repeating fields
157 for (key, value) in d.items():
158 if isinstance(value, list):
161 if isinstance(val, dict):
162 child_element = etree.SubElement(element, key)
163 self.parse_dict(val, key, child_element)
164 elif isinstance(val, basestring):
165 child_element = etree.SubElement(element, key).text = val
167 elif isinstance(value, int):
168 d[key] = unicode(d[key])
172 # element.attrib.update will explode if DateTimes are in the
175 # looks like iteritems won't stand side-effects
177 if not isinstance(d[k],StringTypes):
180 element.attrib.update(d)
182 def validate(self, schema):
184 Validate against rng schema
186 relaxng_doc = etree.parse(schema)
187 relaxng = etree.RelaxNG(relaxng_doc)
188 if not relaxng(self.root):
189 error = relaxng.error_log.last_error
190 message = "%s (line %s)" % (error.message, error.line)
191 raise InvalidXML(message)
194 def xpath(self, xpath, namespaces=None):
196 namespaces = self.namespaces
197 return self.root.xpath(xpath, namespaces=namespaces)
199 def set(self, key, value, node=None):
202 return node.set(key, value)
204 def remove_attribute(self, name, node=None):
207 node.remove_attribute(name)
210 def add_element(self, name, **kwds):
212 Wrapper around etree.SubElement(). Adds an element to
213 specified parent node. Adds element to root node is parent is
217 xmlnode = parent.add_element(name, *kwds)
220 def remove_elements(self, name, node = None):
222 Removes all occurences of an element from the tree. Start at
223 specified root_node if specified, otherwise start at tree's root.
228 node.remove_elements(name)
230 def attributes_list(self, elem):
231 # convert a list of attribute tags into list of tuples
232 # (tagnme, text_value)
236 opts.append((e.tag, str(e.text).strip()))
239 def get_element_attributes(self, elem=None, depth=0):
241 elem = self.root_node
242 if not hasattr(elem, 'attrib'):
243 # this is probably not an element node with attribute. could be just and an
244 # attribute, return it
246 attrs = dict(elem.attrib)
247 attrs['text'] = str(elem.text).strip()
248 attrs['parent'] = elem.getparent()
249 if isinstance(depth, int) and depth > 0:
250 for child_elem in list(elem):
251 key = str(child_elem.tag)
253 attrs[key] = [self.get_element_attributes(child_elem, depth-1)]
255 attrs[key].append(self.get_element_attributes(child_elem, depth-1))
257 attrs['child_nodes'] = list(elem)
260 def merge(self, in_xml):
267 return etree.tostring(self.root.node, encoding='UTF-8', pretty_print=True)
269 # XXX smbaker, for record.load_from_string
270 def todict(self, elem=None):
274 d.update(elem.attrib)
275 d['text'] = elem.text
276 for child in elem.iterchildren():
277 if child.tag not in d:
279 d[child.tag].append(self.todict(child))
281 if len(d)==1 and ("text" in d):
286 def save(self, filename):
287 f = open(filename, 'w')
288 f.write(self.toxml())
292 #if __name__ == '__main__':
293 # rspec = RSpec('/tmp/resources.rspec')