Replaced all assert_almost_equals

Author: Aryan Chowdhury

tests/test_financial.py

@@ -8,13 +8,20 @@
 from numpy.testing import (
     assert_,
     assert_allclose,
-    assert_almost_equal,
     assert_equal,
     assert_raises,
 )
 
 import numpy_financial as npf
 
+def assert_decimal_close(actual, expected, tol=Decimal("1e-7")):
+    # Check if both actual and expected are iterable (like arrays)
+    if hasattr(actual, "__iter__") and hasattr(expected, "__iter__"):
+        for a, e in zip(actual, expected):
+            assert abs(a - e) <= tol
+    else:
+        # For single value comparisons
+        assert abs(actual - expected) <= tol
 
 class TestFinancial(object):
     def test_when(self):
@@ -91,7 +98,7 @@ def test_decimal_with_when(self):
 
 class TestPV:
     def test_pv(self):
-        assert_almost_equal(npf.pv(0.07, 20, 12000, 0), -127128.17, 2)
+        assert_allclose(npf.pv(0.07, 20, 12000, 0), -127128.17, rtol=1e-2)
 
     def test_pv_decimal(self):
         assert_equal(npf.pv(Decimal('0.07'), Decimal('20'), Decimal('12000'),
@@ -101,7 +108,7 @@ def test_pv_decimal(self):
 
 class TestRate:
     def test_rate(self):
-        assert_almost_equal(npf.rate(10, 0, -3500, 10000), 0.1107, 4)
+        assert_allclose(npf.rate(10, 0, -3500, 10000), 0.1107, rtol=1e-4)
 
     @pytest.mark.parametrize('number_type', [Decimal, float])
     @pytest.mark.parametrize('when', [0, 1, 'end', 'begin'])
@@ -163,9 +170,9 @@ def test_rate_maximum_iterations_exception_array(self):
 
 class TestNpv:
     def test_npv(self):
-        assert_almost_equal(
+        assert_allclose(
             npf.npv(0.05, [-15000.0, 1500.0, 2500.0, 3500.0, 4500.0, 6000.0]),
-            122.89, 2)
+            122.89, rtol=1e-2)
 
     def test_npv_decimal(self):
         assert_equal(
@@ -282,7 +289,8 @@ def test_mirr(self, values, finance_rate, reinvest_rate, expected):
 
         if expected:
             decimal_part_len = len(str(expected).split('.')[1])
-            assert_almost_equal(result, expected, decimal_part_len)
+            difference = 10 ** -decimal_part_len
+            assert_allclose(result, expected, atol=difference)
         else:
             assert_(numpy.isnan(result))
 
@@ -319,7 +327,7 @@ def test_mirr_decimal(self, number_type, args, expected):
         )
 
         if expected is not numpy.nan:
-            assert_almost_equal(result, number_type(expected), 15)
+            assert_decimal_close(result, number_type(expected), tol=1e-15)
         else:
             assert numpy.isnan(result)
 
@@ -357,7 +365,7 @@ def test_no_interest(self):
         assert_(npf.nper(0, -100, 1000) == 10)
 
     def test_broadcast(self):
-        assert_almost_equal(npf.nper(0.075, -2000, 0, 100000., [0, 1]),
+        assert_allclose(npf.nper(0.075, -2000, 0, 100000., [0, 1]),
                             [21.5449442, 20.76156441], 4)
 
 
@@ -409,10 +417,10 @@ def test_when_is_begin_decimal(self, when):
             Decimal('0'),
             when
         )
-        assert_almost_equal(
+        assert_decimal_close(
             result,
             Decimal('-302.131703'),  # Computed using Google Sheet's PPMT
-            decimal=5,
+            tol = 1e-5,
         )
 
     @pytest.mark.parametrize('when', [None, Decimal('0'), 'end'])
@@ -425,10 +433,10 @@ def test_when_is_end_decimal(self, when):
             Decimal('0')
         )
         result = npf.ppmt(*args) if when is None else npf.ppmt(*args, when)
-        assert_almost_equal(
+        assert_decimal_close(
             result,
             Decimal('-204.145914'),  # Computed using Google Sheet's PPMT
-            decimal=5,
+            tol=1e-5,
         )
 
     @pytest.mark.parametrize('args', [
@@ -481,7 +489,7 @@ def test_broadcast_decimal(self, when, desired):
             Decimal('0')
         )
         result = npf.ppmt(*args) if when is None else npf.ppmt(*args, when)
-        assert_almost_equal(result, desired, decimal=8)
+        assert_decimal_close(result, desired, tol=1e-8)
 
 
 class TestIpmt:
@@ -532,7 +540,7 @@ def test_when_is_end_decimal(self, when):
             Decimal('0')
         )
         result = npf.ipmt(*args) if when is None else npf.ipmt(*args, when)
-        assert_almost_equal(result, desired, decimal=5)
+        assert_decimal_close(result, desired, tol=1e-5)
 
     @pytest.mark.parametrize('per, desired', [
         (0, numpy.nan),
@@ -576,7 +584,7 @@ def test_decimal_broadcasting(self):
             Decimal('24'),
             Decimal('2000')
         )
-        assert_almost_equal(result, desired, decimal=4)
+        assert_decimal_close(result, desired, tol=1e-4)
 
     def test_0d_inputs(self):
         args = (0.1 / 12, 1, 24, 2000)
@@ -596,10 +604,10 @@ def test_float(self):
         )
 
     def test_decimal(self):
-        assert_almost_equal(
+        assert_decimal_close(
             npf.fv(Decimal('0.075'), Decimal('20'), Decimal('-2000'), 0, 0),
             Decimal('86609.36267304300040536731624'),
-            decimal=10,
+            tol=1e-10,
         )
 
     @pytest.mark.parametrize('when', [1, 'begin'])
@@ -619,7 +627,7 @@ def test_when_is_begin_decimal(self, when):
             Decimal('0'),
             when,
         )
-        assert_almost_equal(result, Decimal('93105.064874'), decimal=5)
+        assert_decimal_close(result, Decimal('93105.064874'), tol=5)
 
     @pytest.mark.parametrize('when', [None, 0, 'end'])
     def test_when_is_end_float(self, when):
@@ -640,7 +648,7 @@ def test_when_is_end_decimal(self, when):
             Decimal('0'),
         )
         result = npf.fv(*args) if when is None else npf.fv(*args, when)
-        assert_almost_equal(result, Decimal('86609.362673'), decimal=5)
+        assert_decimal_close(result, Decimal('86609.362673'), tol=5)
 
     def test_broadcast(self):
         result = npf.fv([[0.1], [0.2]], 5, 100, 0, [0, 1])
@@ -682,13 +690,13 @@ def test_npv_irr_congruence(self):
         ([-5, 10.5, 1, -8, 1], 0.0886),
     ])
     def test_basic_values(self, v, desired):
