DEP: Transition minc module to deprecated, announce 3.0 removal

Author: effigies

nibabel/minc.py

@@ -2,9 +2,9 @@
 
 import warnings
 
-warnings.warn("We will remove this module from nibabel soon; "
+warnings.warn("We will remove this module from nibabel 3.0; "
               "Please use the 'minc1' module instead",
-              FutureWarning,
+              DeprecationWarning,
               stacklevel=2)
 
 from .minc1 import *  # noqa

nibabel/minc1.py

@@ -18,7 +18,7 @@
 from .fileslice import canonical_slicers
 
 from .keywordonly import kw_only_meth
-from .deprecated import FutureWarningMixin
+from .deprecated import deprecate_with_version
 
 _dt_dict = {
     ('b', 'unsigned'): np.uint8,
@@ -331,13 +331,13 @@ def from_file_map(klass, file_map, mmap=True, keep_file_open=None):
 
 
 # Backwards compatibility
-class MincFile(FutureWarningMixin, Minc1File):
-    """ Deprecated alternative name for Minc1File
-    """
-    warn_message = 'MincFile is deprecated; please use Minc1File instead'
+@deprecate_with_version('MincFile is deprecated; please use Minc1File instead',
+                        since='2.0.0', until='3.0.0', warn_class=FutureWarning)
+class MincFile(Minc1File):
+    pass
 
 
-class MincImage(FutureWarningMixin, Minc1Image):
-    """ Deprecated alternative name for Minc1Image
-    """
-    warn_message = 'MincImage is deprecated; please use Minc1Image instead'
+@deprecate_with_version('MincImage is deprecated; please use Minc1Image instead',
+                        since='2.0.0', until='3.0.0', warn_class=FutureWarning)
+class MincImage(Minc1Image):
+    pass

nibabel/testing/__init__.py

@@ -16,7 +16,7 @@
 from os.path import dirname, abspath, join as pjoin
 
 import numpy as np
-from numpy.testing import assert_array_equal
+from numpy.testing import assert_array_equal, assert_warns
 from numpy.testing import dec
 skipif = dec.skipif
 slow = dec.slow

nibabel/tests/test_minc.py

@@ -0,0 +1,8 @@
+from ..info import cmp_pkg_version
+from ..testing import assert_raises
+
+
+def test_minc_removed():
+    if cmp_pkg_version('3.0.0dev') < 1:
+        with assert_raises(ImportError):
+            import nibabel.minc

nibabel/tests/test_minc1.py

@@ -24,10 +24,9 @@
 from .. import minc1
 from ..minc1 import Minc1File, Minc1Image, MincHeader
 
-from nose.tools import (assert_true, assert_equal, assert_false, assert_raises)
-from numpy.testing import assert_array_equal
 from ..tmpdirs import InTemporaryDirectory
-from ..testing import data_path
+from ..testing import (assert_true, assert_equal, assert_false, assert_raises, assert_warns,
+                       assert_array_equal, data_path, clear_and_catch_warnings)
 
 from . import test_spatialimages as tsi
 from .test_fileslice import slicer_samples
@@ -106,7 +105,8 @@ def test_old_namespace():
     # Check warnings raised
     arr = np.arange(24).reshape((2, 3, 4))
     aff = np.diag([2, 3, 4, 1])
-    with warnings.catch_warnings(record=True) as warns:
+    with clear_and_catch_warnings() as warns:
+        warnings.simplefilter('always', DeprecationWarning)
         # Top level import.
         # This import does not trigger an import of the minc.py module, because
         # it's the proxy object.
@@ -122,7 +122,9 @@ def test_old_namespace():
         # depending on whether the minc.py module is already imported in this
         # test run.
         if not previous_import:
-            assert_equal(warns.pop(0).category, FutureWarning)
+            assert_equal(warns.pop(0).category, DeprecationWarning)
+
+    with clear_and_catch_warnings() as warns:
         from .. import Minc1Image, MincImage
         assert_equal(warns, [])
         # The import from old module is the same as that from new
@@ -132,17 +134,17 @@ def test_old_namespace():
         assert_equal(warns, [])
         # Create object using old name
         mimg = MincImage(arr, aff)
-        assert_array_equal(mimg.get_data(), arr)
         # Call to create object created warning
         assert_equal(warns.pop(0).category, FutureWarning)
+        assert_array_equal(mimg.get_data(), arr)
         # Another old name
         from ..minc1 import MincFile, Minc1File
         assert_false(MincFile is Minc1File)
         assert_equal(warns, [])
         mf = MincFile(netcdf_file(EG_FNAME))
-        assert_equal(mf.get_data_shape(), (10, 20, 20))
         # Call to create object created warning
         assert_equal(warns.pop(0).category, FutureWarning)
+        assert_equal(mf.get_data_shape(), (10, 20, 20))
 
 
 class _TestMincFile(object):