RF: add thin layer around xml.etree.ElementTree and share XmlSerializable

Author: Ben Cipollini

nibabel/gifti/gifti.py

@@ -9,10 +9,10 @@
 from __future__ import division, print_function, absolute_import
 
 import sys
-import xml.etree.ElementTree as xml
 
 import numpy as np
 
+from .. import xmlutils as xml
 from ..nifti1 import data_type_codes, xform_codes, intent_codes
 from .util import (array_index_order_codes, gifti_encoding_codes,
                    gifti_endian_codes, KIND2FMT)
@@ -23,19 +23,7 @@
 import base64
 
 
-class XmlSerializable(object):
-    """ Basic interface for serializing an object to xml"""
-    def _to_xml_element(self):
-        """ Output should be a xml.etree.ElementTree.Element"""
-        raise NotImplementedError()
-
-    def to_xml(self, enc='utf-8'):
-        """ Output should be an xml string with the given encoding.
-        (default: utf-8)"""
-        return xml.tostring(self._to_xml_element(), enc)
-
-
-class GiftiMetaData(XmlSerializable):
+class GiftiMetaData(xml.XmlSerializable):
     """ A list of GiftiNVPairs in stored in
     the list self.data """
     def __init__(self, nvpair=None):
@@ -87,7 +75,7 @@ def __init__(self, name='', value=''):
         self.value = value
 
 
-class GiftiLabelTable(XmlSerializable):
+class GiftiLabelTable(xml.XmlSerializable):
 
     def __init__(self):
         self.labels = []
@@ -113,7 +101,7 @@ def print_summary(self):
         print(self.get_labels_as_dict())
 
 
-class GiftiLabel(XmlSerializable):
+class GiftiLabel(xml.XmlSerializable):
     key = int
     label = str
     # rgba
@@ -166,7 +154,7 @@ def _arr2txt(arr, elem_fmt):
     return '\n'.join(fmt % tuple(row) for row in arr)
 
 
-class GiftiCoordSystem(XmlSerializable):
+class GiftiCoordSystem(xml.XmlSerializable):
     dataspace = int
     xformspace = int
     xform = np.ndarray  # 4x4 numpy array
@@ -199,7 +187,7 @@ def print_summary(self):
 
 def _data_tag_element(dataarray, encoding, datatype, ordering):
     """ Creates the data tag depending on the required encoding,
-    returns as bytes"""
+    returns as XML element"""
     import zlib
     ord = array_index_order_codes.npcode[ordering]
     enclabel = gifti_encoding_codes.label[encoding]
@@ -225,7 +213,7 @@ def data_tag(dataarray, encoding, datatype, ordering):
     return xml.tostring(data, 'utf-8')
 
 
-class GiftiDataArray(XmlSerializable):
+class GiftiDataArray(xml.XmlSerializable):
 
     # These are for documentation only; we don't use these class variables
     intent = int
@@ -362,7 +350,7 @@ def metadata(self):
         return self.meta.metadata
 
 
-class GiftiImage(XmlSerializable):
+class GiftiImage(xml.XmlSerializable):
 
     def __init__(self, meta=None, labeltable=None, darrays=None,
                  version="1.0"):
@@ -506,4 +494,4 @@ def to_xml(self, enc='utf-8'):
         """ Return XML corresponding to image content """
         return b"""<?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE GIFTI SYSTEM "http://www.nitrc.org/frs/download.php/115/gifti.dtd">
-""" + XmlSerializable.to_xml(self, enc)
+""" + xml.XmlSerializable.to_xml(self, enc)

nibabel/xmlutils.py

@@ -0,0 +1,25 @@
+# emacs: -*- mode: python-mode; py-indent-offset: 4; indent-tabs-mode: nil -*-
+# vi: set ft=python sts=4 ts=4 sw=4 et:
+### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
+#
+#   See COPYING file distributed along with the NiBabel package for the
+#   copyright and license terms.
+#
+### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
+"""
+Thin layer around xml.etree.ElementTree, to abstract nibabel xml support.
+"""
+from xml.etree.ElementTree import Element, SubElement, tostring
+
+
+class XmlSerializable(object):
+    """ Basic interface for serializing an object to xml"""
+
+    def _to_xml_element(self):
+        """ Output should be a xml.etree.ElementTree.Element"""
+        raise NotImplementedError()
+
+    def to_xml(self, enc='utf-8'):
+        """ Output should be an xml string with the given encoding.
+        (default: utf-8)"""
+        return tostring(self._to_xml_element(), enc)