NPO-Accounting/conservancy_beancount Changeset - 81d216f28246

Changeset - 81d216f28246

Parent rev.

Child rev.

[Not reviewed]

0 2 0

Brett Smith - 4 years ago 2020-05-28 13:01:00
brettcsmith@brettcsmith.org

reports: Add RelatedPostings.balance_at_cost() method.

This makes it easy to get results similar to `ledger -V`.

2 files changed with 65 insertions and 0 deletions:

conservancy_beancount/reports/core.py

tests/test_reports_related_postings.py

0 comments (0 inline, 0 general)

conservancy_beancount/reports/core.py

➞

Show inline comments

@@ ... / @@ -178,29 +178,39 @@ class RelatedPostings(Sequence[data.Posting]): @@
         for post in self:
             try:
                 retval.update(post.meta.get_links(key))
             except TypeError:
                 pass
         return retval
     def clear(self) -> None:
         self._postings.clear()
     def iter_with_balance(self) -> Iterator[Tuple[data.Posting, Balance]]:
         balance = MutableBalance()
         for post in self:
             balance.add_amount(post.units)
             yield post, balance
     def balance(self) -> Balance:
         for _, balance in self.iter_with_balance():
             pass
         try:
             return balance
         except NameError:
             return Balance()
     def balance_at_cost(self) -> Balance:
         balance = MutableBalance()
         for post in self:
             if post.cost is None:
                 balance.add_amount(post.units)
             else:
                 number = post.units.number * post.cost.number
                 balance.add_amount(data.Amount(number, post.cost.currency))
         return balance
     def meta_values(self,
                     key: MetaKey,
                     default: Optional[MetaValue]=None,
     ) -> Set[Optional[MetaValue]]:
         return {post.meta.get(key, default) for post in self}

tests/test_reports_related_postings.py

➞

Show inline comments

@@ ... / @@ -114,48 +114,103 @@ def check_iter_with_balance(entries): @@
     for post in expect_posts:
         number, currency = post.units
         balance_tally[currency] += number
         expect_balances.append(testutil.balance_map(balance_tally.items()))
         related.add(post)
     for (post, balance), exp_post, exp_balance in zip(
             related.iter_with_balance(),
             expect_posts,
             expect_balances,
     ):
         assert post is exp_post
         assert balance == exp_balance
     assert post is expect_posts[-1]
     assert related.balance() == expect_balances[-1]
 def test_iter_with_balance_empty():
     assert not list(core.RelatedPostings().iter_with_balance())
 def test_iter_with_balance_credit_card(credit_card_cycle):
     check_iter_with_balance(credit_card_cycle)
 def test_iter_with_balance_two_acccruals(two_accruals_three_payments):
     check_iter_with_balance(two_accruals_three_payments)
 def test_balance_at_cost_mixed():
     txn = testutil.Transaction(postings=[
         ('Expenses:Other', '22'),
         ('Expenses:Other', '30', 'EUR', ('1.1',)),
         ('Expenses:Other', '40', 'EUR'),
         ('Expenses:Other', '50', 'USD', ('1.1', 'EUR')),
     ])
     related = core.RelatedPostings(data.Posting.from_txn(txn))
     balance = related.balance_at_cost()
     amounts = set(balance.values())
     assert amounts == {testutil.Amount(55, 'USD'), testutil.Amount(95, 'EUR')}
 def test_balance_at_single_currency_cost():
     txn = testutil.Transaction(postings=[
         ('Expenses:Other', '22'),
         ('Expenses:Other', '30', 'EUR', ('1.1',)),
         ('Expenses:Other', '40', 'GBP', ('1.1',)),
     ])
     related = core.RelatedPostings(data.Posting.from_txn(txn))
     balance = related.balance_at_cost()
     amounts = set(balance.values())
     assert amounts == {testutil.Amount(99)}
 def test_balance_at_cost_zeroed_out():
     txn = testutil.Transaction(postings=[
         ('Income:Other', '-22'),
         ('Assets:Receivable:Accounts', '20', 'EUR', ('1.1',)),
     ])
     related = core.RelatedPostings(data.Posting.from_txn(txn))
     balance = related.balance_at_cost()
     assert balance.is_zero()
 def test_balance_at_cost_singleton():
     txn = testutil.Transaction(postings=[
         ('Assets:Receivable:Accounts', '20', 'EUR', ('1.1',)),
     ])
     related = core.RelatedPostings(data.Posting.from_txn(txn))
     balance = related.balance_at_cost()
     amounts = set(balance.values())
     assert amounts == {testutil.Amount(22)}
 def test_balance_at_cost_singleton_without_cost():
     txn = testutil.Transaction(postings=[
         ('Assets:Receivable:Accounts', '20'),
     ])
     related = core.RelatedPostings(data.Posting.from_txn(txn))
     balance = related.balance_at_cost()
     amounts = set(balance.values())
     assert amounts == {testutil.Amount(20)}
 def test_balance_at_cost_empty():
     related = core.RelatedPostings()
     balance = related.balance_at_cost()
     assert balance.is_zero()
 def test_meta_values_empty():
     related = core.RelatedPostings()
     assert related.meta_values('key') == set()
 def test_meta_values_no_match():
     related = core.RelatedPostings()
     related.add(testutil.Posting('Income:Donations', -1, metakey='metavalue'))
     assert related.meta_values('key') == {None}
 def test_meta_values_no_match_default_given():
     related = core.RelatedPostings()
     related.add(testutil.Posting('Income:Donations', -1, metakey='metavalue'))
     assert related.meta_values('key', '') == {''}
 def test_meta_values_one_match():
     related = core.RelatedPostings()
     related.add(testutil.Posting('Income:Donations', -1, key='metavalue'))
     assert related.meta_values('key') == {'metavalue'}
 def test_meta_values_some_match():
     related = core.RelatedPostings()
     related.add(testutil.Posting('Income:Donations', -1, key='1'))
     related.add(testutil.Posting('Income:Donations', -2, metakey='2'))
     assert related.meta_values('key') == {'1', None}

0 comments (0 inline, 0 general)