Added index to assert message when values differ

Author: amilbourne

pandas/_libs/testing.pyx

@@ -65,7 +65,7 @@ cpdef assert_dict_equal(a, b, bint compare_keys=True):
 cpdef assert_almost_equal(a, b,
                           check_less_precise=False,
                           bint check_dtype=True,
-                          obj=None, lobj=None, robj=None):
+                          obj=None, lobj=None, robj=None, index=None):
     """
     Check that left and right objects are almost equal.
 
@@ -89,6 +89,9 @@ cpdef assert_almost_equal(a, b,
     robj : str, default None
         Specify right object name being compared, internally used to show
         appropriate assertion message
+    index : str, default None
+        Specify shared index of objects being compared, internally used to
+        show appropriate assertion message
     """
     cdef:
         int decimal
@@ -171,7 +174,7 @@ cpdef assert_almost_equal(a, b,
             from pandas._testing import raise_assert_detail
             msg = (f"{obj} values are different "
                    f"({np.round(diff * 100.0 / na, 5)} %)")
-            raise_assert_detail(obj, msg, lobj, robj)
+            raise_assert_detail(obj, msg, lobj, robj, index=index)
 
         return True
 

pandas/_testing.py

@@ -904,9 +904,16 @@ def assert_timedelta_array_equal(left, right, obj="TimedeltaArray"):
     assert_attr_equal("freq", left, right, obj=obj)
 
 
-def raise_assert_detail(obj, message, left, right, diff=None):
+def raise_assert_detail(obj, message, left, right, diff=None, index=None):
     __tracebackhide__ = True
 
+    msg = f"""{obj} are different
+
+{message}"""
+
+    if isinstance(index, np.ndarray):
+        msg += f"\n[index]: {pprint_thing(index)}"
+
     if isinstance(left, np.ndarray):
         left = pprint_thing(left)
     elif is_categorical_dtype(left):
@@ -917,9 +924,10 @@ def raise_assert_detail(obj, message, left, right, diff=None):
     elif is_categorical_dtype(right):
         right = repr(right)
 
-    msg = f"""{obj} are different
+    if isinstance(index, np.ndarray):
+        index = pprint_thing(index)
 
-{message}
+    msg += f"""
 [left]:  {left}
 [right]: {right}"""
 
@@ -937,6 +945,7 @@ def assert_numpy_array_equal(
     err_msg=None,
     check_same=None,
     obj="numpy array",
+    index=None,
 ):
     """
     Check that 'np.ndarray' is equivalent.
@@ -956,6 +965,8 @@ def assert_numpy_array_equal(
     obj : str, default 'numpy array'
         Specify object name being compared, internally used to show appropriate
         assertion message.
+    index : numpy.ndarray
+        optional index (shared by both left and right), used in output.
     """
     __tracebackhide__ = True
 
@@ -993,7 +1004,7 @@ def _raise(left, right, err_msg):
 
             diff = diff * 100.0 / left.size
             msg = f"{obj} values are different ({np.round(diff, 5)} %)"
-            raise_assert_detail(obj, msg, left, right)
+            raise_assert_detail(obj, msg, left, right, index=index)
 
         raise AssertionError(err_msg)
 
@@ -1156,6 +1167,7 @@ def assert_series_equal(
             right._internal_get_values(),
             check_dtype=check_dtype,
             obj=str(obj),
+            index=left.index._internal_get_values(),
         )
     elif check_datetimelike_compat:
         # we want to check only if we have compat dtypes
@@ -1198,6 +1210,7 @@ def assert_series_equal(
             check_less_precise=check_less_precise,
             check_dtype=check_dtype,
             obj=str(obj),
+            index=left.index._internal_get_values(),
         )
 
     # metadata comparison

pandas/tests/util/test_assert_frame_equal.py

@@ -177,6 +177,7 @@ def test_frame_equal_block_mismatch(by_blocks_fixture, obj_fixture):
     msg = f"""{obj}\\.iloc\\[:, 1\\] \\(column name="B"\\) are different
 
 {obj}\\.iloc\\[:, 1\\] \\(column name="B"\\) values are different \\(33\\.33333 %\\)
+\\[index\\]: \\[0, 1, 2\\]
 \\[left\\]:  \\[4, 5, 6\\]
 \\[right\\]: \\[4, 5, 7\\]"""
 
@@ -196,6 +197,7 @@ def test_frame_equal_block_mismatch(by_blocks_fixture, obj_fixture):
             """{obj}\\.iloc\\[:, 1\\] \\(column name="E"\\) are different
 
 {obj}\\.iloc\\[:, 1\\] \\(column name="E"\\) values are different \\(33\\.33333 %\\)
+\\[index\\]: \\[0, 1, 2\\]
 \\[left\\]:  \\[é, è, ë\\]
 \\[right\\]: \\[é, è, e̊\\]""",
         ),
@@ -205,6 +207,7 @@ def test_frame_equal_block_mismatch(by_blocks_fixture, obj_fixture):
             """{obj}\\.iloc\\[:, 0\\] \\(column name="A"\\) are different
 
 {obj}\\.iloc\\[:, 0\\] \\(column name="A"\\) values are different \\(100\\.0 %\\)
+\\[index\\]: \\[0, 1, 2\\]
 \\[left\\]:  \\[á, à, ä\\]
 \\[right\\]: \\[a, a, a\\]""",
         ),

pandas/tests/util/test_assert_series_equal.py

@@ -162,12 +162,14 @@ def test_series_equal_length_mismatch(check_less_precise):
 
     with pytest.raises(AssertionError, match=msg):
         tm.assert_series_equal(s1, s2, check_less_precise=check_less_precise)
+        print("No Exception")
 
 
 def test_series_equal_values_mismatch(check_less_precise):
     msg = """Series are different
 
 Series values are different \\(33\\.33333 %\\)
+\\[index\\]: \\[0, 1, 2\\]
 \\[left\\]:  \\[1, 2, 3\\]
 \\[right\\]: \\[1, 2, 4\\]"""