RF: Rename testing.test_data to testing.get_test_data

Author: effigies

nibabel/cmdline/tests/test_conform.py

@@ -15,15 +15,15 @@
 import nibabel as nib
 from nibabel.cmdline.conform import main
 from nibabel.optpkg import optional_package
-from nibabel.testing import test_data
+from nibabel.testing import get_test_data
 
 _, have_scipy, _ = optional_package('scipy.ndimage')
 needs_scipy = unittest.skipUnless(have_scipy, 'These tests need scipy')
 
 
 @needs_scipy
 def test_default(tmpdir):
-    infile = test_data(fname='anatomical.nii')
+    infile = get_test_data(fname='anatomical.nii')
     outfile = tmpdir / 'output.nii.gz'
     main([str(infile), str(outfile)])
     assert outfile.isfile()
@@ -41,7 +41,7 @@ def test_default(tmpdir):
 
 @needs_scipy
 def test_nondefault(tmpdir):
-    infile = test_data(fname='anatomical.nii')
+    infile = get_test_data(fname='anatomical.nii')
     outfile = tmpdir / 'output.nii.gz'
     out_shape = (100, 100, 150)
     voxel_size = (1, 2, 4)

nibabel/cmdline/tests/test_convert.py

@@ -13,11 +13,11 @@
 
 import nibabel as nib
 from nibabel.cmdline import convert
-from nibabel.testing import test_data
+from nibabel.testing import get_test_data
 
 
 def test_convert_noop(tmp_path):
-    infile = test_data(fname='anatomical.nii')
+    infile = get_test_data(fname='anatomical.nii')
     outfile = tmp_path / 'output.nii.gz'
 
     orig = nib.load(infile)
@@ -31,7 +31,7 @@ def test_convert_noop(tmp_path):
     assert converted.shape == orig.shape
     assert converted.get_data_dtype() == orig.get_data_dtype()
 
-    infile = test_data(fname='resampled_anat_moved.nii')
+    infile = get_test_data(fname='resampled_anat_moved.nii')
 
     with pytest.raises(FileExistsError):
         convert.main([str(infile), str(outfile)])
@@ -50,7 +50,7 @@ def test_convert_noop(tmp_path):
 
 @pytest.mark.parametrize('data_dtype', ('u1', 'i2', 'float32', 'float', 'int64'))
 def test_convert_dtype(tmp_path, data_dtype):
-    infile = test_data(fname='anatomical.nii')
+    infile = get_test_data(fname='anatomical.nii')
     outfile = tmp_path / 'output.nii.gz'
 
     orig = nib.load(infile)
@@ -78,7 +78,7 @@ def test_convert_dtype(tmp_path, data_dtype):
     ],
 )
 def test_convert_by_extension(tmp_path, ext, img_class):
-    infile = test_data(fname='anatomical.nii')
+    infile = get_test_data(fname='anatomical.nii')
     outfile = tmp_path / f'output.{ext}'
 
     orig = nib.load(infile)
@@ -102,7 +102,7 @@ def test_convert_by_extension(tmp_path, ext, img_class):
     ],
 )
 def test_convert_imgtype(tmp_path, ext, img_class):
-    infile = test_data(fname='anatomical.nii')
+    infile = get_test_data(fname='anatomical.nii')
     outfile = tmp_path / f'output.{ext}'
 
     orig = nib.load(infile)
@@ -118,7 +118,7 @@ def test_convert_imgtype(tmp_path, ext, img_class):
 
 
 def test_convert_nifti_int_fail(tmp_path):
-    infile = test_data(fname='anatomical.nii')
+    infile = get_test_data(fname='anatomical.nii')
     outfile = tmp_path / f'output.nii'
 
     orig = nib.load(infile)

nibabel/gifti/gifti.py

@@ -701,8 +701,8 @@ def agg_data(self, intent_code=None):
         Consider a surface GIFTI file:
 
         >>> import nibabel as nib
-        >>> from nibabel.testing import test_data
-        >>> surf_img = nib.load(test_data('gifti', 'ascii.gii'))
+        >>> from nibabel.testing import get_test_data
+        >>> surf_img = nib.load(get_test_data('gifti', 'ascii.gii'))
 
         The coordinate data, which is indicated by the ``NIFTI_INTENT_POINTSET``
         intent code, may be retrieved using any of the following equivalent
@@ -754,7 +754,7 @@ def agg_data(self, intent_code=None):
         The following image is a GIFTI file with ten (10) data arrays of the same
         size, and with intent code 2001 (``NIFTI_INTENT_TIME_SERIES``):
 
-        >>> func_img = nib.load(test_data('gifti', 'task.func.gii'))
+        >>> func_img = nib.load(get_test_data('gifti', 'task.func.gii'))
 
         When aggregating time series data, these arrays are concatenated into
         a single, vertex-by-timestep array:

nibabel/gifti/tests/test_gifti.py

@@ -14,7 +14,7 @@
 from ... import load
 from ...fileholders import FileHolder
 from ...nifti1 import data_type_codes
-from ...testing import test_data
+from ...testing import get_test_data
 from .. import (
     GiftiCoordSystem,
     GiftiDataArray,
@@ -35,9 +35,9 @@
 
 
 def test_agg_data():
-    surf_gii_img = load(test_data('gifti', 'ascii.gii'))
-    func_gii_img = load(test_data('gifti', 'task.func.gii'))
-    shape_gii_img = load(test_data('gifti', 'rh.shape.curv.gii'))
+    surf_gii_img = load(get_test_data('gifti', 'ascii.gii'))
+    func_gii_img = load(get_test_data('gifti', 'task.func.gii'))
+    shape_gii_img = load(get_test_data('gifti', 'rh.shape.curv.gii'))
     # add timeseries data with intent code ``none``
 
     point_data = surf_gii_img.get_arrays_from_intent('pointset')[0].data
@@ -478,7 +478,7 @@ def test_darray_dtype_coercion_failures():
 
 
 def test_gifti_file_close(recwarn):
-    gii = load(test_data('gifti', 'ascii.gii'))
+    gii = load(get_test_data('gifti', 'ascii.gii'))
     with InTemporaryDirectory():
         gii.to_filename('test.gii')
     assert not any(isinstance(r.message, ResourceWarning) for r in recwarn)

nibabel/testing/__init__.py

@@ -33,7 +33,7 @@
     from importlib_resources.abc import Traversable
 
 
-def test_data(
+def get_test_data(
     subdir: ty.Literal['gifti', 'nicom', 'externals'] | None = None,
     fname: str | None = None,
 ) -> Traversable:
@@ -52,7 +52,7 @@ def test_data(
 
 
 # set path to example data
-data_path = test_data()
+data_path = get_test_data()
 
 
 def assert_dt_equal(a, b):

nibabel/tests/test_testing.py

@@ -15,8 +15,8 @@
     data_path,
     error_warnings,
     get_fresh_mod,
+    get_test_data,
     suppress_warnings,
-    test_data,
 )
 
 
@@ -171,27 +171,27 @@ def test_assert_re_in(regex, entries):
 
 
 def test_test_data():
-    assert str(test_data()) == str(data_path)  # Always get the same result
+    assert str(get_test_data()) == str(data_path)  # Always get the same result
     # Works the same as using __file__ and os.path utilities
-    assert str(test_data()) == os.path.abspath(
+    assert str(get_test_data()) == os.path.abspath(
         os.path.join(os.path.dirname(__file__), '..', 'tests', 'data')
     )
     # Check action of subdir and that existence checks work
     for subdir in ('nicom', 'gifti', 'externals'):
-        assert test_data(subdir) == data_path.parent.parent / subdir / 'tests' / 'data'
-        assert os.path.exists(test_data(subdir))
-        assert not os.path.exists(test_data(subdir, 'doesnotexist'))
+        assert get_test_data(subdir) == data_path.parent.parent / subdir / 'tests' / 'data'
+        assert os.path.exists(get_test_data(subdir))
+        assert not os.path.exists(get_test_data(subdir, 'doesnotexist'))
 
     for subdir in ('freesurfer', 'doesnotexist'):
         with pytest.raises(ValueError):
-            test_data(subdir)
+            get_test_data(subdir)
 
-    assert not os.path.exists(test_data(None, 'doesnotexist'))
+    assert not os.path.exists(get_test_data(None, 'doesnotexist'))
 
     for subdir, fname in [
         ('gifti', 'ascii.gii'),
         ('nicom', '0.dcm'),
         ('externals', 'example_1.nc'),
         (None, 'empty.tck'),
     ]:
-        assert os.path.exists(test_data(subdir, fname))
+        assert os.path.exists(get_test_data(subdir, fname))