-        assert_almost_equal(npf.irr(v), desired, decimal=2)
+        assert_allclose(npf.irr(v), desired, rtol=1e-2)
 
     def test_trailing_zeros(self):
-        assert_almost_equal(
+        assert_allclose(
             npf.irr([-5, 10.5, 1, -8, 1, 0, 0, 0]),
             0.0886,
-            decimal=2,
+            rtol=1e-2,
         )
 
     @pytest.mark.parametrize('v', [
@@ -750,12 +758,12 @@ def test_gh_39(self):
             -16259.479306324123, -23596.31953754941, -30933.159768774713,
             -38270.0, -45606.8402312253, -52943.680462450604,
             -60280.520693675906, -67617.36092490121])
-        assert_almost_equal(npf.irr(cashflows), 0.12)
+        assert_allclose(npf.irr(cashflows), 0.12)
 
     def test_gh_44(self):
         # "true" value as calculated by Google sheets
         cf = [-1678.87, 771.96, 1814.05, 3520.30, 3552.95, 3584.99, 4789.91, -1]
-        assert_almost_equal(npf.irr(cf), 1.00426, 4)
+        assert_allclose(npf.irr(cf), 1.00426, rtol=1e-4)
 
     def test_irr_no_real_solution_exception(self):
         # Test that if there is no solution because all the cashflows