RF: Change raise_exception to permissive; suppress warnings and exceptions with same mechanism

Author: effigies

nipype/interfaces/base/core.py

@@ -183,7 +183,9 @@ def __init__(
         # Create input spec, disable any defaults that are unavailable due to
         # version, and then apply the inputs that were passed.
         self.inputs = self.input_spec()
-        unavailable_traits = self._check_version_requirements(self.inputs, raise_exception=False)
+        unavailable_traits = self._check_version_requirements(
+            self.inputs, permissive=True
+        )
         if unavailable_traits:
             self.inputs.trait_set(**{k: Undefined for k in unavailable_traits})
         self.inputs.trait_set(**inputs)
@@ -271,8 +273,12 @@ def _check_mandatory_inputs(self):
         ):
             self._check_requires(spec, name, getattr(self.inputs, name))
 
-    def _check_version_requirements(self, trait_object, raise_exception=True):
+    def _check_version_requirements(self, trait_object, permissive=False):
         """ Raises an exception on version mismatch
+
+        Set the ``permissive`` attribute to True to suppress warnings and exceptions.
+        This is currently only used in __init__ to silently identify unavailable
+        traits.
         """
         unavailable_traits = []
         # check minimum version
@@ -290,15 +296,16 @@ def _check_version_requirements(self, trait_object, raise_exception=True):
                         f"Nipype cannot validate the package version {version!r} for "
                         f"{self.__class__.__name__}. Trait {name} requires version >={min_ver}."
                     )
-                    iflogger.warning(f"{msg}. Please verify validity.")
+                    if not permissive:
+                        iflogger.warning(f"{msg}. Please verify validity.")
                     if config.getboolean("execution", "stop_on_unknown_version"):
                         raise ValueError(msg) from err
                     continue
                 if too_old:
                     unavailable_traits.append(name)
                     if not isdefined(getattr(trait_object, name)):
                         continue
-                    if raise_exception:
+                    if not permissive:
                         raise Exception(
                             "Trait %s (%s) (version %s < required %s)"
                             % (name, self.__class__.__name__, version, min_ver)
@@ -318,15 +325,16 @@ def _check_version_requirements(self, trait_object, raise_exception=True):
                         f"Nipype cannot validate the package version {version!r} for "
                         f"{self.__class__.__name__}. Trait {name} requires version <={max_ver}."
                     )
-                    iflogger.warning(f"{msg}. Please verify validity.")
+                    if not permissive:
+                        iflogger.warning(f"{msg}. Please verify validity.")
                     if config.getboolean("execution", "stop_on_unknown_version"):
                         raise ValueError(msg) from err
                     continue
                 if too_new:
                     unavailable_traits.append(name)
                     if not isdefined(getattr(trait_object, name)):
                         continue
-                    if raise_exception:
+                    if not permissive:
                         raise Exception(
                             "Trait %s (%s) (version %s > required %s)"
                             % (name, self.__class__.__name__, version, max_ver)

nipype/interfaces/base/tests/test_core.py

@@ -245,14 +245,12 @@ class input_spec(nib.TraitedSpec):
 
         _version = "misparsed-garbage"
 
-    with caplog.at_level(logging.WARNING, logger="nipype.interface"):
-        obj = DerivedInterface()
-    assert len(caplog.records) == 2
+    obj = DerivedInterface()
     obj.inputs.foo = 1
     obj.inputs.bar = 1
     with caplog.at_level(logging.WARNING, logger="nipype.interface"):
         obj._check_version_requirements(obj.inputs)
-    assert len(caplog.records) == 4
+    assert len(caplog.records) == 2
 
 
 def test_input_version_missing_error(caplog):
@@ -265,17 +263,15 @@ class input_spec(nib.TraitedSpec):
 
         _version = "misparsed-garbage"
 
-    with caplog.at_level(logging.WARNING, logger="nipype.interface"):
-        obj1 = DerivedInterface(foo=1)
-        obj2 = DerivedInterface(bar=1)
-    assert len(caplog.records) == 4
+    obj1 = DerivedInterface(foo=1)
+    obj2 = DerivedInterface(bar=1)
     with caplog.at_level(logging.WARNING, logger="nipype.interface"):
         with mock.patch.object(config, "getboolean", return_value=True):
             with pytest.raises(ValueError):
                 obj1._check_version_requirements(obj1.inputs)
             with pytest.raises(ValueError):
                 obj2._check_version_requirements(obj2.inputs)
-    assert len(caplog.records) == 6
+    assert len(caplog.records) == 2
 
 
 def test_unavailable_input():