Add notes for missing comparison columns in validation

Author: rich-iannone

pointblank/_constants_translations.py

@@ -4672,4 +4672,88 @@
         "th": "ไม่ตรงกับคอลัมน์ใดๆ ในตาราง",
         "fa": "با هیچ ستونی در جدول مطابقت ندارد",
     },
+    "comparison_column_provided": {
+        "en": "The comparison column provided",
+        "fr": "La colonne de comparaison fournie",
+        "de": "Die angegebene Vergleichsspalte",
+        "it": "La colonna di confronto fornita",
+        "es": "La columna de comparación proporcionada",
+        "pt": "A coluna de comparação fornecida",
+        "ro": "Coloana de comparație furnizată",
+        "tr": "Sağlanan karşılaştırma sütunu",
+        "zh-Hans": "提供的比较列",
+        "zh-Hant": "提供的比較列",
+        "ja": "提供された比較列",
+        "ko": "제공된 비교 열",
+        "vi": "Cột so sánh được cung cấp",
+        "ru": "Предоставленный столбец сравнения",
+        "cs": "Poskytnutý srovnávací sloupec",
+        "pl": "Dostarczona kolumna porównania",
+        "da": "Den angivne sammenligningskolonne",
+        "sv": "Den angivna jämförelsekolumnen",
+        "nb": "Den angitte sammenligningskolonnen",
+        "nl": "De opgegeven vergelijkingskolom",
+        "fi": "Annettu vertailusarake",
+        "is": "Uppgefinn samanburðardálkur",
+        "ar": "عمود المقارنة المقدم",
+        "hi": "प्रदान किया गया तुलना स्तंभ",
+        "el": "Η παρεχόμενη στήλη σύγκρισης",
+        "id": "Kolom perbandingan yang diberikan",
+        "uk": "Наданий стовпець порівняння",
+        "bg": "Предоставената колона за сравнение",
+        "hr": "Navedeni stupac usporedbe",
+        "et": "Esitatud võrdlusveerg",
+        "hu": "A megadott összehasonlítási oszlop",
+        "ga": "An colún comparáide a cuireadh ar fáil",
+        "lv": "Nodrošinātā salīdzinājuma kolonna",
+        "lt": "Pateiktas palyginimo stulpelis",
+        "mt": "Il-kolonna tal-paragun pprovduta",
+        "sk": "Poskytnutý porovnávací stĺpec",
+        "sl": "Podani primerjalni stolpec",
+        "he": "עמודת ההשוואה שסופקה",
+        "th": "คอลัมน์เปรียบเทียบที่ให้มา",
+        "fa": "ستون مقایسه ارائه شده",
+    },
+    "comparison_column_for": {
+        "en": "The comparison column provided for",
+        "fr": "La colonne de comparaison fournie pour",
+        "de": "Die angegebene Vergleichsspalte für",
+        "it": "La colonna di confronto fornita per",
+        "es": "La columna de comparación proporcionada para",
+        "pt": "A coluna de comparação fornecida para",
+        "ro": "Coloana de comparație furnizată pentru",
+        "tr": "Sağlanan karşılaştırma sütunu için",
+        "zh-Hans": "为提供的比较列",
+        "zh-Hant": "為提供的比較列",
+        "ja": "提供された比較列の",
+        "ko": "제공된 비교 열의",
+        "vi": "Cột so sánh được cung cấp cho",
+        "ru": "Предоставленный столбец сравнения для",
+        "cs": "Poskytnutý srovnávací sloupec pro",
+        "pl": "Dostarczona kolumna porównania dla",
+        "da": "Den angivne sammenligningskolonne til",
+        "sv": "Den angivna jämförelsekolumnen för",
+        "nb": "Den angitte sammenligningskolonnen for",
+        "nl": "De opgegeven vergelijkingskolom voor",
+        "fi": "Annettu vertailusarake parametrille",
+        "is": "Uppgefinn samanburðardálkur fyrir",
+        "ar": "عمود المقارنة المقدم لـ",
+        "hi": "प्रदान किया गया तुलना स्तंभ के लिए",
+        "el": "Η παρεχόμενη στήλη σύγκρισης για",
+        "id": "Kolom perbandingan yang diberikan untuk",
+        "uk": "Наданий стовпець порівняння для",
+        "bg": "Предоставената колона за сравнение за",
+        "hr": "Navedeni stupac usporedbe za",
+        "et": "Esitatud võrdlusveerg jaoks",
+        "hu": "A megadott összehasonlítási oszlop paraméterre",
+        "ga": "An colún comparáide a cuireadh ar fáil le haghaidh",
+        "lv": "Nodrošinātā salīdzinājuma kolonna priekš",
+        "lt": "Pateiktas palyginimo stulpelis parametrui",
+        "mt": "Il-kolonna tal-paragun pprovduta għal",
+        "sk": "Poskytnutý porovnávací stĺpec pre",
+        "sl": "Podani primerjalni stolpec za",
+        "he": "עמודת ההשוואה שסופקה עבור",
+        "th": "คอลัมน์เปรียบเทียบที่ให้มาสำหรับ",
+        "fa": "ستون مقایسه ارائه شده برای",
+    },
 }

