NPO-Accounting/conservancy_beancount Changeset - 4f223642ed4b

Changeset - 4f223642ed4b

Parent rev.

Child rev.

[Not reviewed]

0 5 0

Brett Smith - 4 years ago 2020-08-22 16:33:06
brettcsmith@brettcsmith.org

reports: Refactor total styles to BaseODS.

5 files changed with 17 insertions and 20 deletions:

conservancy_beancount/reports/balance_sheet.py

conservancy_beancount/reports/core.py

conservancy_beancount/reports/fund.py

conservancy_beancount/reports/ledger.py

tests/test_reports_spreadsheet.py

0 comments (0 inline, 0 general)

conservancy_beancount/reports/balance_sheet.py

➞

Show inline comments

@@ ... / @@ -227,54 +227,48 @@ class Report(core.BaseODS[Sequence[None], None]): @@
                  *,
                  date_fmt: str='%B %d, %Y',
     ) -> None:
         super().__init__()
         self.balances = balances
         self.period_desc = balances.period_desc
         self.date_fmt = date_fmt
         one_day = datetime.timedelta(days=1)
         date = balances.period_range.stop - one_day
         self.period_name = date.strftime(date_fmt)
         date = balances.prior_range.stop - one_day
         self.opening_name = date.strftime(date_fmt)
         self.last_totals_row = odf.table.TableRow()
     def section_key(self, row: Sequence[None]) -> None:
         raise NotImplementedError("balance_sheet.Report.section_key")
     def init_styles(self) -> None:
         super().init_styles()
         self.style_header = self.merge_styles(self.style_bold, self.style_centertext)
         self.style_huline = self.merge_styles(
             self.style_header,
             self.border_style(core.Border.BOTTOM, '1pt'),
+        )
         self.style_subtotline = self.border_style(core.Border.TOP, '1pt')
         self.style_totline = self.border_style(core.Border.TOP | core.Border.BOTTOM, '1pt')
         self.style_bottomline = self.merge_styles(
             self.style_subtotline,
             self.border_style(core.Border.BOTTOM, '2pt', 'double'),
+        )
     def write_all(self) -> None:
         self.write_financial_position()
         self.write_activities()
         self.write_functional_expenses()
         self.write_cash_flows()
         self.write_trial_balances()
     def walk_classifications(self, cseq: Iterable[data.Account]) \
         -> Iterator[Tuple[str, Optional[data.Account]]]:
         last_prefix: Sequence[str] = []
         for classification in cseq:
             parts = classification.split(':')
             tail = parts.pop()
             space = self.SPACE * len(parts)
             if parts != last_prefix:
                 yield f'{space[len(self.SPACE):]}{parts[-1]}', None
                 last_prefix = parts
             yield f'{space}{tail}', classification
     def walk_classifications_by_account(
             self,
             account: str,
             sort_period: Optional[int]=None,
@@ ... / @@ -366,149 +360,149 @@ class Report(core.BaseODS[Sequence[None], None]): @@
             self.string_cell(text),
             *(self.balance_cell(
                 sum(sum_bals, core.MutableBalance()),
                 stylename=stylename,
             ) for sum_bals in zip(*balances)),
+        )
         return self.last_totals_row
     def write_financial_position(self) -> None:
         self.start_sheet("Financial Position")
         balance_kwargs: Sequence[KWArgs] = [
             {'period': Period.ANY},
             {'period': Period.THRU_PRIOR},
+        ]
         asset_totals = self.write_classifications_by_account('Assets', balance_kwargs)
         self.write_totals_row(
             "Total Assets", asset_totals, stylename=self.style_bottomline,
+        )
         self.add_row()
         self.add_row()
         liabilities = self.write_classifications_by_account('Liabilities', balance_kwargs)
         self.write_totals_row(
-            "Total Liabilities", liabilities, stylename=self.style_totline,
+            "Total Liabilities", liabilities, stylename=self.style_endtotal,
+        )
         self.add_row()
         self.add_row()
         equity_totals = [core.MutableBalance() for _ in balance_kwargs]
         self.add_row(self.string_cell("Net Assets", stylename=self.style_bold))
         self.add_row()
         for fund in [Fund.UNRESTRICTED, Fund.RESTRICTED]:
             preposition = "Without" if fund is Fund.UNRESTRICTED else "With"
             row = self.add_row(self.string_cell(f"{preposition} donor restrictions"))
             for kwargs, total_bal in zip(balance_kwargs, equity_totals):
                 balance = -self.balances.total(account=EQUITY_ACCOUNTS, fund=fund, **kwargs)
                 row.addElement(self.balance_cell(balance))
                 total_bal += balance
         self.write_totals_row(
-            "Total Net Assets", equity_totals, stylename=self.style_subtotline,
+            "Total Net Assets", equity_totals, stylename=self.style_total,
+        )
         self.write_totals_row(
             "Total Liabilities and Net Assets",
             liabilities, equity_totals,
             stylename=self.style_bottomline,
+        )
     def write_activities(self) -> None:
         self.start_sheet(
             "Activities",
             ["Without Donor", "Restrictions"],
             ["With Donor", "Restrictions"],
             totals_prefix=[f"Total {self.period_desc} Ended"],
+        )
         bal_kwargs: Sequence[Dict[str, Any]] = [
             {'period': Period.PERIOD, 'fund': Fund.UNRESTRICTED},
             {'period': Period.PERIOD, 'fund': Fund.RESTRICTED},
             {'period': Period.PERIOD},
             {'period': Period.PRIOR},
+        ]
         self.add_row(self.string_cell("Support and Revenue", stylename=self.style_bold))
         self.add_row()
         income_totals = self.write_classifications_by_account('Income', bal_kwargs)
