Report table name in accept_divergence (#1350)

* Report table name in `accept_divergence`

* Update changelog

* Add type hint specificity

Author: CBroz1

CHANGELOG.md

@@ -109,7 +109,7 @@ ImportedLFP().drop()
     - Correct name parsing in Session.Experimenter insertion #1306
     - Allow insert with dio events but no e-series data #1318
     - Prompt user to verify compatibility between new insert and existing table
-        entries # 1318
+        entries # 1318, #1350
     - Skip empty timeseries ingestion (`PositionSource`, `DioEvents`) #1347
 - Position
     - Allow population of missing `PositionIntervalMap` entries during population

src/spyglass/common/common_device.py

@@ -171,15 +171,19 @@ def _add_device(cls, new_device_dict, test_mode=None):
             DataAcquisitionDevice & {"data_acquisition_device_name": name}
         ).fetch1()
         for k, existing_val in db_dict.items():
-            if not (new_val := new_device_dict.get(k, None)) == existing_val:
-                # if the values do not match, check whether the user wants to
-                # accept the entry in the database, or raise an exception
-                if not accept_divergence(k, new_val, existing_val, test_mode):
-                    raise PopulateException(
-                        "Data acquisition device properties of PyNWB Device object "
-                        + f"with name '{name}': {new_device_dict} do not match "
-                        f"properties of the corresponding database entry: {db_dict}."
-                    )
+            new_val = new_device_dict.get(k, None)
+            if new_val == existing_val:
+                continue  # values match, no need to check further
+            # if the values do not match, check whether the user wants to
+            # accept the entry in the database, or raise an exception
+            if not accept_divergence(
+                k, new_val, existing_val, test_mode, cls.camel_name
+            ):
+                raise PopulateException(
+                    "Data acquisition device properties of PyNWB Device object "
+                    + f"with name '{name}': {new_device_dict} do not match "
+                    f"properties of the corresponding database entry: {db_dict}"
+                )
 
     @classmethod
     def _add_system(cls, system):

src/spyglass/common/common_task.py

@@ -73,20 +73,22 @@ def unequal_vals(key, a, b):
                 continue
             existing = query.fetch1()
             for key in set(task_dict).union(existing):
-                if unequal_vals(key, task_dict, existing):
-                    if not accept_divergence(
-                        key,
-                        task_dict.get(key),
-                        existing.get(key),
-                        self._test_mode,
-                    ):
-                        # If the user does not accept the divergence,
-                        # raise an error to prevent data inconsistency
-                        raise ValueError(
-                            f"Task {task_dict['task_name']} already exists "
-                            + f"with different values for {key}: "
-                            + f"{task_dict.get(key)} != {existing.get(key)}"
-                        )
+                if not unequal_vals(key, task_dict, existing):
+                    continue  # skip if values are equal
+                if not accept_divergence(
+                    key,
+                    task_dict.get(key),
+                    existing.get(key),
+                    self._test_mode,
+                    self.camel_name,
+                ):
+                    # If the user does not accept the divergence,
+                    # raise an error to prevent data inconsistency
+                    raise ValueError(
+                        f"Task {task_dict['task_name']} already exists "
+                        + f"with different values for {key}: "
+                        + f"{task_dict.get(key)} != {existing.get(key)}"
+                    )
         # Insert the tasks into the table
         self.insert(inserts)
 

src/spyglass/utils/dj_helper_fn.py

@@ -6,7 +6,7 @@
 import os
 import re
 from pathlib import Path
-from typing import Iterable, List, Type, Union
+from typing import Any, Iterable, List, Optional, Type, Union
 from uuid import uuid4
 
 import datajoint as dj
@@ -106,9 +106,9 @@ def declare_all_merge_tables():
     from spyglass.decoding.decoding_merge import DecodingOutput  # noqa: F401
     from spyglass.lfp.lfp_merge import LFPOutput  # noqa: F401
     from spyglass.position.position_merge import PositionOutput  # noqa: F401
-    from spyglass.spikesorting.spikesorting_merge import (  # noqa: F401
+    from spyglass.spikesorting.spikesorting_merge import (
         SpikeSortingOutput,
-    )
+    )  # noqa: F401
 
 
 def fuzzy_get(index: Union[int, str], names: List[str], sources: List[str]):
@@ -686,16 +686,39 @@ def bytes_to_human_readable(size: int) -> str:
     return msg_template.format(size=size, unit="PB")
 
 
-def accept_divergence(key, new_value, existing_value, test_mode=False):
-    """prompt to accept divergence in values between existing and new entries"""
+def accept_divergence(
+    key: str,
+    new_value: Any,
+    existing_value: Any,
+    test_mode: bool = False,
+    table_name: Optional[str] = None,
+):
+    """Prompt to accept divergence in values between existing and new entries
+
+    Parameters
+    ----------
+    key : str
+        Name of the column where the divergence is found
+    new_value : Any
+        New value to be inserted into the table
+    existing_value : Any
+        Existing value in the table that is different from the new value
+    test_mode : bool, optional
+        If True, will not prompt and return False, by default False
+    table_name : str, optional
+        Name of the table where the divergence is found, by default None
+    """
     if test_mode:
         # If get here in test mode, is because want to test failure
         logger.warning(
-            "accept_divergence called in test mode, returning False without prompt"
+            "accept_divergence called in test mode, returning False w/o prompt"
         )
         return False
+    tbl_msg = ""
+    if table_name:  # optional message with table name
+        tbl_msg = f" of '{table_name}'"
     response = dj.utils.user_choice(
-        f"Existing entry differs in '{key}' column.\n"
+        f"Existing entry differs in '{key}' column{tbl_msg}.\n"
         + "Accept the existing value of: \n"
         + f"'{existing_value}' \n"
         + "in place of the new value: \n"