Changeset - b7dee6a88a81
Parent rev.
Child rev.
[Not reviewed]
0 1 0
Brett Smith - 4 years ago 2020-08-18 07:27:27
brettcsmith@brettcsmith.org
balance_sheet: Refactor out Report.write_classifications_by_account.
1 file changed with 86 insertions and 159 deletions:
conservancy_beancount/reports/balance_sheet.py
86
159
0 comments (0 inline, 0 general)
conservancy_beancount/reports/balance_sheet.py
➞
Show inline comments
...
 
@@ -21,2 +21,3 @@ import enum
 
import logging
 
import operator
 
import os
...
 
@@ -29,2 +30,3 @@ from typing import (
 
    Any,
 
    Callable,
 
    Collection,
...
 
@@ -59,2 +61,4 @@ logger = logging.getLogger('conservancy_beancount.tools.balance_sheet')
 

			




	
	
	
		
 
KWArgs = Mapping[str, Any]


			




	
	
	
		
 

			




	
	
	
		
 
class Fund(enum.IntFlag):


			




	...
	
		
 
@@ -280,25 +284,41 @@ class Report(core.BaseODS[Sequence[None], None]):


			




	
	
	
		
 

			




	
	
	
		
 
    def write_financial_position(self) -> None:


			




	
	
	
		
 
        self.start_sheet("Financial Position")


			




	
	
	
		
 

			




	
	
	
		
 
        prior_assets = core.MutableBalance()


			




	
	
	
		
 
        period_assets = core.MutableBalance()


			




	
	
	
		
 
        self.add_row(self.string_cell("Assets", stylename=self.style_bold))


			




	
	
	
		
 
        self.add_row()


			




	
	
	
		
 
        for text, classification in self.walk_classifications_by_account('Assets'):


			




	
	
	
		
 
            text_cell = self.string_cell(text)


			




	
	
	
		
 
    def write_classifications_by_account(


			




	
	
	
		
 
            self,


			




	
	
	
		
 
            account: str,


			




	
	
	
		
 
            balance_kwargs: Sequence[KWArgs],


			




	
	
	
		
 
            exclude_classifications: Collection[str]=frozenset(),


			




	
	
	
		
 
            text_prefix: str='',


			




	
	
	
		
 
            norm_func: Optional[Callable[[core.Balance], core.Balance]]=None,


			




	
	
	
		
 
    ) -> Sequence[core.Balance]:


			




	
	
	
		
 
        if norm_func is None:


			




	
	
	
		
 
            norm_func = core.normalize_amount_func(f'{account}:RootsOK')


			




	
	
	
		
 
        assert len(balance_kwargs) + 1 == self.col_count, \


			




	
	
	
		
 
            "called write_classifications with wrong number of balance_kwargs"


			




	
	
	
		
 
        retval = [core.MutableBalance() for _ in balance_kwargs]


			




	
	
	
		
 
        for text, classification in self.walk_classifications_by_account(account):


			




	
	
	
		
 
            text_cell = self.string_cell(text_prefix + text)


			




	
	
	
		
 
            if classification is None:


			




	
	
	
		
 
                if not text[0].isspace():


			




	
	
	
		
 
                    self.add_row()


			




	
	
	
		
 
                self.add_row(text_cell)


			




	
	
	
		
 
            elif classification in exclude_classifications:


			




	
	
	
		
 
                pass


			




	
	
	
		
 
            else:


			




	
	
	
		
 
                period_bal = self.balances.total(classification=classification)


			




	
	
	
		
 
                prior_bal = period_bal - self.balances.total(


			




	
	
	
		
 
                    classification=classification, period=Period.PERIOD,


			




	
	
	
		
 
                )


			




	
	
	
		
 
                self.add_row(


			




	
	
	
		
 
                    text_cell,


			




	
	
	
		
 
                    self.balance_cell(period_bal),


			




	
	
	
		
 
                    self.balance_cell(prior_bal),


			




	
	
	
		
 
                )


			




	
	
	
		
 
                prior_assets += prior_bal


			




	
	
	
		
 
                period_assets += period_bal


			




	
	
	
		
 
                row = self.add_row(text_cell)


			




	
	
	
		
 
                for kwargs, total_bal in zip(balance_kwargs, retval):


			




	
	
	
		
 
                    balance = norm_func(self.balances.total(


			




	
	
	
		
 
                        classification=classification, **kwargs,


			




	
	
	
		
 
                    ))


			




	
	
	
		
 
                    row.addElement(self.balance_cell(balance))


			




	
	
	
		
 
                    total_bal += balance


			




	
	
	
		
 
        return retval


			




	
	
	
		
 

			




	
	
	
		
 
    def write_financial_position(self) -> None:


			




	
	
	
		
 
        self.start_sheet("Financial Position")


			




	
	
	
		
 
        balance_kwargs: Sequence[KWArgs] = [


			




	
	
	
		
 
            {'period': Period.ANY},


			




	
	
	
		
 
            {'period': Period.BEFORE_PERIOD},


			




	
	
	
		
 
        ]


			




	
	
	
		
 

			




	
	
	
		
 
        asset_totals = self.write_classifications_by_account('Assets', balance_kwargs)


			




	
	
	
		
 
        self.add_row()


			




	...
	
		
 
@@ -306,4 +326,4 @@ class Report(core.BaseODS[Sequence[None], None]):


			




	
	
	
		
 
            self.string_cell("Total Assets"),


			




	
	
	
		
 
            self.balance_cell(period_assets, stylename=self.style_bottomline),


			




	
	
	
		
 
            self.balance_cell(prior_assets, stylename=self.style_bottomline),


			




	
	
	
		
 
            *(self.balance_cell(balance, stylename=self.style_bottomline)


			




	
	
	
		
 
              for balance in asset_totals),


			




	
	
	
		
 
        )


			




	...
	
		
 
