[#198][#200] Require lxml

Note that lxml is now "required" - it's listed as a requirement in
setup.py and is needed for the tests to pass.
However, stdlib etree still exists as an unsupported feature.

Author: Bjwebb

.travis.yml

@@ -5,13 +5,9 @@ python:
   - "3.3"
   - "3.4"
   - "3.5"
-env:
-  - INSTALL_LXML=true
-  - INSTALL_LXML=false
 # Apparently six must be installed first, otherwise setup.py will be unhappy
 install:
   - pip install six
   - pip install --upgrade -r requirements_dev.txt
-  - if [ \"$INSTALL_LXML\" == \"true\" ]; then pip install lxml; fi
 script: py.test --cov .
 after_success: coveralls

examples/iati/expected.xml

@@ -1 +1 @@
-<iati-activities><!--XML generated by flatten-tool--><iati-activity><iati-identifier>AA-AAA-123456789-ABC123</iati-identifier><reporting-org ref="AA-AAA-123456789" type="40"><narrative>Organisation name</narrative></reporting-org><participating-org ref="AA-AAA-123456789" role="1"></participating-org><activity-status code="2"></activity-status><activity-date iso-date="2011-10-01" type="1"></activity-date><recipient-country code="AF" percentage="40"></recipient-country><recipient-country code="XK" percentage="60"></recipient-country><title><narrative>A title</narrative></title><description><narrative>A description</narrative></description><transaction><transaction-type code="2"></transaction-type><transaction-date iso-date="2012-01-01"></transaction-date><value value-date="2012-01-01">10</value></transaction><transaction><transaction-type code="3"></transaction-type><transaction-date iso-date="2012-03-03"></transaction-date><value value-date="2012-03-03">20</value></transaction></iati-activity><iati-activity><iati-identifier>AA-AAA-123456789-ABC124</iati-identifier><reporting-org ref="AA-AAA-123456789" type="40"><narrative>Organisation name</narrative></reporting-org><participating-org ref="AA-AAA-123456789" role="1"></participating-org><activity-status code="3"></activity-status><activity-date iso-date="2016-01-01" type="2"></activity-date><recipient-country code="AG" percentage="30"></recipient-country><recipient-country code="XK" percentage="70"></recipient-country><title><narrative>Another title</narrative></title><description><narrative>Another description</narrative></description><transaction><transaction-type code="2"></transaction-type><transaction-date iso-date="2013-04-04"></transaction-date><value value-date="2013-04-04">30</value></transaction><transaction><transaction-type code="3"></transaction-type><transaction-date iso-date="2013-05-05"></transaction-date><value value-date="2013-05-05">40</value></transaction></iati-activity></iati-activities>
+<iati-activities><!--XML generated by flatten-tool--><iati-activity><iati-identifier>AA-AAA-123456789-ABC123</iati-identifier><reporting-org ref="AA-AAA-123456789" type="40"><narrative>Organisation name</narrative></reporting-org><participating-org ref="AA-AAA-123456789" role="1"/><activity-status code="2"/><activity-date iso-date="2011-10-01" type="1"/><recipient-country code="AF" percentage="40"/><recipient-country code="XK" percentage="60"/><title><narrative>A title</narrative></title><description><narrative>A description</narrative></description><transaction><transaction-type code="2"/><transaction-date iso-date="2012-01-01"/><value value-date="2012-01-01">10</value></transaction><transaction><transaction-type code="3"/><transaction-date iso-date="2012-03-03"/><value value-date="2012-03-03">20</value></transaction></iati-activity><iati-activity><iati-identifier>AA-AAA-123456789-ABC124</iati-identifier><reporting-org ref="AA-AAA-123456789" type="40"><narrative>Organisation name</narrative></reporting-org><participating-org ref="AA-AAA-123456789" role="1"/><activity-status code="3"/><activity-date iso-date="2016-01-01" type="2"/><recipient-country code="AG" percentage="30"/><recipient-country code="XK" percentage="70"/><title><narrative>Another title</narrative></title><description><narrative>Another description</narrative></description><transaction><transaction-type code="2"/><transaction-date iso-date="2013-04-04"/><value value-date="2013-04-04">30</value></transaction><transaction><transaction-type code="3"/><transaction-date iso-date="2013-05-05"/><value value-date="2013-05-05">40</value></transaction></iati-activity></iati-activities>

flattentool/tests/fixtures/iati-org.xml

@@ -1 +1 @@
-<iati-organisations><!--XML generated by flatten-tool--><iati-organisation><organisation-identifier>AA-AAA-123456789</organisation-identifier><reporting-org ref="AA-AAA-123456789" secondary-reporter="0" type="40"></reporting-org></iati-organisation></iati-organisations>
+<iati-organisations><!--XML generated by flatten-tool--><iati-organisation><organisation-identifier>AA-AAA-123456789</organisation-identifier><reporting-org ref="AA-AAA-123456789" secondary-reporter="0" type="40"/></iati-organisation></iati-organisations>

flattentool/xml_output.py

@@ -1,13 +1,17 @@
 from collections import OrderedDict
+from warnings import warn
 try:
     import lxml.etree as ET
     # If we're using lxml we have to do some extra work to support namespaces,
     # so we have a variable to check whether we're using lxml:
     USING_LXML = True
+    # Note that lxml is now "required" - it's listed as a requirement in
+    # setup.py and is needed for the tests to pass.
+    # However, stdlib etree still exists as an unsupported feature.
 except ImportError:
     import xml.etree.ElementTree as ET
     USING_LXML = False
-from warnings import warn
+    warn('Using stdlib etree may work, but is not supported. Please install lxml.')
 from flattentool.exceptions import DataErrorWarning
 
 
@@ -74,4 +78,4 @@ def toxml(data, xml_root_tag):
     root = dict_to_xml(data, xml_root_tag, nsmap=nsmap)
     comment = ET.Comment('XML generated by flatten-tool')
     root.insert(0, comment)
-    return ET.tostring(root, method='html')
+    return ET.tostring(root)

setup.py

@@ -1,7 +1,7 @@
 from setuptools import setup
 import sys
 
-install_requires = ['jsonref', 'schema', 'openpyxl>=2.5', 'six', 'pytz', 'xmltodict']
+install_requires = ['jsonref', 'schema', 'openpyxl>=2.5', 'six', 'pytz', 'xmltodict', 'lxml']
 
 if sys.version < '3':
     install_requires.append('unicodecsv')