Fixing the behavior of assertDictAlmostEqual

al-bus · copybara-github · commit 014aa0aa3e21 · 2025-03-25T15:14:47.000-07:00
PiperOrigin-RevId: 740501314
diff --git a/absl/testing/absltest.py b/absl/testing/absltest.py
@@ -31,6 +31,7 @@
 import io
 import itertools
 import json
+import numbers
 import os
 import random
 import re
@@ -1715,7 +1716,9 @@ def assertDictAlmostEqual(
 
     # Almost equality with preset places and delta.
     def almost_equal_compare(a_value, b_value):
-      if isinstance(a_value, float) or isinstance(b_value, float):
+      if isinstance(a_value, numbers.Number) and isinstance(
+          b_value, numbers.Number
+      ):
         try:
           # assertAlmostEqual should be called with at most one of `places`
           # and `delta`. However, it's okay for assertMappingEqual to pass
@@ -1730,7 +1733,14 @@ def almost_equal_compare(a_value, b_value):
         # pytype: enable=wrong-keyword-args
         except self.failureException as err:
           return False, err
-      return True, None
+        return True, None
+      else:
+        # Fall back to regular equality check if the values are not numbers.
+        try:
+          self.assertEqual(a_value, b_value)
+        except self.failureException as err:
+          return False, err
+        return True, None
 
     if delta is not None and places is not None:
       raise ValueError('specify delta or places not both\n')
diff --git a/absl/testing/tests/absltest_test.py b/absl/testing/tests/absltest_test.py
@@ -624,15 +624,7 @@ def test_assert_set_equal(self):
     self.assertRaises(AssertionError, self.assertSetEqual, set1, set2)
 
   @parameterized.named_parameters(
-      dict(testcase_name='empty', a={}, b={}),
       dict(testcase_name='equal_float', a={'a': 1.01}, b={'a': 1.01}),
-      dict(testcase_name='int_and_float', a={'a': 0}, b={'a': 0.000_000_01}),
-      dict(testcase_name='float_and_int', a={'a': 0.000_000_01}, b={'a': 0}),
-      dict(
-          testcase_name='mixed_elements',
-          a={'a': 'A', 'b': 1, 'c': 0.999_999_99},
-          b={'a': 'A', 'b': 1, 'c': 1},
-      ),
       dict(
           testcase_name='float_artifacts',
           a={'a': 0.15000000000000002},
@@ -644,7 +636,7 @@ def test_assert_set_equal(self):
           b={'a': 1.000_000_01, 'b': 1.999_999_99},
       ),
   )
-  def test_assert_dict_almost_equal(self, a, b):
+  def test_assert_dict_almost_equal_on_floats(self, a, b):
     self.assertDictAlmostEqual(a, b)
 
   @parameterized.named_parameters(
@@ -702,6 +694,42 @@ def test_assert_dict_almost_equal_fails_with_tolerance(
     with self.assertRaises(self.failureException):
       self.assertDictAlmostEqual(a, b, places=places, delta=delta)
 
+  @parameterized.named_parameters(
+      dict(testcase_name='empty', a={}, b={}),
+      dict(testcase_name='int_and_float', a={'a': 0}, b={'a': 0.000_000_01}),
+      dict(testcase_name='float_and_int', a={'a': 1e-8}, b={'a': 0}),
+      dict(testcase_name='float_and_bool', a={'a': 1.0}, b={'a': True}),
+      dict(testcase_name='complex_and_float', a={'a': 1j * 1j}, b={'a': -1.0}),
+      dict(
+          testcase_name='mixed_elements',
+          a={'a': 'A', 'b': 1, 'c': False, 'd': 0.999_999_99, 'e': 1j},
+          b={'a': 'A', 'b': 1, 'c': False, 'd': 1, 'e': 0.999_999_99j},
+      ),
+      dict(testcase_name='list_values', a={'a': [0.1]}, b={'a': [0.1]}),
+      dict(testcase_name='dict_values', a={'a': {'b': 1}}, b={'a': {'b': 1}}),
+  )
+  def test_assert_dict_almost_equal_non_float_comparison_succeeds(self, a, b):
+    self.assertDictAlmostEqual(a, b)
+
+  @parameterized.named_parameters(
+      dict(testcase_name='different_strings', a={'a': 'b'}, b={'a': 'c'}),
+      dict(testcase_name='string_and_float', a={'a': 'b'}, b={'a': 0.1}),
+      dict(testcase_name='complex_and_float', a={'a': 1j}, b={'a': 1.0}),
+      dict(
+          testcase_name='different_bools',
+          a={'a': False},
+          b={'a': True},
+      ),
+      dict(
+          testcase_name='no_recursion',
+          a={'a': {'b': 0}},
+          b={'a': {'b': 1e-8}},
+      ),
+  )
+  def test_assert_dict_almost_equal_non_float_comparison_fails(self, a, b):
+    with self.assertRaises(self.failureException):
+      self.assertDictAlmostEqual(a, b)
+
   def test_assert_dict_almost_equal_assertion_message(self):
     with self.assertRaises(AssertionError) as e:
       self.assertDictAlmostEqual({'a': 0.6}, {'a': 1.0}, delta=0.1)
