deprecate gifti.data_tag

Author: Ben Cipollini

nibabel/gifti/gifti.py

@@ -185,6 +185,17 @@ def print_summary(self):
         print('Affine Transformation Matrix: \n', self.xform)
 
 
+@np.deprecate_with_doc("This is an internal API that will be discontinued.")
+def data_tag(dataarray, encoding, datatype, ordering):
+    class DataTag(xml.XmlSerializable):
+        def __init__(self, *args):
+            self.args = args
+        def _to_xml_element(self):
+            return _data_tag_element(*self.args)
+
+    return DataTag(dataarray, encoding, datatype, ordering).to_xml()
+
+
 def _data_tag_element(dataarray, encoding, datatype, ordering):
     """ Creates the data tag depending on the required encoding,
     returns as XML element"""

nibabel/gifti/tests/test_gifti.py

@@ -4,17 +4,17 @@
 
 import numpy as np
 
-from nibabel.gifti import giftiio
+from nibabel.gifti import (GiftiImage, GiftiDataArray, GiftiLabel,
+                           GiftiLabelTable, GiftiMetaData, giftiio)
+from nibabel.gifti.gifti import data_tag
+from nibabel.nifti1 import data_type_codes, intent_codes
 
-from .test_giftiio import (DATA_FILE1, DATA_FILE2, DATA_FILE3, DATA_FILE4,
-                           DATA_FILE5, DATA_FILE6)
-from ..gifti import (GiftiImage, GiftiDataArray, GiftiLabel, GiftiLabelTable,
-                     GiftiMetaData)
-from ...nifti1 import data_type_codes, intent_codes
-from ...testing import clear_and_catch_warnings
 from numpy.testing import (assert_array_almost_equal,
                            assert_array_equal)
 from nose.tools import (assert_true, assert_false, assert_equal, assert_raises)
+from nibabel.testing import clear_and_catch_warnings
+from .test_giftiio import (DATA_FILE1, DATA_FILE2, DATA_FILE3, DATA_FILE4,
+                           DATA_FILE5, DATA_FILE6)
 
 
 def test_gifti_image():
@@ -163,3 +163,11 @@ def assign_labeltable(val):
     def assign_metadata(val):
         img.meta = val
     assert_raises(TypeError, assign_metadata, 'not-a-meta')
+
+
+def test_data_tag_deprecated():
+    img = GiftiImage()
+    with clear_and_catch_warnings() as w:
+        warnings.filterwarnings('once', category=DeprecationWarning)
+        data_tag(np.array([]), 'ASCII', '%i', 1)
+        assert_equal(len(w), 1)