NPO-Accounting/conservancy_beancount Changeset - 58954aab235a

Changeset - 58954aab235a

Parent rev.

Child rev.

[Not reviewed]

0 2 0

Brett Smith - 4 years ago 2020-08-22 13:49:19
brettcsmith@brettcsmith.org

fund: Text output readability improvements.

Make it look more like the spreadsheets:

* Don't normalize Expenses negative.

* Consistent account order: Income, then Expenses, then Equity.

* Include a bottom line divider for each fund.

2 files changed with 21 insertions and 11 deletions:

conservancy_beancount/reports/fund.py

tests/test_reports_fund.py

0 comments (0 inline, 0 general)

conservancy_beancount/reports/fund.py

➞

Show inline comments

@@ ... / @@ -79,13 +79,13 @@ from .. import cliutil @@
 from .. import config as configmod
 from .. import data
 AccountsMap = Mapping[data.Account, core.PeriodPostings]
 FundPosts = Tuple[MetaValue, AccountsMap]
-EQUITY_ACCOUNTS = ['Equity', 'Income', 'Expenses']
+EQUITY_ACCOUNTS = ['Income', 'Expenses', 'Equity']
 INFO_ACCOUNTS = [
     'Assets:Receivable',
     'Assets:Prepaid',
     'Liabilities:UnearnedIncome',
     'Liabilities:Payable',
+]
@@ ... / @@ -103,13 +103,13 @@ class ODSReport(core.BaseODS[FundPosts, None]): @@
         return None
     def start_spreadsheet(self, *, expanded: bool=True) -> None:
         headers = [["Fund"], ["Balance as of", self.start_date.isoformat()]]
         if expanded:
             sheet_name = "With Breakdowns"
-            headers += [["Income"], ["Expenses"], ["Equity"]]
+            headers.extend([acct] for acct in EQUITY_ACCOUNTS)
         else:
             sheet_name = "Fund Report"
             headers += [["Additions"], ["Releases from", "Restrictions"]]
         headers.append(["Balance as of", self.stop_date.isoformat()])
         if expanded:
             headers += [
@@ ... / @@ -173,16 +173,15 @@ class ODSReport(core.BaseODS[FundPosts, None]): @@
             self.border_style(core.Border.BOTTOM, '1.5pt', 'double'),
         ))
         self.document.spreadsheet.childNodes.reverse()
         self.sheet = start_sheet
     def _row_balances(self, accounts_map: AccountsMap) -> Iterator[core.Balance]:
         acct_order = ['Income', 'Expenses', 'Equity']
         key_order = [core.OPENING_BALANCE_NAME, *acct_order, core.ENDING_BALANCE_NAME]
         key_order = [core.OPENING_BALANCE_NAME, *EQUITY_ACCOUNTS, core.ENDING_BALANCE_NAME]
         balances: Dict[str, core.Balance] = {key: core.MutableBalance() for key in key_order}
-        for acct_s, balance in core.account_balances(accounts_map, acct_order):
+        for acct_s, balance in core.account_balances(accounts_map, EQUITY_ACCOUNTS):
             if acct_s in balances:
                 balances[acct_s] = balance
             else:
                 acct_root, _, _ = acct_s.partition(':')
                 balances[acct_root] += balance
         for key in key_order:
@@ ... / @@ -239,13 +238,15 @@ class TextReport: @@
         total_fmt = f'{fund} balance as of {{}}'
         for acct_s, balance in core.account_balances(account_map, EQUITY_ACCOUNTS):
             if acct_s is core.OPENING_BALANCE_NAME:
                 acct_s = total_fmt.format(self.start_date.isoformat())
             elif acct_s is core.ENDING_BALANCE_NAME:
                 acct_s = total_fmt.format(self.stop_date.isoformat())
             yield acct_s, (-balance).format(None, sep='\0').split('\0')
             if not acct_s.startswith('Expenses:'):
                 balance = -balance
             yield acct_s, balance.format(None, sep='\0').split('\0')
         for _, account in core.sort_and_filter_accounts(account_map, INFO_ACCOUNTS):
             balance = account_map[account].stop_bal
             if not balance.is_zero():
                 balance = core.normalize_amount_func(account)(balance)
                 yield account, balance.format(None, sep='\0').split('\0')
@@ ... / @@ -259,20 +260,25 @@ class TextReport: @@
         bal_width = max(len(s) for _, bal_s in output for s in bal_s)
         bal_width = max(bal_width, 8)
         line_fmt = f'{{:>{acct_width}}}  {{:>{bal_width}}}'
         print(line_fmt.replace('{:>', '{:^').format("ACCOUNT", "BALANCE"),
               file=self.out_file)
         fund_start = f' balance as of {self.start_date.isoformat()}'
         fund_end = f' balance as of {self.stop_date.isoformat()}'
         for acct_s, bal_seq in output:
             if acct_s.endswith(fund_start):
                 print(line_fmt.format('―' * acct_width, '―' * bal_width),
             is_end_bal = acct_s.endswith(fund_end)
             if is_end_bal or acct_s.endswith(fund_start):
                 print(line_fmt.format('─' * acct_width, '─' * bal_width),
                       file=self.out_file)
             bal_iter = iter(bal_seq)
             print(line_fmt.format(acct_s, next(bal_iter)), file=self.out_file)
             for bal_s in bal_iter:
                 print(line_fmt.format('', bal_s), file=self.out_file)
             if is_end_bal:
                 print(line_fmt.format('═' * acct_width, '═' * bal_width),
                       file=self.out_file)
 class ReportType(enum.Enum):
     TEXT = TextReport
     ODS = ODSReport
     TXT = TEXT

tests/test_reports_fund.py

➞

Show inline comments

@@ ... / @@ -108,17 +108,19 @@ def format_amount(amount, currency='USD'): @@
+    )
 def check_text_balances(actual, expected, *expect_accounts):
     balance = Decimal()
     for expect_account in expect_accounts:
         expect_amount = expected[expect_account]
         balance += expect_amount
         if expect_account.startswith('Expenses:'):
             expect_amount *= -1
         if expect_amount:
             actual_account, actual_amount = next(actual)
             assert actual_account == expect_account
             assert actual_amount == format_amount(expect_amount)
             balance += expect_amount
     return balance
 def check_text_report(output, project, start_date, stop_date):
     _, _, project = project.rpartition('=')
     balance_amount = Decimal(OPENING_BALANCES[project])
     expected = collections.defaultdict(Decimal)
@@ ... @@
     assert open_acct == "{} balance as of {}".format(
         project, start_date.isoformat(),
+    )
     assert open_amt == format_amount(balance_amount)
     balance_amount += check_text_balances(
         actual, expected,
         'Income:Other',
         'Expenses:Other',
         'Equity:Funds:Restricted',
         'Equity:Funds:Unrestricted',
         'Equity:Realized:CurrencyConversion',
         'Income:Other',
         'Expenses:Other',
+    )
     next(actual)
     end_acct, end_amt = next(actual)
     assert end_acct == "{} balance as of {}".format(
         project, stop_date.isoformat(),
+    )
     assert end_amt == format_amount(balance_amount)
     next(actual)
     balance_amount += check_text_balances(
         actual, expected,
         'Assets:Receivable:Accounts',
         'Assets:Prepaid:Expenses',
         'Liabilities:Payable:Accounts',
         'Liabilities:UnearnedIncome',

0 comments (0 inline, 0 general)