@@ -312,29 +332,7 @@ class Report(core.BaseODS[Sequence[None], None]):


			




	
	
	
		
 

			




	
	
	
		
 
        prior_liabilities = core.MutableBalance()


			




	
	
	
		
 
        period_liabilities = core.MutableBalance()


			




	
	
	
		
 
        self.add_row(self.string_cell("Liabilities and Net Assets",


			




	
	
	
		
 
                                      stylename=self.style_bold))


			




	
	
	
		
 
        self.add_row()


			




	
	
	
		
 
        self.add_row(self.string_cell("Liabilities", stylename=self.style_bold))


			




	
	
	
		
 
        self.add_row()


			




	
	
	
		
 
        for text, classification in self.walk_classifications_by_account('Liabilities'):


			




	
	
	
		
 
            text_cell = self.string_cell(text)


			




	
	
	
		
 
            if classification is None:


			




	
	
	
		
 
                self.add_row(text_cell)


			




	
	
	
		
 
            else:


			




	
	
	
		
 
                period_bal = -self.balances.total(classification=classification)


			




	
	
	
		
 
                prior_bal = period_bal + self.balances.total(


			




	
	
	
		
 
                    classification=classification, period=Period.PERIOD,


			




	
	
	
		
 
                )


			




	
	
	
		
 
                self.add_row(


			




	
	
	
		
 
                    text_cell,


			




	
	
	
		
 
                    self.balance_cell(period_bal),


			




	
	
	
		
 
                    self.balance_cell(prior_bal),


			




	
	
	
		
 
                )


			




	
	
	
		
 
                prior_liabilities += prior_bal


			




	
	
	
		
 
                period_liabilities += period_bal


			




	
	
	
		
 
        liabilities = self.write_classifications_by_account('Liabilities', balance_kwargs)


			




	
	
	
		
 
        self.add_row(


			




	
	
	
		
 
            self.string_cell("Total Liabilities"),


			




	
	
	
		
 
            self.balance_cell(period_liabilities, stylename=self.style_totline),


			




	
	
	
		
 
            self.balance_cell(prior_liabilities, stylename=self.style_totline),


			




	
	
	
		
 
            *(self.balance_cell(balance, stylename=self.style_totline)


			




	
	
	
		
 
              for balance in liabilities),


			




	
	
	
		
 
        )


			




	...
	
		
 
@@ -343,4 +341,3 @@ class Report(core.BaseODS[Sequence[None], None]):


			




	
	
	
		
 

			




	
	
	
		
 
        prior_net = core.MutableBalance()


			




	
	
	
		
 
        period_net = core.MutableBalance()


			




	
	
	
		
 
        equity_totals = [core.MutableBalance() for _ in balance_kwargs]


			




	
	
	
		
 
        self.add_row(self.string_cell("Net Assets", stylename=self.style_bold))


			




	...
	
		
 
@@ -349,17 +346,11 @@ class Report(core.BaseODS[Sequence[None], None]):


			




	
	
	
		
 
            preposition = "Without" if fund is Fund.UNRESTRICTED else "With"


			




	
	
	
		
 
            period_bal = -self.balances.total(account=EQUITY_ACCOUNTS, fund=fund)


			




	
	
	
		
 
            prior_bal = period_bal + self.balances.total(


			




	
	
	
		
 
                account=EQUITY_ACCOUNTS, fund=fund, period=Period.PERIOD,


			




	
	
	
		
 
            )


			




	
	
	
		
 
            self.add_row(


			




	
	
	
		
 
                self.string_cell(f"{preposition} donor restrictions"),


			




	
	
	
		
 
                self.balance_cell(period_bal),


			




	
	
	
		
 
                self.balance_cell(prior_bal),


			




	
	
	
		
 
            )


			




	
	
	
		
 
            prior_net += prior_bal


			




	
	
	
		
 
            period_net += period_bal


			




	
	
	
		
 
            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.add_row(


			




	
	
	
		
 
            self.string_cell("Total Net Assets"),


			




	
	
	
		
 
            self.balance_cell(period_net, stylename=self.style_subtotline),


			




	
	
	
		
 
            self.balance_cell(prior_net, stylename=self.style_subtotline),


			




	
	
	
		
 
            *(self.balance_cell(balance, stylename=self.style_subtotline)


			




	
	
	
		
 
              for balance in equity_totals),


			




	
	
	
		
 
        )


			




	...
	
		
 
@@ -368,6 +359,4 @@ class Report(core.BaseODS[Sequence[None], None]):


			




	
	
	
		
 
            self.string_cell("Total Liabilities and Net Assets"),


			




	
	
	
		
 
            self.balance_cell(period_liabilities + period_net,


			




	
	
	
		
 
                              stylename=self.style_bottomline),


			




	
	
	
		
 
            self.balance_cell(prior_liabilities + prior_net,


			




	
	
	
		
 
                              stylename=self.style_bottomline),


			




	
	
	
		
 
            *(self.balance_cell(ltot + etot, stylename=self.style_bottomline)


			




	
	
	
		
 
              for ltot, etot in zip(liabilities, equity_totals)),


			




	
	
	
		
 
        )


			




	...
	
		
 
@@ -388,22 +377,7 @@ class Report(core.BaseODS[Sequence[None], None]):


			




	
	
	
		
 

			




	
	
	
		
 
        totals = [core.MutableBalance() for _ in bal_kwargs]


			




	
	
	
		
 
        self.add_row(self.string_cell("Support and Revenue", stylename=self.style_bold))


			




	
	
	
		
 
        self.add_row()


			




	
	
	
		
 
        for text, classification in self.walk_classifications_by_account('Income'):


			




	
	
	
		
 
            text_cell = self.string_cell(text)


			




	
	
	
		
 
            if classification is None:


			




	
	
	
		
 
                self.add_row(text_cell)


			




	
	
	
		
 
            elif classification == self.C_SATISFIED:


			




	
	
	
		
 
                continue


			




	
	
	
		
 
            else:


			




	
	
	
		
 
                balances = [


			




	
	
	
		
 
                    -self.balances.total(classification=classification, **kwargs)


			




	
	
	
		
 
                    for kwargs in bal_kwargs


			




	
	
	
		
 
                ]


			




	
	
	
		
 
                self.add_row(


			




	
	
	
		
 
                    text_cell,


			




	
	
	
		
 
                    *(self.balance_cell(bal) for bal in balances),


			




	
	
	
		
 
        income_totals = self.write_classifications_by_account(


			




	
	
	
		
 
            'Income', bal_kwargs, (self.C_SATISFIED,),


			




	
	
	
		
 
        )


			




	
	
	
		
 
                for total, bal in zip(totals, balances):


			




	
	
	
		
 
                    total += bal


			




	
	
	
		
 
        self.add_row(


			




	...
	
		
 
@@ -411,3 +385,3 @@ class Report(core.BaseODS[Sequence[None], None]):


			




	
	
	
		
 
            *(self.balance_cell(total, stylename=self.style_subtotline)


			




	
	
	
		
 
              for total in totals),


			




	
	
	
		
 
              for total in income_totals),


			




	
	
	
		
 
        )


			




	...
	
		
 