pointblank/validate.py

@@ -12682,6 +12682,7 @@ def interrogate(
                 except Exception as e:
                     # Catch data quality errors and column not found errors
                     error_msg = str(e).lower()
+
                     is_comparison_error = (
                         "boolean value of na is ambiguous" in error_msg
                         or "cannot compare" in error_msg
@@ -12691,13 +12692,20 @@ def interrogate(
                         )
                         or ("dtype" in error_msg and "compare" in error_msg)
                     )
+
                     is_column_not_found = "column" in error_msg and "not found" in error_msg
 
-                    if is_comparison_error or is_column_not_found:  # pragma: no cover
+                    is_comparison_column_not_found = (
+                        "unable to find column" in error_msg and "valid columns" in error_msg
+                    )
+
+                    if (
+                        is_comparison_error or is_column_not_found or is_comparison_column_not_found
+                    ):  # pragma: no cover
                         # If data quality comparison fails or column not found, mark as eval_error
                         validation.eval_error = True  # pragma: no cover
 
-                        # Add a note for column not found errors
+                        # Add a note for column not found errors (target column)
                         if is_column_not_found:
                             note_html = _create_column_not_found_note_html(
                                 column_name=column,
@@ -12718,14 +12726,65 @@ def interrogate(
                                 text=note_text,
                             )
 
+                        # Add a note for comparison column not found errors
+                        elif is_comparison_column_not_found:
+                            # Extract column name from error message
+                            # Error format: 'unable to find column "col_name"; valid columns: ...'
+                            match = re.search(r'unable to find column "([^"]+)"', str(e))
+
+                            if match:
+                                missing_col_name = match.group(1)
+
+                                # Determine position for between/outside validations
+                                position = None
+                                if assertion_type in ["col_vals_between", "col_vals_outside"]:
+                                    # Check if missing column is in left or right position
+                                    from pointblank.column import Column
+
+                                    if (
+                                        isinstance(value[0], Column)
+                                        and value[0].exprs == missing_col_name
+                                    ):
+                                        position = "left"
+                                    elif (
+                                        isinstance(value[1], Column)
+                                        and value[1].exprs == missing_col_name
+                                    ):
+                                        position = "right"
+
+                                note_html = _create_comparison_column_not_found_note_html(
+                                    column_name=missing_col_name,
+                                    position=position,
+                                    available_columns=list(data_tbl_step.columns)
+                                    if hasattr(data_tbl_step, "columns")
+                                    else [],
+                                    locale=self.locale,
+                                )
+                                note_text = _create_comparison_column_not_found_note_text(
+                                    column_name=missing_col_name,
+                                    position=position,
+                                    available_columns=list(data_tbl_step.columns)
+                                    if hasattr(data_tbl_step, "columns")
+                                    else [],
+                                )
+                                validation._add_note(
+                                    key="comparison_column_not_found",
+                                    markdown=note_html,
+                                    text=note_text,
+                                )
+
                         end_time = datetime.datetime.now(datetime.timezone.utc)  # pragma: no cover
+
                         validation.proc_duration_s = (
                             end_time - start_time
                         ).total_seconds()  # pragma: no cover
+
                         validation.time_processed = end_time.isoformat(
                             timespec="milliseconds"
                         )  # pragma: no cover
+
                         validation.active = False  # pragma: no cover
+
                         continue  # pragma: no cover
                     else:
                         # For other unexpected errors, let them propagate
@@ -12826,6 +12885,7 @@ def interrogate(
                         markdown=threshold_note_html,
                         text=threshold_note_text,
                     )
+
                 elif self.thresholds != Thresholds():
                     # Thresholds explicitly reset to empty when global thresholds exist
                     reset_note_html = _create_threshold_reset_note_html(locale=self.locale)
@@ -18520,8 +18580,8 @@ def _create_no_columns_resolved_note_html(
         ),
     )
 
-    # Format the column expression
-    col_expr_html = f"<code>{column_expr}</code>"
+    # Format the column expression with monospace font
+    col_expr_html = f"<code style='font-family: \"IBM Plex Mono\", monospace;'>{column_expr}</code>"
 
     # Build the HTML note
     html = f"{intro} {col_expr_html} {no_resolve}."
@@ -18579,8 +18639,8 @@ def _create_column_not_found_note_html(
         ),
     )
 
