Merge pull request #32 from totaler/allow_xml_str

IMP Allow xml as str in lists for building

Author: ecarreras

README.md

@@ -22,6 +22,14 @@ This library permits XML generation from Python objects
     <PRICE>9.90</PRICE>
     <YEAR>1988</YEAR>
   </CD>
+  <CD>
+    <TITLE>Tupelo Honey</TITLE>
+    <ARTIST>Van Morrison</ARTIST>
+    <COUNTRY>UK</COUNTRY>
+    <COMPANY>Polydor</COMPANY>
+    <PRICE>8.20</PRICE>
+    <YEAR>1971</YEAR>
+  </CD>
 </CATALOG>
 ```
 
@@ -69,6 +77,16 @@ cd.feed({
     'year': 1988
 })
 catalog.cds.append(cd)
+# Also we can add XML String directly as a new element
+cd = """<CD>
+        <TITLE>Tupelo Honey</TITLE>
+        <ARTIST>Van Morrison</ARTIST>
+        <COUNTRY>UK</COUNTRY>
+        <COMPANY>Polydor</COMPANY>
+        <PRICE>8.20</PRICE>
+        <YEAR>1971</YEAR>
+        </CD>"""
+self.catalog.cds.append(cd)
 catalog.build_tree()
 print catalog
 ```

libcomxml/core/__init__.py

@@ -17,6 +17,7 @@
         import xml.etree.cElementTree as etree
     except ImportError:
         import xml.etree.ElementTree as etree
+import re
 
 
 def get_xml_default_encoding():
@@ -25,6 +26,10 @@ def get_xml_default_encoding():
     return xml_enc
 
 
+def clean_xml(xml_string):
+    return re.sub('\s+<', '<', xml_string)
+
+
 class Field(object):
     """Base Field class
     """
@@ -235,7 +240,8 @@ def build_tree(self):
                         continue
                     self.doc_root.append(field.doc_root)
                 elif isinstance(field, list):
-                    # we just allow XmlFields and XmlModels in the list
+                    # we just allow XmlFields and XmlModels
+                    # Also xml as str for memory management
                     for item in field:
                         if isinstance(item, XmlField):
                             ele = item.element()
@@ -247,6 +253,9 @@ def build_tree(self):
                             if self.drop_empty and len(item.doc_root) == 0:
                                 continue
                             self.doc_root.append(item.doc_root)
+                        elif isinstance(item, str):
+                            ele = etree.fromstring(clean_xml(item))
+                            self.doc_root.append(ele)
                         item = None
                 elif (field.parent or self.root.name) == self.root.name:
                     ele = field.element()

tests/test_libcomxml.py

@@ -2,7 +2,7 @@
 from . import unittest
 import locale
 import re
-from libcomxml.core import XmlField, XmlModel
+from libcomxml.core import XmlField, XmlModel, clean_xml
 
 
 class Cd(XmlModel):
@@ -24,6 +24,31 @@ def __init__(self):
         super(Catalog, self).__init__('CATALOG', 'catalog')
 
 
+class TestCleaned(unittest.TestCase):
+    def setUp(self):
+        self.xml = "<?xml version='1.0' encoding='UTF-8'?>\n"
+        self.xml += """
+<CATALOG>
+    <CD>
+        <ARTIST>Bob Dylan</ARTIST>
+        <ARTIST>Bob Dylan</ARTIST>
+        <COMPANY>Columbia</COMPANY>
+        <TITLE>Empire Burlesque</TITLE>
+        <YEAR>1985</YEAR>
+        <PRICE>10.9</PRICE>
+    </CD>
+</CATALOG>"""
+        self.cleaned_xml = "<?xml version='1.0' encoding='UTF-8'?>"
+        self.cleaned_xml += "<CATALOG><CD><ARTIST>Bob Dylan</ARTIST>"
+        self.cleaned_xml += "<ARTIST>Bob Dylan</ARTIST>"
+        self.cleaned_xml += "<COMPANY>Columbia</COMPANY>"
+        self.cleaned_xml += "<TITLE>Empire Burlesque</TITLE><YEAR>1985</YEAR>"
+        self.cleaned_xml += "<PRICE>10.9</PRICE></CD></CATALOG>"
+
+    def test_clean(self):
+        self.assertEqual(clean_xml(self.xml), self.cleaned_xml)
+
+
 class TestFields(unittest.TestCase):
     def setUp(self):
         self.field = XmlField('Quantity', '10000', attributes={'uom': 'unit'})
@@ -76,6 +101,14 @@ def setUp(self):
         <YEAR>1988</YEAR>
         <PRICE>9.9</PRICE>
     </CD>
+    <CD>
+        <TITLE>Tupelo Honey</TITLE>
+        <ARTIST>Van Morrison</ARTIST>
+        <COUNTRY>UK</COUNTRY>
+        <COMPANY>Polydor</COMPANY>
+        <PRICE>8.20</PRICE>
+        <YEAR>1971</YEAR>
+    </CD>
 </CATALOG>""")
         self.catalog = Catalog()
         cd = Cd()
@@ -99,7 +132,16 @@ def setUp(self):
             'year': 1988
         })
         self.catalog.cds.append(cd)
+        cd = """<CD>
+        <TITLE>Tupelo Honey</TITLE>
+        <ARTIST>Van Morrison</ARTIST>
+        <COUNTRY>UK</COUNTRY>
+        <COMPANY>Polydor</COMPANY>
+        <PRICE>8.20</PRICE>
+        <YEAR>1971</YEAR>
+        </CD>"""
+        self.catalog.cds.append(cd)
         self.catalog.build_tree()
 
     def test_xml(self):
-         self.assertEqual(str(self.catalog), self.xml)
+        self.assertEqual(str(self.catalog), self.xml)