-        self.write_totals_row("", income_totals, stylename=self.style_subtotline)
+        self.write_totals_row("", income_totals, stylename=self.style_total)
         self.add_row()
         self.add_row(
             self.string_cell("Net Assets released from restrictions:"),
+        )
         released = self.balances.total(
             account=('Expenses', 'Equity'),
             period=Period.PERIOD,
             fund=Fund.RESTRICTED,
+        )
         other_totals = [core.MutableBalance() for _ in bal_kwargs]
         other_totals[0] += released
         other_totals[1] -= released
         self.write_totals_row("Satisfaction of program restrictions", other_totals)
         self.write_totals_row(
             "Total Support and Revenue",
             income_totals, other_totals,
-            stylename=self.style_totline,
+            stylename=self.style_endtotal,
+        )
         period_expenses = core.MutableBalance()
         prior_expenses = core.MutableBalance()
         self.add_row()
         self.add_row(self.string_cell("Expenses", stylename=self.style_bold))
         self.add_row()
         for text, type_value in [
                 ("Program services", 'program'),
                 ("Management and administrative services", 'management'),
                 ("Fundraising", 'fundraising'),
         ]:
             period_bal = self.balances.total(
                 account='Expenses', period=Period.PERIOD, post_type=type_value,
+            )
             prior_bal = self.balances.total(
                 account='Expenses', period=Period.PRIOR, post_type=type_value,
+            )
             self.write_totals_row(text, [
                 period_bal,
                 self.NO_BALANCE,
                 period_bal,
                 prior_bal,
             ], leading_rows=0)
             period_expenses += period_bal
             prior_expenses += prior_bal
         period_bal = self.balances.total(account='Expenses', period=Period.PERIOD)
         if (period_expenses - period_bal).clean_copy(1).is_zero():
             period_bal = period_expenses
         else:
             logger.warning("Period functional expenses do not match total; math in columns B+D is wrong")
         prior_bal = self.balances.total(account='Expenses', period=Period.PRIOR)
         if (prior_expenses - prior_bal).clean_copy(1).is_zero():
             prior_bal = prior_expenses
         else:
             logger.warning("Prior functional expenses do not match total; math in column E is wrong")
         self.write_totals_row("Total Expenses", [
             period_bal,
             self.NO_BALANCE,
             period_bal,
             prior_bal,
-        ], stylename=self.style_totline, leading_rows=0)
+        ], stylename=self.style_endtotal, leading_rows=0)
         other_totals[0] -= period_bal
         other_totals[2] -= period_bal
         other_totals[3] -= prior_bal
         self.write_totals_row("Change in Net Assets", income_totals, other_totals)
         for kwargs in bal_kwargs:
             if kwargs['period'] is Period.PERIOD:
                 kwargs['period'] = Period.THRU_MIDDLE
             else:
                 kwargs['period'] = Period.OPENING
         equity_totals = [
             -self.balances.total(account=EQUITY_ACCOUNTS, **kwargs)
             for kwargs in bal_kwargs
+        ]
         self.write_totals_row("Beginning Net Assets", equity_totals)
         self.write_totals_row(
             "Ending Net Assets",
             income_totals, other_totals, equity_totals,
             stylename=self.style_bottomline,
+        )
     def write_functional_expenses(self) -> None:
         self.start_sheet(
@@ ... / @@ -546,49 +540,49 @@ class Report(core.BaseODS[Sequence[None], None]): @@
         equity_totals = [
             -self.balances.total(account=EQUITY_ACCOUNTS, **kwargs)
             for kwargs in bal_kwargs
+        ]
         self.write_totals_row("Change in Net Assets", equity_totals, leading_rows=1)
         self.add_row(self.string_cell(
             "(Increase) decrease in operating assets:",
         ))
         asset_totals = self.write_classifications_by_account(
             'Assets', bal_kwargs, (self.C_CASH,), self.SPACE, norm_func,
+        )
         self.add_row(self.string_cell(
             "Increase (decrease) in operating liabilities:",
         ))
         liabilities = self.write_classifications_by_account(
             'Liabilities', bal_kwargs, (), self.SPACE, norm_func,
+        )
         period_totals = [
             sum(bals, core.MutableBalance())
             for bals in zip(equity_totals, asset_totals, liabilities)
+        ]
         self.write_totals_row(
             "Net cash provided by operating activities",
             period_totals,
-            stylename=self.style_totline,
+            stylename=self.style_endtotal,
+        )
         self.write_totals_row("Net Increase in Cash", period_totals)
         begin_totals = [
             self.balances.total(classification=self.C_CASH, period=period)
             for period in [Period.THRU_MIDDLE, Period.OPENING]
+        ]
         self.write_totals_row("Beginning Cash", begin_totals)
         self.write_totals_row(
             "Ending Cash",
             period_totals, begin_totals,
             stylename=self.style_bottomline,
+        )
     def write_trial_balances(self) -> None:
         self.start_sheet(
             "Trial Balances",
             ["Account Name"],
             ["Classification"],
             ["Balance Beginning", self.balances.period_range.start.strftime(self.date_fmt)],
             totals_prefix=["Change During", f"{self.period_desc} Ending"],
             title_fmt="Chart of Accounts with DRAFT {sheet_name}",
+        )
         # Widen text columns
         col_style = self.column_style(3.5)

conservancy_beancount/reports/core.py

➞

Show inline comments

@@ ... @@
         date_style.addElement(odf.number.Year(style='long'))
         date_style.addElement(odf.number.Text(text='-'))
         date_style.addElement(odf.number.Month(style='long'))
         date_style.addElement(odf.number.Text(text='-'))
         date_style.addElement(odf.number.Day(style='long'))
         self.style_date = self.ensure_child(
             styles,
             odf.style.Style,
             name=f'{date_style.getAttribute("name")}Cell',
             family='table-cell',
             datastylename=date_style,
+        )
         self.style_starttext: odf.style.Style
         self.style_centertext: odf.style.Style
         self.style_endtext: odf.style.Style
         for textalign in ['start', 'center', 'end']:
             aligned_style = self.replace_child(
                 styles, odf.style.Style, name=f'{textalign.title()}Text',
+            )
             aligned_style.setAttribute('family', 'table-cell')
             aligned_style.addElement(odf.style.ParagraphProperties(textalign=textalign))
             setattr(self, f'style_{textalign}text', aligned_style)
         self.style_total = self.border_style(Border.TOP, '1pt')
         self.style_endtotal = self.border_style(Border.TOP | Border.BOTTOM, '1pt')
         self.style_bottomline = self.merge_styles(
             self.style_total,
             self.border_style(Border.BOTTOM, '2pt', 'double'),
+        )
     ### Properties
     def set_common_properties(self,
                               repo: Optional[git.Repo]=None,
                               command: Optional[Sequence[str]]=sys.argv,
     ) -> None:
         if repo is None:
             git_shahex = '<none>'
             git_dirty = True
         else:
             git_shahex = repo.head.commit.hexsha
             git_dirty = repo.is_dirty()
         self.set_custom_property('GitSHA', git_shahex)
         self.set_custom_property('GitDirty', git_dirty, 'boolean')
         if command is not None:
             command_s = ' '.join(shlex.quote(s) for s in command)
             self.set_custom_property('ReportCommand', command_s)
     def set_custom_property(self,
                             name: str,
                             value: Any,
                             valuetype: Optional[str]=None,
     ) -> odf.meta.UserDefined:
         if valuetype is None:

conservancy_beancount/reports/fund.py

➞

Show inline comments

@@ ... / @@ -147,52 +147,49 @@ class ODSReport(core.BaseODS[FundPosts, None]): @@
         self.add_row(self.string_cell(
             f"Fund Report From {self.start_date.isoformat()} To {self.stop_date.isoformat()}",
             stylename=center_bold,
             numbercolumnsspanned=6,
         ))
         self.add_row()
     def end_spreadsheet(self) -> None:
         start_sheet = self.sheet
         self.set_open_sheet(self.sheet)
         self.start_spreadsheet(expanded=False)
         bal_indexes = [0, 1, 2, 4]
         totals = [core.MutableBalance() for _ in bal_indexes]
         threshold = Decimal('.5')
         for fund, source_bals in self.balances.items():
             balances = [source_bals[index] for index in bal_indexes]
             # Incorporate Equity changes to Release from Restrictions.
             # Note that using -= mutates the balance in a way we don't want.
             balances[2] = balances[2] - source_bals[3]
             if (not all(bal.clean_copy(threshold).le_zero() for bal in balances)
                 and fund != UNRESTRICTED_FUND):
                 self.write_balances(fund, balances)
                 for total, bal in zip(totals, balances):
                     total += bal
         self.write_balances('', totals, self.merge_styles(
             self.border_style(core.Border.TOP, '.75pt'),
             self.border_style(core.Border.BOTTOM, '1.5pt', 'double'),
         ))
         self.write_balances('', totals, self.style_bottomline)
         self.document.spreadsheet.childNodes.reverse()
         self.sheet = start_sheet
     def _row_balances(self, accounts_map: AccountsMap) -> Iterator[core.Balance]:
         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, 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:
             if key == 'Expenses':
                 yield balances[key]
             else:
                 yield -balances[key]
         for info_key in INFO_ACCOUNTS:
             for _, balance in core.account_balances(accounts_map, [info_key]):
                 pass
             yield core.normalize_amount_func(info_key)(balance)
     def write_balances(self,
                        fund: str,

conservancy_beancount/reports/ledger.py

➞

Show inline comments

@@ ... / @@ -157,52 +157,48 @@ class LedgerODS(core.BaseODS[data.Posting, None]): @@
                     if not account_roots_map:
                         raise ValueError("unknown account name or classification", acct_spec)
                     for root_part, accounts in account_roots_map.items():
                         start_count = min(account.count_parts() for account in accounts)
                         for count in range(start_count, 1, -1):
                             target = accounts[0].root_part(count)
                             if all(acct.root_part(count) == target for acct in accounts):
                                 self._require_sheet(target)
                                 break
                         else:
                             self._require_sheet(root_part)
     def _require_sheet(self, new_sheet: str) -> None:
         for index, sheet in enumerate(self.required_sheet_names):
             if new_sheet == sheet:
                 break
             elif new_sheet.startswith(sheet):
                 self.required_sheet_names.insert(index, new_sheet)
                 break
         else:
             self.required_sheet_names.append(new_sheet)
     def init_styles(self) -> None:
         super().init_styles()
         self.style_bottomline = self.merge_styles(
             self.border_style(core.Border.TOP, '1pt'),
             self.border_style(core.Border.BOTTOM, '2pt', 'double'),
+        )
         self.amount_column = self.column_style(1.2)
         self.default_column = self.column_style(1.5)
         self.column_styles: Mapping[str, Union[str, odf.style.Style]] = {
             'Account': self.column_style(2),  # for TransactionODS
             'Date': '',
             'Description': self.column_style(2),
             'Original Amount': self.amount_column,
             'Booked Amount': self.amount_column,
             data.Metadata.human_name('project'): self.amount_column,
             data.Metadata.human_name('rt-id'): self.amount_column,
+        }
     @classmethod
     def _group_tally(
             cls,
             tally_by_account: PostTally,
             key: Callable[[data.Account], Optional[str]],
     ) -> Dict[str, PostTally]:
         retval: Dict[str, PostTally] = collections.defaultdict(list)
         for count, account in tally_by_account:
             item_key = key(account)
             if item_key is not None:
                 retval[item_key].append((count, account))
         return retval

tests/test_reports_spreadsheet.py

➞

Show inline comments

@@ ... / @@ -284,48 +284,51 @@ def test_ods_currency_style(ods_writer, currency_code): @@
             ods_writer.document.styles,
             odf.number.CurrencyStyle,
             name=mapping.getAttribute('applystylename'),
         ))
 def test_ods_currency_style_caches(ods_writer):
     expected = ods_writer.currency_style('USD')
     _ = ods_writer.currency_style('EUR')
     actual = ods_writer.currency_style('USD')
     assert actual is expected
 def test_ods_currency_style_cache_considers_properties(ods_writer):
     bold_text = odf.style.TextProperties(fontweight='bold')
     plain = ods_writer.currency_style('USD')
     bold = ods_writer.currency_style('USD', positive_properties=bold_text)
     assert plain is not bold
     assert plain.getAttribute('name') != bold.getAttribute('name')
     assert plain.getAttribute('datastylename') != bold.getAttribute('datastylename')
 @pytest.mark.parametrize('attr_name,child_type,checked_attr', [
     ('style_bold', odf.style.TextProperties, 'fontweight'),
     ('style_centertext', odf.style.ParagraphProperties, 'textalign'),
     ('style_endtext', odf.style.ParagraphProperties, 'textalign'),
     ('style_starttext', odf.style.ParagraphProperties, 'textalign'),
     ('style_total', odf.style.TableCellProperties, 'bordertop'),
     ('style_endtotal', odf.style.TableCellProperties, 'borderbottom'),
     ('style_bottomline', odf.style.TableCellProperties, 'borderbottom'),
 ])
 def test_ods_writer_style(ods_writer, attr_name, child_type, checked_attr):
     root = ods_writer.document.styles
     style = getattr(ods_writer, attr_name)
     actual = get_child(root, odf.style.Style, name=style.getAttribute('name'))
     assert actual is style
     child = get_child(actual, child_type)
     assert child.getAttribute(checked_attr)
 @pytest.mark.parametrize('edges,width,style,color', [
     (core.Border.TOP,
      '5px', 'solid', '#ff0000'),
     (core.Border.RIGHT | core.Border.LEFT,
      '2pt', 'dashed', '#00ff00'),
     (core.Border.BOTTOM | core.Border.RIGHT | core.Border.LEFT,
      '1em', 'dotted', '#0000ff'),
     (core.Border.TOP | core.Border.BOTTOM | core.Border.RIGHT | core.Border.LEFT,
      '1cm', 'thick', '#aaaaaa'),
 ])
 def test_ods_writer_border_style(ods_writer, edges, width, style, color):
     actual = ods_writer.border_style(edges, width, style, color)
     props, = actual.childNodes
     attr_s = f'{width} {style} {color}'
     for edge_exp, edge_name in enumerate(['top', 'right', 'bottom', 'left']):

0 comments (0 inline, 0 general)