integrate suggested changes

Author: alm180

mne_bids/dig.py

@@ -413,8 +413,8 @@ def _write_dig_bids(
     acpc_aligned : bool
         Whether "mri" space is aligned to ACPC.
     electrodes_tsv_task : bool
-        Whether to add the ``task-`` entity to the ``BIDSPath`` of
-        the ``electrodes.tsv`` file. Defaults to ``False``.
+        Whether to add the ``task-`` entity to the ``electrodes.tsv`` filename.
+        Defaults to ``False``.
     overwrite : bool
         Whether to overwrite the existing file.
         Defaults to False.

mne_bids/tests/test_dig.py

@@ -381,7 +381,7 @@ def test_electrodes_io(tmp_path):
 
 
 @testing.requires_testing_data
-def test_task_specific_channels_sidecar(tmp_path):
+def test_task_specific_electrodes_sidecar(tmp_path):
     """Test the optional task- entity in electrodes.tsv."""
     raw = _load_raw()
     raw.pick(["eeg"])
@@ -433,32 +433,20 @@ def test_task_specific_channels_sidecar(tmp_path):
     assert coordpath_foo.name == "sub-01_ses-01_acq-01_space-CapTrak_coordsystem.json"
     assert coordpath_bar.name == "sub-01_ses-01_acq-01_space-CapTrak_coordsystem.json"
 
-    # Now test for no task- entity in electrodes.tsv
-
-    bpath_kwargs = dict(
-        root=bids_root2,
-        subject="01",
-        session="01",
-        run="01",
-        acquisition="01",
-        task="foo",
+    # make sure we are reading the correct electrodes sidecar
+    raw_foo_want_pos = raw_foo.get_montage().get_positions()["ch_pos"]["EEG 029"]
+    raw_foo = mne_bids.read_raw_bids(bpath_foo)
+    np.testing.assert_allclose(
+        raw_foo.get_montage().get_positions()["ch_pos"]["EEG 029"], raw_foo_want_pos
     )
 
-    write_kwargs = dict(
-        allow_preload=True,
-        electrodes_tsv_task=False,
-        format="BrainVision",
-    )
+    # Now test for no task- entity in electrodes.tsv
 
-    bpath = mne_bids.BIDSPath(**bpath_kwargs)
-    bpath_foo = mne_bids.write_raw_bids(raw_foo, bpath, **write_kwargs)
+    bpath_kwargs.update(root=bids_root2)
+    write_kwargs.update(electrodes_tsv_task=False)
 
-    bpath_kwargs.update(task="bar")
     bpath = mne_bids.BIDSPath(**bpath_kwargs)
+    bpath_foo = mne_bids.write_raw_bids(raw_foo, bpath, **write_kwargs)
 
-    # without specifying a task, writing a second electrodes.tsv with the same
-    # filename but different contents fails
-    with pytest.raises(
-        RuntimeError, match="Trying to write electrodes.tsv, but it already exists"
-    ):
-        bpath_bar = mne_bids.write_raw_bids(raw_bar, bpath, **write_kwargs)
+    elpath_foo = bpath_foo.find_matching_sidecar(suffix="electrodes", extension=".tsv")
+    assert elpath_foo.name == "sub-01_ses-01_acq-01_space-CapTrak_electrodes.tsv"

mne_bids/write.py

@@ -1432,7 +1432,6 @@ def write_raw_bids(
     event_id=None,
     event_metadata=None,
     extra_columns_descriptions=None,
-    electrodes_tsv_task=False,
     *,
     anonymize=None,
     format="auto",
@@ -1441,6 +1440,7 @@ def write_raw_bids(
     allow_preload=False,
     montage=None,
     acpc_aligned=False,
+    electrodes_tsv_task=False,
     overwrite=False,
     verbose=None,
 ):
@@ -1536,9 +1536,6 @@ def write_raw_bids(
     extra_columns_descriptions : dict | None
         A dictionary that maps column names of the ``event_metadata`` to descriptions.
         Each column of ``event_metadata`` must have a corresponding entry in this.
-    electrodes_tsv_task : bool
-        Add the ``task-`` entity to the ``BIDSPath`` of the
-        ``electrodes.tsv`` file. Defaults to ``False``.
     anonymize : dict | None
         If `None` (default), no anonymization is performed.
         If a dictionary, data will be anonymized depending on the dictionary
@@ -1620,6 +1617,9 @@ def write_raw_bids(
         So, this flag is required to be True when the digitization data
         is in "mri" for intracranial data to confirm that the T1 is
         ACPC-aligned.
+    electrodes_tsv_task : bool
+        Add the ``task-`` entity to the ``electrodes.tsv`` filename.
+        Defaults to ``False``.
     overwrite : bool
         Whether to overwrite existing files or data in files.
         Defaults to ``False``.