get_metadata => metadata

Author: Ben Cipollini

nibabel/gifti/gifti.py

@@ -38,7 +38,12 @@ def from_dict(klass, data_dict):
             meda.data.append(nv)
         return meda
 
+    @np.deprecate_with_doc("Use the metadata property instead.")
     def get_metadata(self):
+        return self.metadata
+
+    @property
+    def metadata(self):
         """ Returns metadata as dictionary """
         self.data_as_dict = {}
         for ele in self.data:
@@ -59,7 +64,7 @@ def to_xml(self):
         return res
 
     def print_summary(self):
-        print(self.get_metadata())
+        print(self.metadata)
 
 
 class GiftiNVPairs(object):
@@ -338,9 +343,14 @@ def print_summary(self):
             print('Coordinate System:')
             print(self.coordsys.print_summary())
 
+    @np.deprecate_with_doc("Use the metadata property instead.")
     def get_metadata(self):
+        return self.meta.metadata
+
+    @property
+    def metadata(self):
         """ Returns metadata as dictionary """
-        return self.meta.get_metadata()
+        return self.meta.metadata
 
 
 class GiftiImage(object):

nibabel/gifti/tests/test_gifti.py

@@ -1,16 +1,18 @@
 """ Testing gifti objects
 """
+import warnings
 
 import numpy as np
 
+from .. import giftiio as gi
+from ..gifti import (GiftiImage, GiftiDataArray, GiftiLabel, GiftiLabelTable,
+                     GiftiMetaData)
 from ...nifti1 import data_type_codes, intent_codes
 
-from ..gifti import GiftiImage, GiftiDataArray, GiftiLabelTable
-
 from numpy.testing import (assert_array_almost_equal,
                            assert_array_equal)
-
 from nose.tools import assert_true, assert_equal, assert_raises
+from ...testing import clear_and_catch_warnings
 
 
 def test_gifti_image():
@@ -47,3 +49,18 @@ def test_labeltable():
     img.labeltable = new_table
     assert_equal(len(img.labeltable.labels), 2)
 
+    # Try to set to non-table
+    with assert_raises(ValueError):
+        img.labeltable = 'not-a-table'
+
+
+def test_metadata():
+    # Test deprecation
+    with clear_and_catch_warnings() as w:
+        warnings.filterwarnings('once', category=DeprecationWarning)
+        assert_equal(len(GiftiDataArray().get_metadata()), 0)
+
+    # Test deprecation
+    with clear_and_catch_warnings() as w:
+        warnings.filterwarnings('once', category=DeprecationWarning)
+        assert_equal(len(GiftiMetaData().get_metadata()), 0)

nibabel/gifti/tests/test_giftiio.py

@@ -142,7 +142,7 @@ def test_load_dataarray1():
     for img in (img1, bimg):
         assert_array_almost_equal(img.darrays[0].data, DATA_FILE1_darr1)
         assert_array_almost_equal(img.darrays[1].data, DATA_FILE1_darr2)
-        me=img.darrays[0].meta.get_metadata()
+        me=img.darrays[0].meta.metadata
         assert_true('AnatomicalStructurePrimary' in me)
         assert_true('AnatomicalStructureSecondary' in me)
         assert_equal(me['AnatomicalStructurePrimary'], 'CortexLeft')
@@ -237,11 +237,11 @@ def test_write_newmetadata():
     attr = gi.GiftiNVPairs(name = 'mykey', value = 'val1')
     newmeta = gi.GiftiMetaData(attr)
     img.meta = newmeta
-    myme = img.meta.get_metadata()
+    myme = img.meta.metadata
     assert_true('mykey' in myme)
     newmeta = gi.GiftiMetaData.from_dict( {'mykey1' : 'val2'} )
     img.meta = newmeta
-    myme = img.meta.get_metadata()
+    myme = img.meta.metadata
     assert_true('mykey1' in myme)
     assert_false('mykey' in myme)