Allow files as substrings of other files in Nwbfile (#1382)

* Allow files as substrings of other files in Nwbfile

* Update changelog

* Fix failing tests

* Remove helper

* Remove deprecated func

Author: CBroz1

CHANGELOG.md

@@ -33,6 +33,7 @@ import all foreign key references.
     - Add methods for calling moseq visualization functions #1374
 - Common
     - Add tables for storing optogenetic experiment information #1312
+    - Remove wildcard matching in `Nwbfile().get_abs_path` #1382
 - Decoding
     - Ensure results directory is created if it doesn't exist #1362
 - Position

src/spyglass/common/common_behav.py

@@ -78,7 +78,7 @@ def insert_from_nwbfile(cls, nwb_file_name, skip_duplicates=False) -> None:
         """
         nwbf = get_nwb_file(nwb_file_name)
         all_pos = get_all_spatial_series(nwbf, verbose=True)
-        sess_key = Nwbfile.get_file_key(nwb_file_name)
+        sess_key = {"nwb_file_name": nwb_file_name}
         src_key = dict(**sess_key, source="imported", import_file_name="")
 
         if all_pos is None:

src/spyglass/common/common_nwbfile.py

@@ -84,24 +84,6 @@ def fetch_nwb(self):
             for file in self.fetch("nwb_file_name")
         ]
 
-    @classmethod
-    def _get_file_name(cls, nwb_file_name: str) -> str:
-        """Get valid nwb file name given substring."""
-        query = cls & f'nwb_file_name LIKE "%{nwb_file_name}%"'
-
-        if len(query) == 1:
-            return query.fetch1("nwb_file_name")
-
-        raise ValueError(
-            f"Found {len(query)} matches for {nwb_file_name} in Nwbfile table:"
-            + f" \n{query}"
-        )
-
-    @classmethod
-    def get_file_key(cls, nwb_file_name: str) -> dict:
-        """Return primary key using nwb_file_name substring."""
-        return {"nwb_file_name": cls._get_file_name(nwb_file_name)}
-
     @classmethod
     def get_abs_path(
         cls, nwb_file_name: str, new_file: bool = False, **kwargs
@@ -124,10 +106,17 @@ def get_abs_path(
         nwb_file_abspath : str
             The absolute path for the given file name.
         """
+        file_path = raw_dir + "/" + nwb_file_name
         if new_file:
-            return raw_dir + "/" + nwb_file_name
+            return file_path
+
+        query = cls & {"nwb_file_name": nwb_file_name}
+        if len(query) != 1:
+            raise ValueError(
+                f"Could not find 1 entry for {nwb_file_name}:\n{query}"
+            )
 
-        return raw_dir + "/" + cls._get_file_name(nwb_file_name)
+        return file_path
 
     @staticmethod
     def add_to_lock(nwb_file_name: str) -> None:

tests/common/test_ephys.py

@@ -4,9 +4,9 @@
 from ..conftest import TEARDOWN
 
 
-def test_create_from_config(mini_insert, common_ephys, mini_path):
+def test_create_from_config(mini_insert, common_ephys, mini_copy_name):
     before = common_ephys.Electrode().fetch()
-    common_ephys.Electrode.create_from_config(mini_path.stem)
+    common_ephys.Electrode.create_from_config(mini_copy_name)
     after = common_ephys.Electrode().fetch()
     # Because already inserted, expect no change
     assert array_equal(

tests/common/test_nwbfile.py

@@ -19,12 +19,6 @@ def lockfile(base_dir, teardown):
         os.remove(lockfile)
 
 
-def test_get_file_name_error(common_nwbfile):
-    """Test that an error is raised when trying non-existent file."""
-    with pytest.raises(ValueError):
-        common_nwbfile.Nwbfile._get_file_name("non-existent-file.nwb")
-
-
 def test_add_to_lock(common_nwbfile, lockfile, mini_copy_name):
     common_nwbfile.Nwbfile.add_to_lock(mini_copy_name)
     with lockfile.open("r") as f: