Merge pull request #236 from fooof-tools/modutest

[MNT] - Add test for `check_dependency`

Author: TomDonoghue

fooof/core/modutils.py

@@ -45,6 +45,38 @@ def safe_import(*args):
     return mod
 
 
+def check_dependency(dep, name):
+    """Decorator that checks if an optional dependency is available.
+
+    Parameters
+    ----------
+    dep : module or False
+        Module, if successfully imported, or boolean (False) if not.
+    name : str
+        Full name of the module, to be printed in message.
+
+    Returns
+    -------
+    wrap : callable
+        The decorated function.
+
+    Raises
+    ------
+    ImportError
+        If the requested dependency is not available.
+    """
+
+    def wrap(func):
+        @wraps(func)
+        def wrapped_func(*args, **kwargs):
+            if not dep:
+                raise ImportError("Optional FOOOF dependency " + name + \
+                                  " is required for this functionality.")
+            return func(*args, **kwargs)
+        return wrapped_func
+    return wrap
+
+
 def docs_drop_param(docstring):
     """Drop the first parameter description for a string representation of a docstring.
 
@@ -148,35 +180,3 @@ def wrapper(func):
         return func
 
     return wrapper
-
-
-def check_dependency(dep, name):
-    """Decorator that checks if an optional dependency is available.
-
-    Parameters
-    ----------
-    dep : module or False
-        Module, if successfully imported, or boolean (False) if not.
-    name : str
-        Full name of the module, to be printed in message.
-
-    Returns
-    -------
-    wrap : callable
-        The decorated function.
-
-    Raises
-    ------
-    ImportError
-        If the requested dependency is not available.
-    """
-
-    def wrap(func):
-        @wraps(func)
-        def wrapped_func(*args, **kwargs):
-            if not dep:
-                raise ImportError("Optional FOOOF dependency " + name + \
-                                  " is required for this functionality.")
-            return func(*args, **kwargs)
-        return wrapped_func
-    return wrap

fooof/tests/core/test_modutils.py

@@ -1,8 +1,10 @@
 """Tests for fooof.core.modutils.
 
-Note: decorators (that are in modutils) are currently not tested.
+Note: the decorators for copying documentation are not currently tested.
 """
 
+from pytest import raises
+
 from fooof.core.modutils import *
 
 ###################################################################################################
@@ -16,6 +18,21 @@ def test_safe_import():
     bad = safe_import('bad')
     assert not bad
 
+def test_check_dependency():
+
+    import numpy as np
+    @check_dependency(np, 'numpy')
+    def subfunc_good():
+        pass
+    subfunc_good()
+
+    bad = None
+    @check_dependency(bad, 'bad')
+    def subfunc_bad():
+        pass
+    with raises(ImportError):
+        subfunc_bad()
+
 def test_docs_drop_param():
 
     ds = """STUFF