NPO-Accounting/conservancy_beancount Changeset - 7301bfc099a0

Changeset - 7301bfc099a0

Parent rev.

Child rev.

[Not reviewed]

0 2 0

Brett Smith - 4 years ago 2020-06-03 22:51:44
brettcsmith@brettcsmith.org

accrual: Add AccrualPostings.make_consistent() method.

This will help the aging report better render dirty data.

2 files changed with 83 insertions and 1 deletions:

conservancy_beancount/reports/accrual.py

tests/test_reports_accrual.py

0 comments (0 inline, 0 general)

conservancy_beancount/reports/accrual.py

➞

Show inline comments

@@ ... / @@ -148,25 +148,24 @@ class AccrualPostings(core.RelatedPostings): @@
         def meta_getter(post: data.Posting) -> MetaValue:
             return post.meta.get(key)
         return meta_getter
     _FIELDS: Dict[str, Callable[[data.Posting], MetaValue]] = {
         'account': operator.attrgetter('account'),
         'contract': _meta_getter('contract'),
         'cost': operator.attrgetter('cost'),
         'entity': _meta_getter('entity'),
         'invoice': _meta_getter('invoice'),
         'purchase_order': _meta_getter('purchase-order'),
+    }
     _INVOICE_COUNTER: Dict[str, int] = collections.defaultdict(int)
     INCONSISTENT = Sentinel()
     __slots__ = (
         'accrual_type',
         'account',
         'accounts',
         'contract',
         'contracts',
         'cost',
         'costs',
         'entity',
         'entitys',
         'entities',
@@ ... / @@ -193,24 +192,44 @@ class AccrualPostings(core.RelatedPostings): @@
             if len(values) == 1:
                 one_value = next(iter(values))
             else:
                 one_value = self.INCONSISTENT
             setattr(self, name, one_value)
         # Correct spelling = bug prevention for future users of this class.
         self.entities = self.entitys
         if self.account is self.INCONSISTENT:
             self.accrual_type: Optional[AccrualAccount] = None
         else:
             self.accrual_type = AccrualAccount.classify(self)
     def make_consistent(self) -> Iterator[Tuple[MetaValue, 'AccrualPostings']]:
         account_ok = isinstance(self.account, str)
         # `'/' in self.invoice` is just our heuristic to ensure that the
         # invoice metadata is "unique enough," and not just a placeholder
         # value like "FIXME". It can be refined if needed.
         invoice_ok = isinstance(self.invoice, str) and '/' in self.invoice
         if account_ok and invoice_ok:
             yield (self.invoice, self)
             return
         groups = collections.defaultdict(list)
         for post in self:
             if invoice_ok:
                 key = f'{self.invoice} {post.account}'
             else:
                 key = f'{post.account} {post.meta.get("entity")} {post.meta.get("invoice")}'
             groups[key].append(post)
         type_self = type(self)
         for group_key, posts in groups.items():
             yield group_key, type_self(posts, _can_own=True)
     def report_inconsistencies(self) -> Iterable[Error]:
         for field_name, get_func in self._FIELDS.items():
             if getattr(self, field_name) is self.INCONSISTENT:
                 for post in self:
                     errmsg = 'inconsistent {} for invoice {}: {}'.format(
                         field_name.replace('_', '-'),
                         self.invoice or "<none>",
                         get_func(post),
+                    )
                     yield Error(post.meta, errmsg, post.meta.txn)

tests/test_reports_accrual.py

➞

Show inline comments

@@ ... / @@ -7,24 +7,25 @@ @@
 # (at your option) any later version.
+#
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU Affero General Public License for more details.
+#
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 import collections
 import copy
 import datetime
 import io
 import itertools
 import logging
 import re
 import pytest
 from . import testutil
 from beancount import loader as bc_loader
 from conservancy_beancount import data
 from conservancy_beancount import rtutil
@@ ... / @@ -340,24 +341,86 @@ def test_consistency_check_cost(): @@
     invoice = 'test-cost-invoice'
     txn = testutil.Transaction(postings=[
         (account, 100, 'EUR', ('1.1251', 'USD'), {'invoice': invoice, 'lineno': 1}),
         (account, -100, 'EUR', ('1.125', 'USD'), {'invoice': invoice, 'lineno': 2}),
     ])
     related = accrual.AccrualPostings(data.Posting.from_txn(txn))
     errors = list(related.report_inconsistencies())
     for post, err in itertools.zip_longest(txn.postings, errors):
         assert err.message == f'inconsistent cost for invoice {invoice}: {post.cost}'
         assert err.entry is txn
         assert err.source.get('lineno') == post.meta['lineno']
 def test_make_consistent_not_needed():
     invoice = 'Invoices/ConsistentDoc.pdf'
     other_meta = {key: f'{key}.pdf' for key in CONSISTENT_METADATA}
     # We intentionally make inconsistencies in "minor" metadata that shouldn't
     # split out the group.
     txn = testutil.Transaction(postings=[
         (ACCOUNTS[0], 20, {**other_meta, 'invoice': invoice}),
         (ACCOUNTS[0], 25, {'invoice': invoice}),
     ])
     related = accrual.AccrualPostings(data.Posting.from_txn(txn))
     consistent = related.make_consistent()
     actual_key, actual_postings = next(consistent)
     assert actual_key == invoice
     assert actual_postings is related
     assert next(consistent, None) is None
 @pytest.mark.parametrize('acct_name,invoice,day', testutil.combine_values(
     ACCOUNTS,
     ['FIXME', '', None, *testutil.NON_STRING_METADATA_VALUES],
     itertools.count(1),
 ))
 def test_make_consistent_bad_invoice(acct_name, invoice, day):
     txn = testutil.Transaction(date=datetime.date(2019, 1, day), postings=[
         (acct_name, index * 10, {'invoice': invoice})
         for index in range(1, 4)
     ])
     related = accrual.AccrualPostings(data.Posting.from_txn(txn))
     consistent = dict(related.make_consistent())
     assert len(consistent) == 1
     actual = consistent.get(f'{acct_name} None {invoice}')
     assert actual
     assert len(actual) == 3
     for act_post, exp_post in zip(actual, txn.postings):
         assert act_post.units == exp_post.units
         assert act_post.meta.get('invoice') == invoice
 def test_make_consistent_across_accounts():
     invoice = 'Invoices/CrossAccount.pdf'
     txn = testutil.Transaction(date=datetime.date(2019, 2, 1), postings=[
         (acct_name, 100, {'invoice': invoice})
         for acct_name in ACCOUNTS
     ])
     related = accrual.AccrualPostings(data.Posting.from_txn(txn))
     consistent = dict(related.make_consistent())
     assert len(consistent) == len(ACCOUNTS)
     for acct_name in ACCOUNTS:
         actual = consistent[f'{invoice} {acct_name}']
         assert len(actual) == 1
         assert actual[0].account == acct_name
 def test_make_consistent_both_invoice_and_account():
     txn = testutil.Transaction(date=datetime.date(2019, 2, 2), postings=[
         (acct_name, 150) for acct_name in ACCOUNTS
     ])
     related = accrual.AccrualPostings(data.Posting.from_txn(txn))
     consistent = dict(related.make_consistent())
     assert len(consistent) == len(ACCOUNTS)
     for acct_name in ACCOUNTS:
         actual = consistent[f'{acct_name} None None']
         assert len(actual) == 1
         assert actual[0].account == acct_name
 def check_output(output, expect_patterns):
     output.seek(0)
     testutil.check_lines_match(iter(output), expect_patterns)
 def run_outgoing(invoice, postings, rt_client=None):
     if rt_client is None:
         rt_client = RTClient()
     if not isinstance(postings, core.RelatedPostings):
         postings = accruals_by_meta(postings, invoice, wrap_type=accrual.AccrualPostings)
     output = io.StringIO()
     report = accrual.OutgoingReport(rt_client, output)
     report.run({invoice: postings})

0 comments (0 inline, 0 general)