deprecate (not delete) to_xml_start, to_xml_end

Author: Ben Cipollini

nibabel/gifti/gifti.py

@@ -330,6 +330,34 @@ def _to_xml_element(self):
 
         return data_array
 
+    @np.deprecate_with_doc("Use the to_xml() function instead.")
+    def to_xml_open(self):
+        out = """<DataArray Intent="%s"
+\tDataType="%s"
+\tArrayIndexingOrder="%s"
+\tDimensionality="%s"
+%s\tEncoding="%s"
+\tEndian="%s"
+\tExternalFileName="%s"
+\tExternalFileOffset="%s">\n"""
+        di = ""
+        for i, n in enumerate(self.dims):
+            di = di + '\tDim%s=\"%s\"\n' % (str(i), str(n))
+        return out % (intent_codes.niistring[self.intent],
+                      data_type_codes.niistring[self.datatype],
+                      array_index_order_codes.label[self.ind_ord],
+                      str(self.num_dim),
+                      str(di),
+                      gifti_encoding_codes.specs[self.encoding],
+                      gifti_endian_codes.specs[self.endian],
+                      self.ext_fname,
+                      self.ext_offset,
+                      )
+
+    @np.deprecate_with_doc("Use the to_xml() function instead.")
+    def to_xml_close(self):
+        return "</DataArray>\n"
+
     def print_summary(self):
         print('Intent: ', intent_codes.niistring[self.intent])
         print('DataType: ', data_type_codes.niistring[self.datatype])

nibabel/gifti/tests/test_gifti.py

@@ -4,6 +4,7 @@
 
 import numpy as np
 
+from nibabel.externals.six import string_types
 from nibabel.gifti import (GiftiImage, GiftiDataArray, GiftiLabel,
                            GiftiLabelTable, GiftiMetaData, giftiio)
 from nibabel.gifti.gifti import data_tag
@@ -70,6 +71,17 @@ def test_dataarray():
         da = GiftiDataArray.from_array(bs_arr, 'triangle')
         assert_equal(da.datatype, data_type_codes[arr.dtype])
 
+    # Smoke test on deprecated functions
+    da = GiftiDataArray.from_array(np.ones((1,)), 'triangle')
+    with clear_and_catch_warnings() as w:
+        warnings.filterwarnings('always', category=DeprecationWarning)
+        assert_true(isinstance(da.to_xml_open(), string_types))
+        assert_equal(len(w), 1)
+    with clear_and_catch_warnings() as w:
+        warnings.filterwarnings('once', category=DeprecationWarning)
+        assert_true(isinstance(da.to_xml_close(), string_types))
+        assert_equal(len(w), 1)
+
 
 def test_labeltable():
     img = GiftiImage()