@@ -422,10 +396,8 @@ class Report(core.BaseODS[Sequence[None], None]):


			




	
	
	
		
 
        )


			




	
	
	
		
 
        totals[0] += released


			




	
	
	
		
 
        totals[1] -= released


			




	
	
	
		
 
        other_totals = [core.MutableBalance() for _ in bal_kwargs]


			




	
	
	
		
 
        other_totals[0] += released


			




	
	
	
		
 
        other_totals[1] -= released


			




	
	
	
		
 
        self.add_row(


			




	
	
	
		
 
            self.string_cell(self.C_SATISFIED),


			




	
	
	
		
 
            self.balance_cell(released),


			




	
	
	
		
 
            self.balance_cell(-released),


			




	
	
	
		
 
            self.balance_cell(self.NO_BALANCE),


			




	
	
	
		
 
            self.balance_cell(self.NO_BALANCE),


			




	
	
	
		
 
            *(self.balance_cell(bal) for bal in other_totals),


			




	
	
	
		
 
        )


			




	...
	
		
 
@@ -434,4 +406,4 @@ class Report(core.BaseODS[Sequence[None], None]):


			




	
	
	
		
 
            self.string_cell("Total Support and Revenue"),


			




	
	
	
		
 
            *(self.balance_cell(total, stylename=self.style_totline)


			




	
	
	
		
 
              for total in totals),


			




	
	
	
		
 
            *(self.balance_cell(inctot + otot, stylename=self.style_totline)


			




	
	
	
		
 
              for inctot, otot in zip(income_totals, other_totals)),


			




	
	
	
		
 
        )


			




	...
	
		
 
@@ -481,5 +453,5 @@ class Report(core.BaseODS[Sequence[None], None]):


			




	
	
	
		
 

			




	
	
	
		
 
        totals[0] -= period_bal


			




	
	
	
		
 
        totals[2] -= period_bal


			




	
	
	
		
 
        totals[3] -= prior_bal


			




	
	
	
		
 
        other_totals[0] -= period_bal


			




	
	
	
		
 
        other_totals[2] -= period_bal


			




	
	
	
		
 
        other_totals[3] -= prior_bal


			




	
	
	
		
 
        self.add_row()


			




	...
	
		
 
@@ -487,3 +459,4 @@ class Report(core.BaseODS[Sequence[None], None]):


			




	
	
	
		
 
            self.string_cell("Change in Net Assets"),


			




	
	
	
		
 
            *(self.balance_cell(total) for total in totals),


			




	
	
	
		
 
            *(self.balance_cell(inctot + otot)


			




	
	
	
		
 
              for inctot, otot in zip(income_totals, other_totals)),


			




	
	
	
		
 
        )


			




	...
	
		
 
