Make zenodo_get an optional dependency (#2146)

* Import zenodo_get only when it's used. Remove as required dependency
* Update tests

Author: hrobarts

CHANGELOG.md

@@ -27,6 +27,7 @@
   - Dependencies
       - matplotlib-base is an optional dependency, instead of required (#2093)
       - `unittest-parametrize has been added as a dependency for tests (#1990)
+      - zenodo_get is an optional dependency, instead of required (#2146)
 
 
 * 24.3.0

Wrappers/Python/cil/utilities/dataexample.py

@@ -27,7 +27,6 @@
 from zipfile import ZipFile
 from scipy.io import loadmat
 from cil.io import NEXUSDataReader, NikonDataReader, ZEISSDataReader
-from zenodo_get import zenodo_get
 
 class DATA(object):
     @classmethod
@@ -71,6 +70,7 @@ def download_data(cls, data_dir, prompt=True):
                 print('Download cancelled')
                 return False
 
+            from zenodo_get import zenodo_get
             zenodo_get([cls.ZENODO_RECORD, '-g', cls.ZIP_FILE, '-o', data_dir])
             with ZipFile(os.path.join(data_dir, cls.ZIP_FILE), 'r') as zip_ref:
                 zip_ref.extractall(os.path.join(data_dir, cls.FOLDER))

Wrappers/Python/test/test_dataexample.py

@@ -17,19 +17,18 @@
 # CIL Developers, listed at: https://github.com/TomographicImaging/CIL/blob/master/NOTICE.txt
 
 import unittest
-from utils import initialise_tests
+from utils import initialise_tests, has_zenodo_get
 from cil.framework import ImageGeometry, AcquisitionGeometry
 from cil.utilities import dataexample
 from cil.utilities import noise
 import os, sys, shutil
 from testclass import CCPiTestClass
 import platform
 import numpy as np
-from unittest.mock import patch 
+from unittest.mock import patch
 from zipfile import ZipFile
 from io import StringIO
 import uuid
-from zenodo_get import zenodo_get
 
 initialise_tests()
 
@@ -168,7 +167,8 @@ def mock_zenodo_get(*args):
 
 
     @patch('cil.utilities.dataexample.input', return_value='y')
-    @patch('cil.utilities.dataexample.zenodo_get', side_effect=mock_zenodo_get)
+    @patch('zenodo_get.zenodo_get', side_effect=mock_zenodo_get)
+    @unittest.skipUnless(has_zenodo_get, "zenodo_get not installed")
     def test_download_data_input_y(self, mock_zenodo_get, input):
         '''
         Test the download_data function, when the user input is 'y' to 'are you sure you want to download data'
@@ -196,7 +196,7 @@ def test_download_data_input_y(self, mock_zenodo_get, input):
 
 
     @patch('cil.utilities.dataexample.input', return_value='n')
-    @patch('cil.utilities.dataexample.zenodo_get', side_effect=mock_zenodo_get)   
+    @patch('zenodo_get.zenodo_get', side_effect=mock_zenodo_get)
     def test_download_data_input_n(self, mock_zenodo_get, input):
         '''
         Test the download_data function, when the user input is 'n' to 'are you sure you want to download data'
@@ -239,7 +239,4 @@ def test_download_data_empty(self, input):
 
         with self.assertRaises(ValueError):
             remote_data.download_data('.')
-
-    def test_a(self):
-        from cil.utilities.dataexample import WALNUT
 

Wrappers/Python/test/utils.py

@@ -134,6 +134,13 @@ def initialise_tests():
     has_matplotlib = True
 system_state['has_matplotlib'] = has_matplotlib
 
+#has_zenodo_get
+module_info = importlib.util.find_spec("zenodo_get")
+if module_info is None:
+    has_zenodo_get = False
+else:
+    has_zenodo_get = True
+system_state['has_zenodo_get'] = has_zenodo_get
 
 # to disable prints from 3rd part libraries and tests
 def disable_print():

recipe/meta.yaml

@@ -25,6 +25,7 @@ test:
     - ccpi-regulariser=24.0.1 # [not osx]
     - astra-toolbox=2.1=cuda* # [not osx]
     - matplotlib-base >=3.3.0
+    - zenodo_get >=1.6
 
   source_files:
     - ./Wrappers/Python/test
@@ -71,7 +72,6 @@ requirements:
     - {{ pin_compatible('ipp', min_pin='x.x', max_pin='x.x') }}
     - tqdm
     - numba
-    - zenodo_get >=1.6
 
   #optional packages with version dependancies
   run_constrained: