RF: be more careful about warnings, test them!

Author: Ben Cipollini

nipype/interfaces/base.py

@@ -421,7 +421,7 @@ def _requires_warn(self, obj, name, old, new):
                     if not msg:
                         msg = 'Input %s requires inputs: %s' \
                             % (name, ', '.join(trait_spec.requires))
-            if msg:
+            if msg:  # only one requires warning at a time.
                 warn(msg)
 
     def _deprecated_warn(self, obj, name, old, new):
@@ -445,10 +445,11 @@ def _deprecated_warn(self, obj, name, old, new):
             if LooseVersion(str(trait_spec.deprecated)) < nipype_version:
                 raise TraitError(msg)
             else:
+                if trait_spec.new_name:
+                    msg += 'Unsetting old value %s; setting new value %s.' % (
+                        name, trait_spec.new_name)
                 warn(msg)
                 if trait_spec.new_name:
-                    warn('Unsetting %s and setting %s.' % (name,
-                                                           trait_spec.new_name))
                     self.trait_set(trait_change_notify=False,
                                    **{'%s' % name: Undefined,
                                       '%s' % trait_spec.new_name: new})

nipype/interfaces/tests/test_base.py

@@ -7,6 +7,7 @@
 import os
 import tempfile
 import shutil
+import warnings
 
 from nipype.testing import (assert_equal, assert_not_equal, assert_raises,
                         assert_true, assert_false, with_setup, package_check,
@@ -16,7 +17,8 @@
 from nipype.interfaces.base import Undefined, config
 from traits.testing.nose_tools import skip
 import traits.api as traits
-#test Bunch
+
+
 def test_bunch():
     b = nib.Bunch()
     yield assert_equal, b.__dict__,{}
@@ -138,43 +140,67 @@ class MyInterface(nib.BaseInterface):
     yield assert_equal, myif.inputs.kung, 2.0
 
 def test_deprecation():
-    class DeprecationSpec1(nib.TraitedSpec):
-        foo = nib.traits.Int(deprecated='0.1')
-    spec_instance = DeprecationSpec1()
-    set_foo = lambda : setattr(spec_instance, 'foo', 1)
-    yield assert_raises, nib.TraitError, set_foo
-    class DeprecationSpec1numeric(nib.TraitedSpec):
-        foo = nib.traits.Int(deprecated='0.1')
-    spec_instance = DeprecationSpec1numeric()
-    set_foo = lambda : setattr(spec_instance, 'foo', 1)
-    yield assert_raises, nib.TraitError, set_foo
-    class DeprecationSpec2(nib.TraitedSpec):
-        foo = nib.traits.Int(deprecated='100', new_name='bar')
-    spec_instance = DeprecationSpec2()
-    set_foo = lambda : setattr(spec_instance, 'foo', 1)
-    yield assert_raises, nib.TraitError, set_foo
-    class DeprecationSpec3(nib.TraitedSpec):
-        foo = nib.traits.Int(deprecated='1000', new_name='bar')
-        bar = nib.traits.Int()
-    spec_instance = DeprecationSpec3()
-    not_raised = True
-    try:
-        spec_instance.foo = 1
-    except nib.TraitError:
-        not_raised = False
-    yield assert_true, not_raised
-    class DeprecationSpec3(nib.TraitedSpec):
-        foo = nib.traits.Int(deprecated='1000', new_name='bar')
-        bar = nib.traits.Int()
-    spec_instance = DeprecationSpec3()
-    not_raised = True
-    try:
-        spec_instance.foo = 1
-    except nib.TraitError:
-        not_raised = False
-    yield assert_true, not_raised
-    yield assert_equal, spec_instance.foo, Undefined
-    yield assert_equal, spec_instance.bar, 1
+    with warnings.catch_warnings(record=True) as w:
+        warnings.filterwarnings('always', '', UserWarning)
+
+        class DeprecationSpec1(nib.TraitedSpec):
+            foo = nib.traits.Int(deprecated='0.1')
+        spec_instance = DeprecationSpec1()
+        set_foo = lambda : setattr(spec_instance, 'foo', 1)
+        yield assert_raises, nib.TraitError, set_foo
+        yield assert_equal, len(w), 0, 'no warnings, just errors'
+
+    with warnings.catch_warnings(record=True) as w:
+        warnings.filterwarnings('always', '', UserWarning)
+
+        class DeprecationSpec1numeric(nib.TraitedSpec):
+            foo = nib.traits.Int(deprecated='0.1')
+        spec_instance = DeprecationSpec1numeric()
+        set_foo = lambda : setattr(spec_instance, 'foo', 1)
+        yield assert_raises, nib.TraitError, set_foo
+        yield assert_equal, len(w), 0, 'no warnings, just errors'
+
+    with warnings.catch_warnings(record=True) as w:
+        warnings.filterwarnings('always', '', UserWarning)
+
+        class DeprecationSpec2(nib.TraitedSpec):
+            foo = nib.traits.Int(deprecated='100', new_name='bar')
+        spec_instance = DeprecationSpec2()
+        set_foo = lambda : setattr(spec_instance, 'foo', 1)
+        yield assert_raises, nib.TraitError, set_foo
+        yield assert_equal, len(w), 0, 'no warnings, just errors'
+
+    with warnings.catch_warnings(record=True) as w:
+        warnings.filterwarnings('always', '', UserWarning)
+
+        class DeprecationSpec3(nib.TraitedSpec):
+            foo = nib.traits.Int(deprecated='1000', new_name='bar')
+            bar = nib.traits.Int()
+        spec_instance = DeprecationSpec3()
+        not_raised = True
+        try:
+            spec_instance.foo = 1
+        except nib.TraitError:
+            not_raised = False
+        yield assert_true, not_raised
+        yield assert_equal, len(w), 1, 'deprecated warning 1 %s' % [w1.message for w1 in w]
+
+    with warnings.catch_warnings(record=True) as w:
+        warnings.filterwarnings('always', '', UserWarning)
+
+        class DeprecationSpec3(nib.TraitedSpec):
+            foo = nib.traits.Int(deprecated='1000', new_name='bar')
+            bar = nib.traits.Int()
+        spec_instance = DeprecationSpec3()
+        not_raised = True
+        try:
+            spec_instance.foo = 1
+        except nib.TraitError:
+            not_raised = False
+        yield assert_true, not_raised
+        yield assert_equal, spec_instance.foo, Undefined
+        yield assert_equal, spec_instance.bar, 1
+        yield assert_equal, len(w), 1, 'deprecated warning 2 %s' % [w1.message for w1 in w]
 
 
 def test_namesource():