@@ -495,3 +468,3 @@ class Report(core.BaseODS[Sequence[None], None]):


			




	
	
	
		
 
                kwargs['period'] = Period.OPENING


			




	
	
	
		
 
        beginnings = [


			




	
	
	
		
 
        equity_totals = [


			




	
	
	
		
 
            -self.balances.total(account=EQUITY_ACCOUNTS, **kwargs)


			




	...
	
		
 
@@ -502,3 +475,3 @@ class Report(core.BaseODS[Sequence[None], None]):


			




	
	
	
		
 
            self.string_cell("Beginning Net Assets"),


			




	
	
	
		
 
            *(self.balance_cell(beg_bal) for beg_bal in beginnings),


			




	
	
	
		
 
            *(self.balance_cell(beg_bal) for beg_bal in equity_totals),


			




	
	
	
		
 
        )


			




	...
	
		
 
@@ -508,4 +481,4 @@ class Report(core.BaseODS[Sequence[None], None]):


			




	
	
	
		
 
            self.string_cell("Ending Net Assets"),


			




	
	
	
		
 
            *(self.balance_cell(beg_bal + tot_bal, stylename=self.style_bottomline)


			




	
	
	
		
 
              for beg_bal, tot_bal in zip(beginnings, totals)),


			




	
	
	
		
 
            *(self.balance_cell(inctot + otot + eqtot, stylename=self.style_bottomline)


			




	
	
	
		
 
              for inctot, otot, eqtot in zip(income_totals, other_totals, equity_totals)),


			




	
	
	
		
 
        )


			




	...
	
		
 
@@ -520,3 +493,3 @@ class Report(core.BaseODS[Sequence[None], None]):


			




	
	
	
		
 
        )


			




	
	
	
		
 
        bal_kwargs: Sequence[Dict[str, Any]] = [


			




	
	
	
		
 
        totals = self.write_classifications_by_account('Expenses', [


			




	
	
	
		
 
            {'period': Period.PERIOD, 'post_type': 'program'},


			




	...
	
		
 
@@ -526,28 +499,3 @@ class Report(core.BaseODS[Sequence[None], None]):


			




	
	
	
		
 
            {'period': Period.PRIOR},


			




	
	
	
		
 
        ]


			




	
	
	
		
 

			




	
	
	
		
 
        totals = [core.MutableBalance() for _ in bal_kwargs]


			




	
	
	
		
 
        for text, classification in self.walk_classifications_by_account('Expenses'):


			




	
	
	
		
 
            text_cell = self.string_cell(text)


			




	
	
	
		
 
            if classification is None:


			




	
	
	
		
 
                if not text[0].isspace():


			




	
	
	
		
 
                    self.add_row()


			




	
	
	
		
 
                self.add_row(text_cell)


			




	
	
	
		
 
            else:


			




	
	
	
		
 
                balances = [


			




	
	
	
		
 
                    self.balances.total(classification=classification, **kwargs)


			




	
	
	
		
 
                    for kwargs in bal_kwargs


			




	
	
	
		
 
                ]


			




	
	
	
		
 
                self.add_row(


			




	
	
	
		
 
                    text_cell,


			




	
	
	
		
 
                    *(self.balance_cell(bal) for bal in balances),


			




	
	
	
		
 
                )


			




	
	
	
		
 
                break_bal = sum(balances[:3], core.MutableBalance())


			




	
	
	
		
 
                if not (break_bal - balances[3]).clean_copy(1).is_zero():


			




	
	
	
		
 
                    logger.warning(


			




	
	
	
		
 
                        "Functional expenses breakdown does not match total on row %s",


			




	
	
	
		
 
                        len(self.sheet.childNodes) - self.col_count,


			




	
	
	
		
 
                    )


			




	
	
	
		
 
                for total, bal in zip(totals, balances):


			




	
	
	
		
 
                    total += bal


			




	
	
	
		
 
        ])


			




	
	
	
		
 
        self.add_row()


			




	...
	
		
 
@@ -565,2 +513,3 @@ class Report(core.BaseODS[Sequence[None], None]):


			




	
	
	
		
 
        ]


			




	
	
	
		
 
        norm_func = operator.neg


			




	
	
	
		
 

			




	...
	
		
 
@@ -572,3 +521,3 @@ class Report(core.BaseODS[Sequence[None], None]):


			




	
	
	
		
 

			




	
	
	
		
 
        totals = [


			




	
	
	
		
 
        equity_totals = [


			




	
	
	
		
 
            -self.balances.total(account=EQUITY_ACCOUNTS, **kwargs)


			




	...
	
		
 
@@ -578,3 +527,3 @@ class Report(core.BaseODS[Sequence[None], None]):


			




	
	
	
		
 
            self.string_cell("Change in Net Assets"),


			




	
	
	
		
 
            *(self.balance_cell(bal) for bal in totals),


			




	
	
	
		
 
            *(self.balance_cell(bal) for bal in equity_totals),


			




	
	
	
		
 
        )


			




	...
	
		
 
@@ -583,19 +532,5 @@ class Report(core.BaseODS[Sequence[None], None]):


			




	
	
	
		
 
        ))


			




	
	
	
		
 
        for text, classification in self.walk_classifications_by_account('Assets'):


			




	
	
	
		
 
            text_cell = self.string_cell(self.SPACE + text)


			




	
	
	
		
 
            if classification is None:


			




	
	
	
		
 
                self.add_row(text_cell)


			




	
	
	
		
 
            elif classification == self.C_CASH:


			




	
	
	
		
 
                continue


			




	
	
	
		
 
            else:


			




	
	
	
		
 
                balances = [


			




	
	
	
		
 
                    -self.balances.total(classification=classification, **kwargs)


			




	
	
	
		
 
                    for kwargs in bal_kwargs


			




	
	
	
		
 
                ]


			




	
	
	
		
 
                self.add_row(


			




	
	
	
		
 
                    text_cell,


			




	
	
	
		
 
                    *(self.balance_cell(bal) for bal in balances),


			




	
	
	
		
 
        asset_totals = self.write_classifications_by_account(


			




	
	
	
		
 
            'Assets', bal_kwargs, (self.C_CASH,), self.SPACE, norm_func,


			




	
	
	
		
 
        )


			




	
	
	
		
 
                for total, bal in zip(totals, balances):


			




	
	
	
		
 
                    total += bal


			




	
	
	
		
 
        self.add_row(self.string_cell(


			




	...
	
		
 
@@ -603,17 +538,9 @@ class Report(core.BaseODS[Sequence[None], None]):


			




	
	
	
		
 
        ))


			




	
	
	
		
 
        for text, classification in self.walk_classifications_by_account('Liabilities'):


			




	
	
	
		
 
            text_cell = self.string_cell(self.SPACE + text)


			




	
	
	
		
 
            if classification is None:


			




	
	
	
		
 
                self.add_row(text_cell)


			




	
	
	
		
 
            else:


			




	
	
	
		
 
                balances = [


			




	
	
	
		
 
                    -self.balances.total(classification=classification, **kwargs)


			




	
	
	
		
 
                    for kwargs in bal_kwargs


			




	
	
	
		
 
                ]


			




	
	
	
		
 
                self.add_row(


			




	
	
	
		
 
                    text_cell,


			




	
	
	
		
 
                    *(self.balance_cell(bal) for bal in balances),


			




	
	
	
		
 
        liabilities = self.write_classifications_by_account(


			




	
	
	
		
 
            'Liabilities', bal_kwargs, (), self.SPACE, norm_func,


			




	
	
	
		
 
        )


			




	
	
	
		
 
                for total, bal in zip(totals, balances):


			




	
	
	
		
 
                    total += bal


			




	
	
	
		
 
        totals = [


			




	
	
	
		
 
            sum(bals, core.MutableBalance())


			




	
	
	
		
 
            for bals in zip(equity_totals, asset_totals, liabilities)


			




	
	
	
		
 
        ]


			




	
	
	
		
 
        self.add_row(


			




        

    



    


    



    



      

      





    
    0 comments (0 inline, 0 general)
    





    


  

  







    


    

  


    








    
        Server instance: kapok.sfconservancy.org-23391
    
    
        This site is powered by
            Kallithea 0.6.3,
        which is
        © 2010–2020 by various authors & licensed under GPLv3.
            – Support
        – Privacy Policy