NPO-Accounting/conservancy_beancount Changeset - 4cba2b2681ac

Changeset - 4cba2b2681ac

Parent rev.

Child rev.

[Not reviewed]

0 2 0

Brett Smith - 4 years ago 2020-06-04 02:20:37
brettcsmith@brettcsmith.org

reports: Balance has built-in tolerance for zero comparisons.

2 files changed with 26 insertions and 8 deletions:

conservancy_beancount/reports/core.py

tests/test_reports_balance.py

0 comments (0 inline, 0 general)

conservancy_beancount/reports/core.py

➞

Show inline comments

@@ ... / @@ -77,16 +77,23 @@ ST = TypeVar('ST') @@
 class Balance(Mapping[str, data.Amount]):
     """A collection of amounts mapped by currency
     Each key is a Beancount currency string, and each value represents the
     balance in that currency.
     """
     __slots__ = ('_currency_map',)
     __slots__ = ('_currency_map', 'tolerance')
     TOLERANCE = Decimal('0.01')
     def __init__(self, source: Iterable[data.Amount]=()) -> None:
     def __init__(self,
                  source: Iterable[data.Amount]=(),
                  tolerance: Optional[Decimal]=None,
     ) -> None:
         if tolerance is None:
             tolerance = self.TOLERANCE
         self._currency_map = {amount.currency: amount for amount in source}
         self.tolerance = tolerance
     def _add_amount(self,
                     currency_map: MutableMapping[str, data.Amount],
                     amount: data.Amount,
     ) -> None:
         code = amount.currency
@@ ... / @@ -144,25 +151,30 @@ class Balance(Mapping[str, data.Amount]): @@
     def _all_amounts(self,
                      op_func: Callable[[DecimalCompat, DecimalCompat], bool],
                      operand: DecimalCompat,
     ) -> bool:
         return all(op_func(amt.number, operand) for amt in self.values())
     @staticmethod
     def within_tolerance(dec: DecimalCompat, tolerance: DecimalCompat) -> bool:
         dec = cast(Decimal, dec)
         return abs(dec) < tolerance
     def eq_zero(self) -> bool:
         """Returns true if all amounts in the balance == 0."""
         return self._all_amounts(operator.eq, 0)
         """Returns true if all amounts in the balance == 0, within tolerance."""
         return self._all_amounts(self.within_tolerance, self.tolerance)
     is_zero = eq_zero
     def ge_zero(self) -> bool:
         """Returns true if all amounts in the balance >= 0."""
         return self._all_amounts(operator.ge, 0)
         """Returns true if all amounts in the balance >= 0, within tolerance."""
         return self._all_amounts(operator.ge, -self.tolerance)
     def le_zero(self) -> bool:
         """Returns true if all amounts in the balance <= 0."""
         return self._all_amounts(operator.le, 0)
         """Returns true if all amounts in the balance <= 0, within tolerance."""
         return self._all_amounts(operator.le, self.tolerance)
     def format(self,
                fmt: Optional[str]='#,#00.00 ¤¤',
                sep: str=', ',
                empty: str="Zero balance",
     ) -> str:

tests/test_reports_balance.py

➞

Show inline comments

@@ ... / @@ -89,12 +89,14 @@ def test_mixed_balance(): @@
     ({'EUR': -10}, False),
     ({'USD': -10, 'EUR': -20}, False),
     ({'USD': 10, 'EUR': -20}, False),
     ({'JPY': 10}, False),
     ({'JPY': 10, 'BRL': 0}, False),
     ({'JPY': 10, 'BRL': 20}, False),
     ({'USD': '0.00015'}, True),
     ({'EUR': '-0.00052'}, True),
 ])
 def test_eq_zero(mapping, expected):
     balance = core.Balance(amounts_from_map(mapping))
     assert balance.eq_zero() == expected
     assert balance.is_zero() == expected
@@ ... / @@ -105,12 +107,14 @@ def test_eq_zero(mapping, expected): @@
     ({'EUR': -10}, False),
     ({'USD': 10, 'EUR': -20}, False),
     ({'USD': -10, 'EUR': -20}, False),
     ({'JPY': 10}, True),
     ({'JPY': 10, 'BRL': 0}, True),
     ({'JPY': 10, 'BRL': 20}, True),
     ({'USD': '0.00015'}, True),
     ({'EUR': '-0.00052'}, True),
 ])
 def test_ge_zero(mapping, expected):
     balance = core.Balance(amounts_from_map(mapping))
     assert balance.ge_zero() == expected
 @pytest.mark.parametrize('mapping,expected', [
@@ ... / @@ -120,12 +124,14 @@ def test_ge_zero(mapping, expected): @@
     ({'EUR': -10}, True),
     ({'USD': 10, 'EUR': -20}, False),
     ({'USD': -10, 'EUR': -20}, True),
     ({'JPY': 10}, False),
     ({'JPY': 10, 'BRL': 0}, False),
     ({'JPY': 10, 'BRL': 20}, False),
     ({'USD': '0.00015'}, True),
     ({'EUR': '-0.00052'}, True),
 ])
 def test_le_zero(mapping, expected):
     balance = core.Balance(amounts_from_map(mapping))
     assert balance.le_zero() == expected
 @pytest.mark.parametrize('mapping', [

0 comments (0 inline, 0 general)