Made 'pyuff' dependency optional

mosqito/functions/shared/load.py

@@ -7,10 +7,15 @@
 
 # Standard library imports
 import numpy as np
-import pyuff
 from scipy.io import wavfile, loadmat
 from scipy.signal import resample
 
+# Optional package import
+try:
+    import pyuff
+except ImportError:
+    pyuff = None
+
 # Local import
 from mosqito.functions.oct3filter.comp_third_spectrum import comp_third_spec
 
@@ -55,9 +60,7 @@ def load(is_stationary, file, calib=1, mat_signal="", mat_fs=""):
 
     # load the .uff file content
     elif file[-3:].lower() == "uff" or file[-3:].lower() == "unv":
-        uff_file = pyuff.UFF(file)
-        data = uff_file.read_sets()
-        data.keys()
+        data = uff_load(file)
 
         # extract the signal values
         signal = data["data"]
@@ -143,10 +146,8 @@ def load2wav(
     """
 
     # Load the .uff file content
-    if file[-3:] == "uff" or file[-3:] == "UFF":
-        uff_file = pyuff.UFF(file)
-        data = uff_file.read_sets()
-        data.keys()
+    if file[-3:].lower() == "uff" or file[-3:].lower() == "unv":
+        data = uff_load(file)
 
         # extract the signal values
         signal = data["data"]
@@ -181,3 +182,12 @@ def load2wav(
     # create the .wav file
     newfile = file[:-3] + "wav"
     wavfile.write(newfile, sampling_freq, signal)
+
+
+def uff_load(file):
+    if pyuff is None:
+        raise RuntimeError("In order to load UFF files you need the 'pyuff' "
+                           "package.")
+    uff_file = pyuff.UFF(file)
+    data = uff_file.read_sets()
+    return data

requirements.txt

@@ -2,7 +2,6 @@ numpy
 scipy
 pytest
 matplotlib
-pyuff
 scidatatool
 h5py
-cloudpickle
+cloudpickle

setup.py

@@ -17,6 +17,8 @@
     ).splitlines()  # remove endline in each element
 
 tests_require = ["pytest>=5.4.1", "pandas", "openpyxl"]
+uff_require = ["pyuff", ]
+all_require = tests_require + uff_require
 
 setuptools.setup(
     name="mosqito",
@@ -47,5 +49,7 @@
     python_requires=python_requires,
     install_requires=install_requires,
     tests_require=tests_require,
-    extras_require={"testing": tests_require},
+    extras_require={"testing": tests_require,
+                    "uff": uff_require,
+                    "all": all_require},
 )