MAINT: Remove non-compliant dtseries.json metadata

Author: mgxd

niworkflows/interfaces/bids.py

@@ -50,7 +50,7 @@
 from templateflow.api import templates as _get_template_list
 from ..utils.bids import _init_layout, relative_to_root
 from ..utils.images import set_consumables, unsafe_write_nifti_header_and_data
-from ..utils.misc import splitext as _splitext, _copy_any, unlink
+from ..utils.misc import _copy_any, unlink
 
 regz = re.compile(r"\.gz$")
 _pybids_spec = loads(Path(_pkgres("niworkflows", "data/nipreps.json")).read_text())
@@ -710,21 +710,6 @@ def _run_interface(self, runtime):
                 }
             )
             if self._metadata:
-                out_file = Path(self._results["out_file"][0])
-                # 1.3.x hack
-                # For dtseries, we have been generating weird non-BIDS JSON files.
-                # We can safely keep producing them to avoid breaking derivatives, but
-                # only the existing keys should keep going into them.
-                if out_file.name.endswith(".dtseries.nii"):
-                    legacy_metadata = {}
-                    for key in ("grayordinates", "space", "surface", "surface_density", "volume"):
-                        if key in self._metadata:
-                            legacy_metadata[key] = self._metadata.pop(key)
-                    if legacy_metadata:
-                        sidecar = out_file.parent / f"{_splitext(str(out_file))[0]}.json"
-                        unlink(sidecar, missing_ok=True)
-                        sidecar.write_text(dumps(legacy_metadata, sort_keys=True, indent=2))
-                # The future: the extension is the first . and everything after
                 sidecar = out_file.parent / f"{out_file.name.split('.', 1)[0]}.json"
                 unlink(sidecar, missing_ok=True)
                 sidecar.write_text(dumps(self._metadata, sort_keys=True, indent=2))

niworkflows/interfaces/tests/test_bids.py

@@ -342,7 +342,7 @@ def test_DerivativesDataSink_build_path(
         assert sha1(Path(out).read_bytes()).hexdigest() == chksum
 
 
-def test_DerivativesDataSink_dtseries_json_hack(tmp_path):
+def test_DerivativesDataSink_dtseries_json(tmp_path):
     cifti_fname = str(tmp_path / "test.dtseries.nii")
 
     axes = (nb.cifti2.SeriesAxis(start=0, step=2, size=20),
@@ -376,8 +376,7 @@ def test_DerivativesDataSink_dtseries_json_hack(tmp_path):
     old_sidecar = out_path.with_name("sub-01_task-rest_space-fsLR_bold.dtseries.json")
     new_sidecar = out_path.with_name("sub-01_task-rest_space-fsLR_bold.json")
 
-    assert old_sidecar.exists()
-    assert "grayordinates" in json.loads(old_sidecar.read_text())
+    assert not old_sidecar.exists()
     assert new_sidecar.exists()
     assert "RepetitionTime" in json.loads(new_sidecar.read_text())