Merge pull request #468 from matthew-brett/back-compat-gifti

MRG: restore GiftiDataArray num_dim setter

Add back-compatibility setter for attribute moved to property.

Author: matthew-brett

nibabel/gifti/gifti.py

@@ -369,6 +369,17 @@ def __init__(self,
     def num_dim(self):
         return len(self.dims)
 
+    # Setter for backwards compatibility with pymvpa
+    @num_dim.setter
+    def num_dim(self, value):
+        warnings.warn(
+            "num_dim will be read-only in future versions of nibabel",
+            DeprecationWarning, stacklevel=2)
+        if value != len(self.dims):
+            raise ValueError('num_dim value {0} != number of dimensions '
+                             'len(self.dims) {1}'
+                             .format(value, len(self.dims)))
+
     @classmethod
     def from_array(klass,
                    darray,

nibabel/gifti/tests/test_gifti.py

@@ -182,6 +182,19 @@ def test_to_xml_open_close_deprecations():
         assert_equal(len(w), 1)
 
 
+def test_num_dim_deprecation():
+    da = GiftiDataArray(np.ones((2, 3, 4)))
+    # num_dim is property, set automatically from len(da.dims)
+    assert_equal(da.num_dim, 3)
+    with clear_and_catch_warnings() as w:
+        warnings.filterwarnings('always', category=DeprecationWarning)
+        # OK setting num_dim to correct value, but raises DeprecationWarning
+        da.num_dim = 3
+        assert_equal(len(w), 1)
+        # Any other value gives a ValueError
+        assert_raises(ValueError, setattr, da, 'num_dim', 4)
+
+
 def test_labeltable():
     img = GiftiImage()
     assert_equal(len(img.labeltable.labels), 0)