from sfa.util.faults import InvalidXML
from sfa.rspecs.elements.element import Element
+# helper functions to help build xpaths
class XpathFilter:
@staticmethod
xpath = '[' + xpath + ']'
return xpath
+# a wrapper class around lxml.etree._Element
+# the reason why we need this one is because of the limitations
+# we've found in xpath to address documents with multiple namespaces defined
+# in a nutshell, we deal with xml documents that have
+# a default namespace defined (xmlns="http://default.com/") and specific prefixes defined
+# (xmlns:foo="http://foo.com")
+# according to the documentation instead of writing
+# element.xpath ( "//node/foo:subnode" )
+# we'd then need to write xpaths like
+# element.xpath ( "//{http://default.com/}node/{http://foo.com}subnode" )
+# which is a real pain..
+# So just so we can keep some reasonable programming style we need to manage the
+# namespace map that goes with the _Element (its internal .nsmap being unmutable)
+
class XmlElement:
def __init__(self, element, namespaces):
self.element = element
- self.tag = element.tag
- self.text = element.text
- self.attrib = element.attrib
self.namespaces = namespaces
-
+ # redefine as few methods as possible
def xpath(self, xpath, namespaces=None):
if not namespaces:
namespaces = self.namespaces
def get_instance(self, instance_class=None, fields=[]):
"""
Returns an instance (dict) of this xml element. The instance
- holds a reference this xml element.
+ holds a reference to this xml element.
"""
if not instance_class:
instance_class = Element
else:
self.element.remove(element)
- def get(self, key, *args):
- return self.element.get(key, *args)
-
- def items(self): return self.element.items()
-
- def set(self, key, value):
- self.element.set(key, value)
-
def set_text(self, text):
self.element.text = text
+ # Element does not have unset ?!?
def unset(self, key):
del self.element.attrib[key]
- def iterchildren(self):
- return self.element.iterchildren()
-
def toxml(self):
return etree.tostring(self.element, encoding='UTF-8', pretty_print=True)
def __str__(self):
return self.toxml()
+ ### other method calls or attribute access like .text or .tag or .get
+ # are redirected on self.element
+ def __getattr__ (self, name):
+ if not hasattr(self.element, name):
+ raise AttributeError, name
+ return getattr(self.element, name)
+
class XML:
def __init__(self, xml=None, namespaces=None):
self.namespaces['default'] = 'default'
self.root = XmlElement(root, self.namespaces)
- # set schema
+ # set schema
for key in self.root.attrib.keys():
if key.endswith('schemaLocation'):
# schema location should be at the end of the list
if element is None:
if self.root is None:
self.parse_xml('<%s/>' % root_tag_name)
- element = self.root
+ element = self.root.element
if 'text' in d:
text = d.pop('text')
self.parse_dict(val, key, child_element)
elif isinstance(val, basestring):
child_element = etree.SubElement(element, key).text = val
-
+
elif isinstance(value, int):
- d[key] = unicode(d[key])
+ d[key] = unicode(d[key])
elif value is None:
d.pop(key)
namespaces = self.namespaces
return self.root.xpath(xpath, namespaces=namespaces)
- def set(self, key, value, element=None):
- if not element:
- element = self.root
- return element.set(key, value)
+ def set(self, key, value):
+ return self.root.set(key, value)
def remove_attribute(self, name, element=None):
if not element: