Rename suffix to suffix_counter in update_complex_name.

The variable name "suffix" is confusing.

Author: tsalo

heudiconv/convert.py

@@ -239,7 +239,7 @@ def prep_conversion(sid, dicoms, outdir, heuristic, converter, anon_sid,
                                     getattr(heuristic, 'DEFAULT_FIELDS', {}))
 
 
-def update_complex_name(metadata, filename, suffix):
+def update_complex_name(metadata, filename, suffix_counter):
     """
     Insert `_part-<mag|phase>` entity into filename if data are from a
     sequence with magnitude/phase part.
@@ -250,7 +250,7 @@ def update_complex_name(metadata, filename, suffix):
         Scan metadata dictionary from BIDS sidecar file.
     filename : str
         Incoming filename
-    suffix : str
+    suffix_counter : str
         An index used for cases where a single scan produces multiple files,
         but the differences between those files are unknown.
 
@@ -275,7 +275,7 @@ def update_complex_name(metadata, filename, suffix):
     elif 'P' in metadata.get('ImageType'):
         mag_or_phase = 'phase'
     else:
-        mag_or_phase = suffix
+        mag_or_phase = suffix_counter
 
     # Determine scan suffix
     filetype = '_' + filename.split('_')[-1]

heudiconv/tests/test_convert.py

@@ -23,30 +23,38 @@ def test_update_complex_name():
     # Standard name update
     fn = 'sub-X_ses-Y_task-Z_run-01_sbref'
     metadata = {'ImageType': ['ORIGINAL', 'PRIMARY', 'P', 'MB', 'TE3', 'ND', 'MOSAIC']}
-    suffix = 3
+    file_counter = 3  # This is the third file with the same name
     out_fn_true = 'sub-X_ses-Y_task-Z_run-01_part-phase_sbref'
-    out_fn_test = update_complex_name(metadata, fn, suffix)
+    out_fn_test = update_complex_name(metadata, fn, file_counter)
     assert out_fn_test == out_fn_true
 
     # Catch an unsupported type and *do not* update
     fn = 'sub-X_ses-Y_task-Z_run-01_phase'
-    out_fn_test = update_complex_name(metadata, fn, suffix)
+    out_fn_test = update_complex_name(metadata, fn, file_counter)
     assert out_fn_test == fn
 
     # Data type is missing from metadata so use suffix
     fn = 'sub-X_ses-Y_task-Z_run-01_sbref'
     metadata = {'ImageType': ['ORIGINAL', 'PRIMARY', 'MB', 'TE3', 'ND', 'MOSAIC']}
     out_fn_true = 'sub-X_ses-Y_task-Z_run-01_part-3_sbref'
-    out_fn_test = update_complex_name(metadata, fn, suffix)
+    out_fn_test = update_complex_name(metadata, fn, file_counter)
     assert out_fn_test == out_fn_true
 
-    # Catch existing field with value that *does not match* metadata
-    # and raise Exception
+    # Catch existing field with value (part is already in the filename)
+    # that *does not match* metadata and raise Exception
     fn = 'sub-X_ses-Y_task-Z_run-01_part-mag_sbref'
     metadata = {'ImageType': ['ORIGINAL', 'PRIMARY', 'P', 'MB', 'TE3', 'ND', 'MOSAIC']}
-    suffix = 3
+    file_counter = 3
     with pytest.raises(BIDSError):
-        assert update_complex_name(metadata, fn, suffix)
+        update_complex_name(metadata, fn, file_counter)
+
+    # Catch existing field with value (part is already in the filename)
+    # that *does match* metadata and do not update
+    fn = 'sub-X_ses-Y_task-Z_run-01_part-phase_sbref'
+    metadata = {'ImageType': ['ORIGINAL', 'PRIMARY', 'P', 'MB', 'TE3', 'ND', 'MOSAIC']}
+    file_counter = 3
+    out_fn_test = update_complex_name(metadata, fn, file_counter)
+    assert out_fn_test == fn
 
 
 def test_update_multiecho_name():