-    # Format the column name
-    col_name_html = f"<code>{column_name}</code>"
+    # Format the column name with monospace font
+    col_name_html = f"<code style='font-family: \"IBM Plex Mono\", monospace;'>{column_name}</code>"
 
     # Build the HTML note
     html = f"{intro} ({col_name_html}) {not_found}."
@@ -18607,6 +18667,95 @@ def _create_column_not_found_note_text(column_name: str, available_columns: list
     return f"The target column provided ({column_name}) does not match any columns in the table."
 
 
+def _create_comparison_column_not_found_note_html(
+    column_name: str, position: str | None, available_columns: list[str], locale: str = "en"
+) -> str:
+    """
+    Create an HTML note explaining that a comparison column was not found.
+
+    Parameters
+    ----------
+    column_name
+        The comparison column name that was not found.
+    position
+        Optional position indicator ("left", "right") for between/outside validations.
+    available_columns
+        List of available column names in the table.
+    locale
+        The locale string (e.g., 'en', 'fr').
+
+    Returns
+    -------
+    str
+        HTML-formatted note text.
+    """
+    # Get translated strings
+    intro = NOTES_TEXT.get("comparison_column_provided", {}).get(
+        locale,
+        NOTES_TEXT.get("comparison_column_provided", {}).get(
+            "en", "The comparison column provided"
+        ),
+    )
+    intro_with_for = NOTES_TEXT.get("comparison_column_for", {}).get(
+        locale,
+        NOTES_TEXT.get("comparison_column_for", {}).get("en", "The comparison column provided for"),
+    )
+    not_found = NOTES_TEXT.get("does_not_match_any_columns", {}).get(
+        locale,
+        NOTES_TEXT.get("does_not_match_any_columns", {}).get(
+            "en", "does not match any columns in the table"
+        ),
+    )
+
+    # Format the column name with monospace font
+    col_name_html = f"<code style='font-family: \"IBM Plex Mono\", monospace;'>{column_name}</code>"
+
+    # Add position if provided (for between/outside validations)
+    if position:
+        # Format position parameter with monospace font (e.g., "left=", "right=")
+        position_param = (
+            f"<code style='font-family: \"IBM Plex Mono\", monospace;'>{position}=</code>"
+        )
+        # Use the "for" version of the intro text
+        html = f"{intro_with_for} {position_param} ({col_name_html}) {not_found}."
+    else:
+        # Use the standard intro text without "for"
+        html = f"{intro} ({col_name_html}) {not_found}."
+
+    return html
+
+
+def _create_comparison_column_not_found_note_text(
+    column_name: str, position: str | None, available_columns: list[str]
+) -> str:
+    """
+    Create a plain text note explaining that a comparison column was not found.
+
+    Parameters
+    ----------
+    column_name
+        The comparison column name that was not found.
+    position
+        Optional position indicator ("left", "right") for between/outside validations.
+    available_columns
+        List of available column names in the table.
+
+    Returns
+    -------
+    str
+        Plain text note.
+    """
+    if position:
+        position_text = f" for {position}="
+    else:
+        position_text = ""
+
+    return (
+        f"The comparison column provided{position_text} ({column_name}) "
+        f"does not match any columns in the table."
+    )
+
+
 def _create_col_schema_match_note_html(schema_info: dict, locale: str = "en") -> str:
     """
     Create an HTML note with collapsible schema expectation and results.