NPO-Accounting/conservancy_beancount Changeset - 461536453835

Changeset - 461536453835

Parent rev.

Child rev.

[Not reviewed]

0 8 0

Brett Smith - 4 years ago 2020-07-27 14:54:04
brettcsmith@brettcsmith.org

cliutil: Add ReturnFlag.

Take this opportunity to re-standardize flag values now that it's clear
what's most common.

8 files changed with 37 insertions and 38 deletions:

conservancy_beancount/cliutil.py

conservancy_beancount/reports/accrual.py

conservancy_beancount/reports/fund.py

conservancy_beancount/reports/ledger.py

conservancy_beancount/tools/opening_balances.py

tests/test_reports_accrual.py

tests/test_reports_fund.py

tests/test_reports_ledger.py

0 comments (0 inline, 0 general)

conservancy_beancount/cliutil.py

➞

Show inline comments

 """cliutil - Utilities for CLI tools"""
 PKGNAME = 'conservancy_beancount'
 LICENSE = """
 Copyright © 2020  Brett Smith
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (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 argparse
 import datetime
 import enum
 import io
 import logging
 import operator
 import os
 import pkg_resources
 import re
 import signal
 import sys
 import traceback
 import types
 from pathlib import Path
 from . import data
 from . import filters
 from . import rtutil
 from typing import (
     cast,
     Any,
     BinaryIO,
     Callable,
     IO,
     Iterable,
     NamedTuple,
     NoReturn,
     Optional,
     Sequence,
     TextIO,
     Type,
     Union,
+)
 from .beancount_types import (
     MetaKey,
+)
 OutputFile = Union[int, IO]
 STDSTREAM_PATH = Path('-')
 VERSION = pkg_resources.require(PKGNAME)[0].version
 class ExceptHook:
     def __init__(self,
                  logger: Optional[logging.Logger]=None,
                  default_exitcode: int=3,
     ) -> None:
         if logger is None:
             logger = logging.getLogger()
         self.logger = logger
         self.default_exitcode = default_exitcode
     def __call__(self,
                  exc_type: Type[BaseException],
                  exc_value: BaseException,
                  exc_tb: types.TracebackType,
     ) -> NoReturn:
         exitcode = self.default_exitcode
         if isinstance(exc_value, KeyboardInterrupt):
             signal.signal(signal.SIGINT, signal.SIG_DFL)
             os.kill(0, signal.SIGINT)
             signal.pause()
         elif isinstance(exc_value, OSError):
             exitcode += 1
             msg = "I/O error: {e.filename}: {e.strerror}".format(e=exc_value)
         else:
             parts = [type(exc_value).__name__, *exc_value.args]
             msg = "internal " + ": ".join(parts)
         self.logger.critical(msg)
         self.logger.debug(
             ''.join(traceback.format_exception(exc_type, exc_value, exc_tb)),
+        )
         raise SystemExit(exitcode)
 class InfoAction(argparse.Action):
     def __call__(self,
                  parser: argparse.ArgumentParser,
                  namespace: argparse.Namespace,
                  values: Union[Sequence[Any], str, None]=None,
                  option_string: Optional[str]=None,
     ) -> NoReturn:
         if isinstance(self.const, str):
             info = self.const
             exitcode = 0
         else:
             info, exitcode = self.const
         print(info)
         raise SystemExit(exitcode)
 class LogLevel(enum.IntEnum):
     DEBUG = logging.DEBUG
     INFO = logging.INFO
     WARNING = logging.WARNING
     ERROR = logging.ERROR
     CRITICAL = logging.CRITICAL
     WARN = WARNING
     ERR = ERROR
     CRIT = CRITICAL
     @classmethod
     def from_arg(cls, arg: str) -> int:
         try:
             return cls[arg.upper()].value
         except KeyError:
             raise ValueError(f"unknown loglevel {arg!r}") from None
     @classmethod
     def choices(cls) -> Iterable[str]:
         for level in sorted(cls, key=operator.attrgetter('value')):
             yield level.name.lower()
 class ReturnFlag(enum.IntFlag):
     """Common return codes for tools
     Tools should combine these flags to report different errors, and then use
     ReturnFlag.returncode(flags) to report their final exit status code.
     Values 1, 2, 4, and 8 should be reserved for this class to be shared across
     all tools. Flags 16, 32, and 64 are available for tools to report their own
     specific errors.
     """
     LOAD_ERRORS = 1
     NOTHING_TO_REPORT = 2
     _RESERVED4 = 4
     _RESERVED8 = 8
     @classmethod
     def returncode(cls, flags: int) -> int:
         return 0 if flags == 0 else 16 + flags
 class SearchTerm(NamedTuple):
     """NamedTuple representing a user's metadata filter
     SearchTerm knows how to parse and store posting metadata filters provided
     by the user in `key=value` format. Reporting tools can use this to filter
     postings that match the user's criteria, to report on subsets of the books.
     Typical usage looks like::
       argument_parser.add_argument(
         'search_terms',
         type=SearchTerm.arg_parser(),
         …,
+      )
       args = argument_parser.parse_args(…)
       for query in args.search_terms:
         postings = query.filter_postings(postings)
     """
     meta_key: MetaKey
     pattern: str
     @classmethod
     def arg_parser(cls,
                    default_key: Optional[str]=None,
                    ticket_default_key: Optional[str]=None,
     ) -> Callable[[str], 'SearchTerm']:
         """Build a SearchTerm parser
         This method returns a function that can parse strings in ``key=value``
         format and return a corresponding SearchTerm.
         If you specify a default key, then strings that just specify a ``value``
         will be parsed as if they said ``default_key=value``. Otherwise,
         parsing strings without a metadata key will raise a ValueError.
         If you specify a default key ticket links, then values in the format
         ``number``, ``rt:number``, or ``rt://ticket/number`` will be parsed as
         if they said ``ticket_default_key=value``.
         """
         if ticket_default_key is None:
             ticket_default_key = default_key
         def parse_search_term(arg: str) -> 'SearchTerm':
             key: Optional[str] = None
             if re.match(r'^[a-z][-\w]*=', arg):
                 key, _, raw_link = arg.partition('=')
             else:
                 raw_link = arg
             rt_ids = rtutil.RT.parse(raw_link)
             if rt_ids is None:
                 rt_ids = rtutil.RT.parse('rt:' + raw_link)
             if rt_ids is None:
                 if key is None:
                     key = default_key
                 pattern = r'(?:^|\s){}(?:\s|$)'.format(re.escape(raw_link))
             else:
                 ticket_id, attachment_id = rt_ids
                 if key is None:
                     if attachment_id is None:
                         key = ticket_default_key
                     else:
                         key = default_key
                 pattern = rtutil.RT.metadata_regexp(
                     ticket_id,
                     attachment_id,
                     first_link_only=key == 'rt-id' and attachment_id is None,
+                )
             if key is None:
                 raise ValueError(f"invalid search term {arg!r}: no metadata key")
             return cls(key, pattern)
         return parse_search_term
     def filter_postings(self, postings: Iterable[data.Posting]) -> Iterable[data.Posting]:
         return filters.filter_meta_match(
             postings, self.meta_key, re.compile(self.pattern),
+        )
 def add_loglevel_argument(parser: argparse.ArgumentParser,
                           default: LogLevel=LogLevel.INFO) -> argparse.Action:
     return parser.add_argument(
         '--loglevel',
         metavar='LEVEL',
         default=default.value,
         type=LogLevel.from_arg,
         help="Show logs at this level and above."
         f" Specify one of {', '.join(LogLevel.choices())}."
         f" Default {default.name.lower()}.",
+    )
 def add_version_argument(parser: argparse.ArgumentParser) -> argparse.Action:
     progname = parser.prog or sys.argv[0]
     return parser.add_argument(
         '--version', '--copyright', '--license',
         action=InfoAction,
         nargs=0,
         const=f"{progname} version {VERSION}\n{LICENSE}",
         help="Show program version and license information",
+    )
 def date_arg(arg: str) -> datetime.date:
     return datetime.datetime.strptime(arg, '%Y-%m-%d').date()
 def year_or_date_arg(arg: str) -> Union[int, datetime.date]:
     """Get either a date or a year (int) from an argument string
     This is a useful argument type for arguments that will be passed into
     Books loader methods which can accept either a fiscal year or a full date.
     """
     try:
         year = int(arg, 10)
     except ValueError:
         ok = False
     else:
         ok = datetime.MINYEAR <= year <= datetime.MAXYEAR
     if ok:
         return year
     else:
         return date_arg(arg)
 def make_entry_point(mod_name: str, prog_name: str=sys.argv[0]) -> Callable[[], int]:
     """Create an entry_point function for a tool
     The returned function is suitable for use as an entry_point in setup.py.
     It sets up the root logger and excepthook, then calls the module's main
     function.
     """
     def entry_point():  # type:ignore
         prog_mod = sys.modules[mod_name]
         setup_logger()
         prog_mod.logger = logging.getLogger(prog_name)
         sys.excepthook = ExceptHook(prog_mod.logger)
         return prog_mod.main()
     return entry_point
 def setup_logger(logger: Union[str, logging.Logger]='',
                  stream: TextIO=sys.stderr,
                  fmt: str='%(name)s: %(levelname)s: %(message)s',
 ) -> logging.Logger:
     """Set up a logger with a StreamHandler with the given format"""
     if isinstance(logger, str):
         logger = logging.getLogger(logger)
     formatter = logging.Formatter(fmt)
     handler = logging.StreamHandler(stream)
     handler.setFormatter(formatter)
     logger.addHandler(handler)
     return logger
 def set_loglevel(logger: logging.Logger, loglevel: int=logging.INFO) -> None:
     """Set the loglevel for a tool or module
     If the given logger is not under a hierarchy, this function sets the
     loglevel for the root logger, along with some specific levels for libraries
     used by reporting tools. Otherwise, it's the same as
     ``logger.setLevel(loglevel)``.
     """
     if '.' not in logger.name:
         logger = logging.getLogger()
         if loglevel <= logging.DEBUG:
             # At the debug level, the rt module logs the full body of every
             # request and response. That's too much.
             logging.getLogger('rt.rt').setLevel(logging.INFO)
     logger.setLevel(loglevel)
 def bytes_output(path: Optional[Path]=None,
                  default: OutputFile=sys.stdout,
                  mode: str='w',
 ) -> BinaryIO:
     """Get a file-like object suitable for binary output
     If ``path`` is ``None`` or ``-``, returns a file-like object backed by
     ``default``. If ``default`` is a file descriptor or text IO object, this
     method returns a file-like object that writes to the same place.
     Otherwise, returns ``path.open(mode)``.
     """
     mode = f'{mode}b'
     if path is None or path == STDSTREAM_PATH:
         if isinstance(default, int):
             retval = open(default, mode)
         elif isinstance(default, TextIO):
             retval = default.buffer
         else:
             retval = default
     else:
         retval = path.open(mode)
     return cast(BinaryIO, retval)
 def text_output(path: Optional[Path]=None,
                 default: OutputFile=sys.stdout,
                 mode: str='w',
                 encoding: Optional[str]=None,
 ) -> TextIO:
     """Get a file-like object suitable for text output
     If ``path`` is ``None`` or ``-``, returns a file-like object backed by
     ``default``. If ``default`` is a file descriptor or binary IO object, this
     method returns a file-like object that writes to the same place.
     Otherwise, returns ``path.open(mode)``.
     """
     if path is None or path == STDSTREAM_PATH:
         if isinstance(default, int):
             retval = open(default, mode, encoding=encoding)
         elif isinstance(default, BinaryIO):
             retval = io.TextIOWrapper(default, encoding=encoding)
         else:
             retval = default
     else:
         retval = path.open(mode, encoding=encoding)
     return cast(TextIO, retval)

conservancy_beancount/reports/accrual.py

➞

Show inline comments

 #!/usr/bin/env python3
 """accrual-report - Status reports for accruals
 accrual-report checks accruals (postings under Assets:Receivable and
 Liabilities:Payable) for errors and metadata consistency, and reports any
 problems on stderr. Then it writes a report about the status of those
 accruals.
 If you run it with no arguments, it will generate an aging report in ODS format.
 Otherwise, the typical way to run it is to pass an RT ticket number or
 invoice link as an argument, to report about accruals that match those
 criteria::
     # Report all accruals associated with RT#1230:
     accrual-report 1230
     # Report all accruals with the invoice link rt:45/670.
     accrual-report 45/670
     # Report all accruals with the invoice link Invoice980.pdf.
     accrual-report Invoice980.pdf
 By default, to stay fast, accrual-report only looks at unaudited books. You
 can search further back in history by passing the ``--since`` argument. The
 argument can be a fiscal year, or a negative number of how many years back
 to search::
     # Search for accruals since 2016
     accrual-report --since 2016 [search terms …]
     # Search for accruals from the beginning of three fiscal years ago
     accrual-report --since -3 [search terms …]
 If you want to further limit what accruals are reported, you can match on
 other metadata by passing additional arguments in ``name=value`` format.
 You can pass any number of search terms. For example::
     # Report accruals associated with RT#1230 and Jane Doe
     accrual-report 1230 entity=Doe-Jane
 accrual-report will automatically decide what kind of report to generate
 from the search terms you provide and the results they return. If you
 searched on an RT ticket or invoice that returned a single outstanding
 payable, it writes an outgoing approval report. If you searched on RT ticket
 or invoice that returned other results, it writes a balance
 report. Otherwise, it writes an aging report. You can specify what report
 type you want with the ``--report-type`` option::
     # Write an outgoing approval report for all outstanding payables for
     # Jane Doe, even if there's more than one
     accrual-report --report-type outgoing entity=Doe-Jane
     # Write an aging report for a single RT invoice (this can be helpful when
     # one invoice covers multiple parties)
     accrual-report --report-type aging 12/345
 """
 # Copyright © 2020  Brett Smith
+#
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (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 argparse
 import collections
 import datetime
 import enum
 import logging
 import re
 import sys
 from pathlib import Path
 from typing import (
     cast,
     Any,
     BinaryIO,
     Callable,
     Deque,
     Dict,
     Hashable,
     Iterable,
     Iterator,
     List,
     Mapping,
     Match,
     NamedTuple,
     Optional,
     Sequence,
     Set,
     TextIO,
     Tuple,
     TypeVar,
     Union,
+)
 from ..beancount_types import (
     Entries,
     Error,
     Errors,
     MetaKey,
     MetaValue,
     Transaction,
+)
 import odf.element  # type:ignore[import]
 import odf.style  # type:ignore[import]
 import odf.table  # type:ignore[import]
 import rt
 from beancount.parser import printer as bc_printer
 from . import core
 from .. import books
 from .. import cliutil
 from .. import config as configmod
 from .. import data
 from .. import filters
 from .. import rtutil
 PROGNAME = 'accrual-report'
 PostGroups = Mapping[Optional[Hashable], 'AccrualPostings']
 T = TypeVar('T')
 logger = logging.getLogger('conservancy_beancount.reports.accrual')
 class Account(NamedTuple):
     name: str
     aging_thresholds: Sequence[int]
 class AccrualAccount(enum.Enum):
     # Note the aging report uses the same order accounts are defined here.
     # See AgingODS.start_spreadsheet().
     RECEIVABLE = Account('Assets:Receivable', [365, 120, 90, 60])
     PAYABLE = Account('Liabilities:Payable', [365, 90, 60, 30])
     @classmethod
     def account_names(cls) -> Iterator[str]:
         return (acct.value.name for acct in cls)
     @classmethod
     def by_account(cls, name: data.Account) -> 'AccrualAccount':
         for account in cls:
             if name.is_under(account.value.name):
                 return account
         raise ValueError(f"unrecognized account {name!r}")
     @classmethod
     def classify(cls, related: core.RelatedPostings) -> 'AccrualAccount':
         for account in cls:
             account_name = account.value.name
             if all(post.account.is_under(account_name) for post in related):
                 return account
         raise ValueError("unrecognized account set in related postings")
     @property
     def normalize_amount(self) -> Callable[[T], T]:
         return core.normalize_amount_func(self.value.name)
 class AccrualPostings(core.RelatedPostings):
     __slots__ = ()
     @classmethod
     def make_consistent(cls,
                         postings: Iterable[data.Posting],
     ) -> Iterator[Tuple[Hashable, 'AccrualPostings']]:
         accruals: Dict[Tuple[str, ...], List[data.Posting]] = collections.defaultdict(list)
         payments: Dict[Tuple[str, ...], Deque[data.Posting]] = collections.defaultdict(Deque)
         key: Tuple[str, ...]
         for post in postings:
             norm_func = core.normalize_amount_func(post.account)
             invoice = str(post.meta.get('invoice', 'BlankInvoice'))
             if norm_func(post.units.number) >= 0:
                 entity = str(post.meta.get('entity', 'BlankEntity'))
                 key = (post.meta.date.isoformat(), entity, invoice, post.account)
                 accruals[key].append(post)
             else:
                 key = (invoice, post.account)
                 payments[key].append(post)
         for key, acc_posts in accruals.items():
             pay_posts = payments[key[2:]]
             if not pay_posts:
                 continue
             norm_func = core.normalize_amount_func(key[-1])
             balance = norm_func(core.MutableBalance(post.at_cost() for post in acc_posts))
             while pay_posts and not balance.le_zero():
                 pay_post = pay_posts.popleft()
                 acc_posts.append(pay_post)
                 balance += norm_func(pay_post.at_cost())
             if balance.le_zero() and not balance.is_zero():
                 # pay_post causes the accrual to be overpaid. Split it into two
                 # synthesized postings: one that causes the accrual to be
                 # exactly zero, and one with the remainder back in payments.
                 post_cost = pay_post.at_cost()
                 # Calling norm_func() reverses the call in the while loop to add
                 # the amount to the balance.
                 overpayment = norm_func(balance[post_cost.currency])
                 amt_to_zero = post_cost._replace(number=post_cost.number - overpayment.number)
                 acc_posts[-1] = pay_post._replace(units=amt_to_zero, cost=None, price=None)
                 pay_posts.appendleft(pay_post._replace(units=overpayment, cost=None, price=None))
             acc_posts.sort(key=lambda post: post.meta.date)
         for key, acc_posts in accruals.items():
             yield key, cls(acc_posts, _can_own=True)
         for key, pay_posts in payments.items():
             if pay_posts:
                 yield key, cls(pay_posts, _can_own=True)
     def is_paid(self) -> Optional[bool]:
         try:
             accrual_type = AccrualAccount.classify(self)
         except ValueError:
             return None
         else:
             return accrual_type.normalize_amount(self.balance()).le_zero()
 class BaseReport:
     def __init__(self, out_file: TextIO) -> None:
         self.out_file = out_file
         self.logger = logger.getChild(type(self).__name__)
     def _report(self, posts: AccrualPostings, index: int) -> Iterable[str]:
         raise NotImplementedError("BaseReport._report")
     def run(self, groups: PostGroups) -> None:
         for index, invoice in enumerate(groups):
             for line in self._report(groups[invoice], index):
                 print(line, file=self.out_file)
 class AgingODS(core.BaseODS[AccrualPostings, data.Account]):
     AGE_COLORS = [
         '#ff00ff',
         '#ff0000',
         '#ff8800',
         '#ffff00',
         '#00ff00',
+    ]
     DOC_COLUMNS = [
         'rt-id',
         'invoice',
         'approval',
         'contract',
         'purchase-order',
+    ]
     COLUMNS = [
         'Date',
         data.Metadata.human_name('entity'),
         'Invoice Amount',
         'Booked Amount',
         data.Metadata.human_name('project'),
         *(data.Metadata.human_name(key) for key in DOC_COLUMNS),
+    ]
     COL_COUNT = len(COLUMNS)
     def __init__(self,
                  rt_wrapper: rtutil.RT,
                  date: datetime.date,
                  logger: logging.Logger,
     ) -> None:
         super().__init__(rt_wrapper)
         self.date = date
         self.logger = logger
     def section_key(self, row: AccrualPostings) -> data.Account:
         return row[0].account
     def start_spreadsheet(self) -> None:
         for accrual_type in AccrualAccount:
             self.use_sheet(accrual_type.name.title())
             for index in range(self.COL_COUNT):
                 if index == 0:
                     style: Union[str, odf.style.Style] = ''
                 elif index < 6:
                     style = self.column_style(1.2)
                 else:
                     style = self.column_style(1.5)
                 self.sheet.addElement(odf.table.TableColumn(stylename=style))
             self.add_row(*(
                 self.string_cell(name, stylename=self.style_bold)
                 for name in self.COLUMNS
             ))
             self.lock_first_row()
     def start_section(self, key: data.Account) -> None:
         accrual_type = AccrualAccount.by_account(key)
         self.norm_func = accrual_type.normalize_amount
         self.age_thresholds = list(accrual_type.value.aging_thresholds)
         self.age_thresholds.append(-sys.maxsize)
         self.age_balances = [core.MutableBalance() for _ in self.age_thresholds]
         self.age_styles = [
             self.merge_styles(self.style_date, self.border_style(
                 core.Border.LEFT, '10pt', 'solid', color,
             )) for color in self.AGE_COLORS
+        ]
         acct_parts = key.slice_parts()
         self.use_sheet(acct_parts[1])
         self.add_row()
         self.add_row(self.string_cell(
             f"{' '.join(acct_parts[2:])} {acct_parts[1]} Aging Report"
             f" for {self.date.isoformat()}",
             stylename=self.merge_styles(self.style_bold, self.style_centertext),
             numbercolumnsspanned=self.COL_COUNT,
         ))
         self.add_row()
     def end_section(self, key: data.Account) -> None:
         total_balance = core.MutableBalance()
         text_span = 4
         last_age_text: Optional[str] = None
         self.add_row()
         for threshold, balance, style in zip(
                 self.age_thresholds, self.age_balances, self.age_styles,
         ):
             years, days = divmod(threshold, 365)
             years_text = f"{years} {'Year' if years == 1 else 'Years'}"
             days_text = f"{days} Days"
             if years and days:
                 age_text = f"{years_text} {days_text}"
             elif years:
                 age_text = years_text
             else:
                 age_text = days_text
             if last_age_text is None:
                 age_range = f"Over {age_text}"
             elif threshold < 0:
                 self.add_row(
                     self.string_cell(
                         f"Total Unpaid Over {last_age_text}: ",
                         stylename=self.merge_styles(self.style_bold, self.style_endtext),
                         numbercolumnsspanned=text_span,
                     ),
                     *(odf.table.TableCell() for _ in range(1, text_span)),
                     self.balance_cell(total_balance),
+                )
                 age_range = f"Under {last_age_text}"
             else:
                 age_range = f"{age_text}–{last_age_text}"
             self.add_row(
                 self.string_cell(
                     f"Total Aged {age_range}: ",
                     stylename=self.merge_styles(self.style_bold, self.style_endtext, style),
                     numbercolumnsspanned=text_span,
                 ),
                 *(odf.table.TableCell() for _ in range(1, text_span)),
                 self.balance_cell(balance),
+            )
             last_age_text = age_text
             total_balance += balance
         self.add_row(
             self.string_cell(
                 "Total Unpaid: ",
                 stylename=self.merge_styles(self.style_bold, self.style_endtext),
                 numbercolumnsspanned=text_span,
             ),
             *(odf.table.TableCell() for _ in range(1, text_span)),
             self.balance_cell(total_balance),
+        )
     def write_row(self, row: AccrualPostings) -> None:
         row_date = row[0].meta.date
         row_balance = self.norm_func(row.balance_at_cost())
         age = (self.date - row_date).days
         for index, threshold in enumerate(self.age_thresholds):
             if age >= threshold:
                 if row_balance.ge_zero():
                     self.age_balances[index] += row_balance
                 break
         else:
             return
         raw_balance = self.norm_func(row.balance())
         if raw_balance == row_balance:
             amount_cell = odf.table.TableCell()
         else:
             amount_cell = self.balance_cell(raw_balance)
         entities = row.meta_values('entity')
         entities.discard(None)
         projects = row.meta_values('project')
         projects.discard(None)
         self.add_row(
             self.date_cell(row_date, stylename=self.age_styles[index]),
             self.multiline_cell(sorted(entities)),
             amount_cell,
             self.balance_cell(row_balance),
             self.multiline_cell(sorted(projects)),
             *(self.meta_links_cell(row.all_meta_links(key))
               for key in self.DOC_COLUMNS),
+        )
 class AgingReport(BaseReport):
     def __init__(self,
                  rt_wrapper: rtutil.RT,
                  out_file: BinaryIO,
                  date: Optional[datetime.date]=None,
     ) -> None:
         if date is None:
             date = datetime.date.today()
         self.out_bin = out_file
         self.logger = logger.getChild(type(self).__name__)
         self.ods = AgingODS(rt_wrapper, date, self.logger)
     def run(self, groups: PostGroups) -> None:
         rows = [group for group in groups.values()
                 if not group.balance_at_cost().is_zero()]
         rows.sort(key=lambda group: (
             group[0].account,
             group[0].meta.date,
             abs(sum(amt.number for amt in group.balance_at_cost().values())),
         ))
         self.ods.write(rows)
         self.ods.save_file(self.out_bin)
 class BalanceReport(BaseReport):
     def _report(self, posts: AccrualPostings, index: int) -> Iterable[str]:
         meta = posts[0].meta
         date_s = meta.date.strftime('%Y-%m-%d')
         entity_s = meta.get('entity', '<no entity>')
         invoice_s = meta.get('invoice', '<no invoice>')
         balance_s = posts.balance_at_cost().format(zero="Zero balance")
         if index:
             yield ""
         yield f"{entity_s} {invoice_s}:"
         yield f"  {balance_s} outstanding since {date_s}"
 class OutgoingReport(BaseReport):
     class PaymentMethods(enum.Enum):
         ach = 'ACH'
         check = 'Check'
         creditcard = 'Credit Card'
         credit_card = creditcard
         debitcard = 'Debit Card'
         debit_card = debitcard
         echeck = 'E-Check'
         e_check = echeck
         paypal = 'PayPal'
         pay_pal = paypal
         vendorportal = 'Vendor Portal'
         vendor_portal = vendorportal
         wire = 'Wire'
         fxwire = wire
         fx_wire = fxwire
         uswire = wire
         us_wire = uswire
     def __init__(self, rt_wrapper: rtutil.RT, out_file: TextIO) -> None:
         super().__init__(out_file)
         self.rt_wrapper = rt_wrapper
         self.rt_client = rt_wrapper.rt
     def _primary_rt_id(self, posts: AccrualPostings) -> rtutil.TicketAttachmentIds:
         rt_ids = posts.first_meta_links('rt-id')
         rt_id = next(rt_ids, None)
         rt_id2 = next(rt_ids, None)
         if rt_id is None:
             raise ValueError("no rt-id links found")
         elif rt_id2 is not None:
             raise ValueError("multiple rt-id links found")
         parsed = rtutil.RT.parse(rt_id)
         if parsed is None:
             raise ValueError("rt-id is not a valid RT reference")
         else:
             return parsed
     def _get_payment_method(self, posts: AccrualPostings, ticket_id: str) -> Optional[str]:
         payment_methods = posts.meta_values('payment-method')
         payment_methods.discard(None)
         if all(isinstance(s, str) for s in payment_methods):
             # type ignore for <https://github.com/python/mypy/issues/7853>
             payment_methods = {s.strip().lower() for s in payment_methods}  # type:ignore[union-attr]
         log_prefix = f"cannot set payment-method for rt:{ticket_id}:"
         payment_method_count = len(payment_methods)
         if payment_method_count != 1:
             self.logger.warning("%s %s metadata values found",
                                 log_prefix, payment_method_count)
             return None
         payment_method = payment_methods.pop()
         if not isinstance(payment_method, str):
             self.logger.warning("%s %r is not a string value",
                                 log_prefix, payment_method)
             return None
         try:
             currency, method_key = payment_method.split(None, 1)
         except ValueError:
             self.logger.warning("%s no method specified in %r",
                                 log_prefix, payment_method)
             return None
         curr_match = re.fullmatch(r'[a-z]{3}', currency)
         if curr_match is None:
             self.logger.warning("%s invalid currency %r",
                                 log_prefix, currency)
         try:
             method_enum = self.PaymentMethods[re.sub(r'[- ]', '_', method_key)]
         except KeyError:
             self.logger.warning("%s invalid method %r",
                                 log_prefix, method_key)
             curr_match = None
         if curr_match is None:
             return None
         else:
             return f'{currency.upper()} {method_enum.value}'
     def _report(self, posts: AccrualPostings, index: int) -> Iterable[str]:
         try:
             ticket_id, _ = self._primary_rt_id(posts)
             ticket = self.rt_client.get_ticket(ticket_id)
             # Note we only use this when ticket is None.
             errmsg = f"ticket {ticket_id} not found"
         except (ValueError, rt.RtError) as error:
             ticket = None
             errmsg = error.args[0]
         if ticket is None:
             meta = posts[0].meta
             self.logger.error(
                 "can't generate outgoings report for %s %s %s because no RT ticket available: %s",
                 meta.date.isoformat(),
                 meta.get('entity', '<no entity>'),
                 meta.get('invoice', '<no invoice>'),
                 errmsg,
+            )
             return
         try:
             rt_requestor = self.rt_client.get_user(ticket['Requestors'][0])
         except (IndexError, rt.RtError):
             rt_requestor = None
         if rt_requestor is None:
             requestor = ''
             requestor_name = ''
         else:
             requestor_name = (
                 rt_requestor.get('RealName')
                 or ticket.get('CF.{payment-to}')
                 or ''
+            )
             requestor = f'{requestor_name} <{rt_requestor["EmailAddress"]}>'.strip()
         last_zero_index = -1
         for index, (post, balance) in enumerate(posts.iter_with_balance()):
             if balance.is_zero():
                 prior_zero_index = last_zero_index
                 last_zero_index = index
         if last_zero_index == index:
             last_zero_index = prior_zero_index
         posts = posts[last_zero_index + 1:]
         balance = -posts.balance_at_cost()
         balance_s = balance.format(None)
         raw_balance = -posts.balance()
         payment_amount = raw_balance.format('¤¤ #,##0.00')
         if raw_balance != balance:
             payment_amount += f' ({balance_s})'
             balance_s = f'{raw_balance} ({balance_s})'
         payment_to = ticket.get('CF.{payment-to}') or requestor_name
         contract_links = list(posts.all_meta_links('contract'))
         if contract_links:
             contract_s = ' , '.join(self.rt_wrapper.iter_urls(
                 contract_links, missing_fmt='<BROKEN RT LINK: {}>',
             ))
         else:
             contract_s = "NO CONTRACT GOVERNS THIS TRANSACTION"
         projects = [v for v in posts.meta_values('project')
                     if isinstance(v, str)]
         yield "PAYMENT FOR APPROVAL:"
         yield f"REQUESTOR: {requestor}"
         yield f"PAYMENT TO: {payment_to}"
         yield f"TOTAL TO PAY: {balance_s}"
         yield f"AGREEMENT: {contract_s}"
         yield f"PROJECT: {', '.join(projects)}"
         yield "\nBEANCOUNT ENTRIES:\n"
         last_txn: Optional[Transaction] = None
         for post in posts:
             txn = post.meta.txn
             if txn is not last_txn:
                 last_txn = txn
                 txn = self.rt_wrapper.txn_with_urls(txn, '{}')
                 # Suppress payment-method metadata from the report.
                 txn.meta.pop('payment-method', None)
                 for txn_post in txn.postings:
                     if txn_post.meta:
                         txn_post.meta.pop('payment-method', None)
                 yield bc_printer.format_entry(txn)
         cf_targets = {
             'payment-amount': payment_amount,
             'payment-method': (self._get_payment_method(posts, ticket_id)
                                or ticket.get('CF.{payment-method}')),
             'payment-to': payment_to,
+        }
         cf_updates = {
             f'CF_{key}': value
             for key, value in cf_targets.items()
             if ticket.get(f'CF.{{{key}}}') != value
+        }
         if cf_updates:
             try:
                 ok = self.rt_client.edit_ticket(ticket_id, **cf_updates)
             except rt.RtError:
                 self.logger.debug("RT exception on edit_ticket", exc_info=True)
                 ok = False
             if not ok:
                 self.logger.warning("failed to set custom fields for rt:%s", ticket_id)
 class ReportType(enum.Enum):
     AGING = AgingReport
     BALANCE = BalanceReport
     OUTGOING = OutgoingReport
     AGE = AGING
     BAL = BALANCE
     OUT = OUTGOING
     OUTGOINGS = OUTGOING
     @classmethod
     def by_name(cls, name: str) -> 'ReportType':
         try:
             return cls[name.upper()]
         except KeyError:
             raise ValueError(f"unknown report type {name!r}") from None
 class ReturnFlag(enum.IntFlag):
     LOAD_ERRORS = 1
     # 2 was used in the past, it can probably be reclaimed.
     REPORT_ERRORS = 4
     NOTHING_TO_REPORT = 8
 def filter_search(postings: Iterable[data.Posting],
                   search_terms: Iterable[cliutil.SearchTerm],
 ) -> Iterable[data.Posting]:
     accounts = tuple(AccrualAccount.account_names())
     postings = (post for post in postings if post.account.is_under(*accounts))
     for query in search_terms:
         postings = query.filter_postings(postings)
     return postings
 def parse_arguments(arglist: Optional[Sequence[str]]=None) -> argparse.Namespace:
     parser = argparse.ArgumentParser(prog=PROGNAME)
     cliutil.add_version_argument(parser)
     parser.add_argument(
         '--report-type', '-t',
         metavar='NAME',
         type=ReportType.by_name,
         help="""The type of report to generate, one of `aging`, `balance`, or
 `outgoing`. If not specified, the default is `aging` when no search terms are
 given, `outgoing` for search terms that return a single outstanding payable,
 and `balance` any other time.
 """)
     parser.add_argument(
         '--since',
         metavar='YEAR',
         type=int,
         default=0,
         help="""How far back to search the books for related transactions.
 You can either specify a fiscal year, or a negative offset from the current
 fiscal year, to start loading entries from. The default is to load the current,
 unaudited books.
 """)
     parser.add_argument(
         '--output-file', '-O',
         metavar='PATH',
         type=Path,
         help="""Write the report to this file, or stdout when PATH is `-`.
 The default is stdout for the balance and outgoing reports, and a generated
 filename for other reports.
 """)
     cliutil.add_loglevel_argument(parser)
     parser.add_argument(
         'search_terms',
         metavar='FILTER',
         type=cliutil.SearchTerm.arg_parser('invoice', 'rt-id'),
         nargs=argparse.ZERO_OR_MORE,
         help="""Report on accruals that match this criteria. The format is
 NAME=TERM. TERM is a link or word that must exist in a posting's NAME
 metadata to match. A single ticket number is a shortcut for
 `rt-id=rt:NUMBER`. Any other link, including an RT attachment link in
 `TIK/ATT` format, is a shortcut for `invoice=LINK`.
 """)
     args = parser.parse_args(arglist)
     if args.report_type is None and not any(
             term.meta_key == 'invoice' or term.meta_key == 'rt-id'
             for term in args.search_terms
     ):
         args.report_type = ReportType.AGING
     return args
 def main(arglist: Optional[Sequence[str]]=None,
          stdout: TextIO=sys.stdout,
          stderr: TextIO=sys.stderr,
          config: Optional[configmod.Config]=None,
 ) -> int:
     args = parse_arguments(arglist)
     cliutil.set_loglevel(logger, args.loglevel)
     if config is None:
         config = configmod.Config()
         config.load_file()
     returncode = 0
     books_loader = config.books_loader()
     if books_loader is None:
         entries, load_errors, _ = books.Loader.load_none(config.config_file_path())
     else:
         load_since = None if args.report_type == ReportType.AGING else args.since
         entries, load_errors, _ = books_loader.load_all(load_since)
     filters.remove_opening_balance_txn(entries)
     for error in load_errors:
         bc_printer.print_error(error, file=stderr)
         returncode |= ReturnFlag.LOAD_ERRORS
+        returncode |= cliutil.ReturnFlag.LOAD_ERRORS
     postings = list(filter_search(
         data.Posting.from_entries(entries), args.search_terms,
     ))
     if not postings:
         logger.warning("no matching entries found to report")
         returncode |= ReturnFlag.NOTHING_TO_REPORT
+        returncode |= cliutil.ReturnFlag.NOTHING_TO_REPORT
     # groups is a mapping of metadata value strings to AccrualPostings.
     # The keys are basically arbitrary, the report classes don't rely on them,
     # but they do help symbolize what's being grouped.
     # For the outgoing approval report, groups maps rt-id link strings to
     # associated accruals.
     # For all other reports, groups comes from AccrualReport.make_consistent().
     groups: PostGroups
     if args.report_type is None or args.report_type is ReportType.OUTGOING:
         groups = dict(AccrualPostings.group_by_first_meta_link(postings, 'rt-id'))
         if args.report_type is None and len(groups) == 1:
             key = next(iter(groups))
             group = groups[key]
             account = group[0].account
             if (AccrualAccount.by_account(account) is AccrualAccount.PAYABLE
                 and all(post.account == account for post in group)
                 and not group.balance().ge_zero()
                 and key):  # Make sure we have a usable rt-id
                 args.report_type = ReportType.OUTGOING
     if args.report_type is not ReportType.OUTGOING:
         groups = dict(AccrualPostings.make_consistent(postings))
     if args.report_type is not ReportType.AGING:
         groups = {
             key: posts for key, posts in groups.items() if not posts.is_paid()
         } or groups
     del postings
     report: Optional[BaseReport] = None
     output_path: Optional[Path] = None
     if args.report_type is ReportType.AGING:
         rt_wrapper = config.rt_wrapper()
         if rt_wrapper is None:
             logger.error("unable to generate aging report: RT client is required")
         else:
             now = datetime.datetime.now()
             if args.output_file is None:
                 out_dir_path = config.repository_path() or Path()
                 args.output_file = out_dir_path / now.strftime('AgingReport_%Y-%m-%d_%H:%M.ods')
                 logger.info("Writing report to %s", args.output_file)
             out_bin = cliutil.bytes_output(args.output_file, stdout)
             report = AgingReport(rt_wrapper, out_bin)
     elif args.report_type is ReportType.OUTGOING:
         rt_wrapper = config.rt_wrapper()
         if rt_wrapper is None:
             logger.error("unable to generate outgoing report: RT client is required")
         else:
             out_file = cliutil.text_output(args.output_file, stdout)
             report = OutgoingReport(rt_wrapper, out_file)
     else:
         out_file = cliutil.text_output(args.output_file, stdout)
         report = BalanceReport(out_file)
     if report is None:
-        returncode |= ReturnFlag.REPORT_ERRORS
+        returncode |= 16
     else:
         report.run(groups)
-    return 0 if returncode == 0 else 16 + returncode
+    return cliutil.ReturnFlag.returncode(returncode)
 entry_point = cliutil.make_entry_point(__name__, PROGNAME)
 if __name__ == '__main__':
     exit(entry_point())

conservancy_beancount/reports/fund.py

➞

Show inline comments

 """funds.py - Funds report from Beancount
 This tool produces a report of account balances for restricted funds,
 including income, expenses, and realized gain/loss over a given time period.
 Restricted funds are designated with the "project" metadata.
 Specify the date range you want to report with the ``--begin`` and ``--end``
 options.
 Select the accounts you want to report with the ``--account`` option. You can
 specify this option multiple times. The report will include at least one sheet
 for each account you specify. Subaccounts will be reported on that sheet as
 well.
 Select the postings you want to report by passing metadata search terms in
 ``name=value`` format.
 Run ``ledger-report --help`` for abbreviations and other options.
 Examples
 --------
 Generate a report of all restricted funds in ODS format over the last year::
       fund-report
 Query a specific restricted fund and get a quick balance on the terminal::
       fund-report <PROJECT>
 """
 # Copyright © 2020  Brett Smith
+#
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (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 argparse
 import collections
 import datetime
 import enum
 import locale
 import logging
 import sys
 from typing import (
     Dict,
     Iterable,
     Iterator,
     Mapping,
     Optional,
     Sequence,
     TextIO,
     Tuple,
     Union,
+)
 from ..beancount_types import (
     MetaValue,
+)
 from decimal import Decimal
 from pathlib import Path
 import odf.table  # type:ignore[import]
 from beancount.parser import printer as bc_printer
 from . import core
 from .. import books
 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']
 INFO_ACCOUNTS = [
     'Assets:Receivable',
     'Assets:Prepaid',
     'Liabilities:UnearnedIncome',
     'Liabilities:Payable',
+]
 PROGNAME = 'fund-report'
 UNRESTRICTED_FUND = 'Conservancy'
 logger = logging.getLogger('conservancy_beancount.reports.fund')
 class ODSReport(core.BaseODS[FundPosts, None]):
     def __init__(self, start_date: datetime.date, stop_date: datetime.date) -> None:
         super().__init__()
         self.start_date = start_date
         self.stop_date = stop_date
     def section_key(self, row: 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"]]
         else:
             sheet_name = "Fund Report"
             headers += [["Additions"], ["Releases from", "Restrictions"]]
         headers.append(["Balance as of", self.stop_date.isoformat()])
         if expanded:
             headers += [
                 ["Of which", "Receivable"],
                 ["Of which", "Prepaid Expenses"],
                 ["Of which", "Payable"],
                 ["Of which", "Unearned Income"],
+            ]
         self.use_sheet(sheet_name)
         for header in headers:
             first_line = header[0]
             if first_line == 'Fund':
                 width = 2.0
             elif first_line == 'Balance as of':
                 width = 1.5
             elif first_line == 'Of which':
                 width = 1.3
             else:
                 width = 1.2
             col_style = self.column_style(width)
             self.sheet.addElement(odf.table.TableColumn(stylename=col_style))
         center_bold = self.merge_styles(self.style_centertext, self.style_bold)
         row = self.add_row(*(
             self.multiline_cell(header, stylename=center_bold)
             for header in headers
         ))
         row.firstChild.setAttribute(
             'stylename', self.merge_styles(self.style_endtext, self.style_bold),
+        )
         self.lock_first_row()
         self.lock_first_column()
         self.add_row()
         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, balances in self.balances.items():
             balances = [balances[index] for index in bal_indexes]
             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.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]
         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):
             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,
                        balances: Iterable[core.Balance],
                        style: Union[None, str, odf.style.Style]=None,
     ) -> odf.table.TableRow:
         return self.add_row(
             self.string_cell(fund, stylename=self.style_endtext),
             *(self.balance_cell(bal, stylename=style) for bal in balances),
+        )
     def write_row(self, row: FundPosts) -> None:
         fund, accounts_map = row
         self.balances[fund] = list(self._row_balances(accounts_map))
         if fund != UNRESTRICTED_FUND:
             self.write_balances(fund, self.balances[fund])
     def write(self, rows: Iterable[FundPosts]) -> None:
         self.balances: Dict[str, Sequence[core.Balance]] = collections.OrderedDict()
         super().write(rows)
         try:
             unrestricted = self.balances[UNRESTRICTED_FUND]
         except KeyError:
             pass
         else:
             self.add_row()
             self.write_balances("Unrestricted", unrestricted)
 class TextReport:
     def __init__(self,
                  start_date: datetime.date,
                  stop_date: datetime.date,
                  out_file: TextIO) -> None:
         self.start_date = start_date
         self.stop_date = stop_date
         self.out_file = out_file
     def _account_balances(self,
                           fund: str,
                           account_map: AccountsMap,
     ) -> Iterator[Tuple[str, Sequence[str]]]:
         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')
         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')
     def write(self, rows: Iterable[FundPosts]) -> None:
         output = [
             line
             for fund, account_map in rows
             for line in self._account_balances(fund, account_map)
+        ]
         acct_width = max(len(acct_s) for acct_s, _ in output) + 2
         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()}'
         for acct_s, bal_seq in output:
             if 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)
 class ReportType(enum.Enum):
     TEXT = TextReport
     ODS = ODSReport
     TXT = TEXT
     SPREADSHEET = ODS
     @classmethod
     def from_arg(cls, s: str) -> 'ReportType':
         try:
             return cls[s.upper()]
         except KeyError:
             raise ValueError(f"no report type matches {s!r}") from None
 class ReturnFlag(enum.IntFlag):
     LOAD_ERRORS = 1
     NOTHING_TO_REPORT = 8
 def parse_arguments(arglist: Optional[Sequence[str]]=None) -> argparse.Namespace:
     parser = argparse.ArgumentParser(prog=PROGNAME)
     cliutil.add_version_argument(parser)
     parser.add_argument(
         '--begin', '--start', '-b',
         dest='start_date',
         metavar='DATE',
         type=cliutil.date_arg,
         help="""Date to start reporting entries, inclusive, in YYYY-MM-DD format.
 The default is one year ago.
 """)
     parser.add_argument(
         '--end', '--stop', '-e',
         dest='stop_date',
         metavar='DATE',
         type=cliutil.date_arg,
         help="""Date to stop reporting entries, exclusive, in YYYY-MM-DD format.
 The default is a year after the start date.
 """)
     parser.add_argument(
         '--report-type', '-t',
         metavar='TYPE',
         type=ReportType.from_arg,
         help="""Type of report to generate. `text` gives a plain two-column text
 report listing accounts and balances over the period, and is the default when
 you search for a specific project/fund. `ods` produces a higher-level
 spreadsheet, meant to provide an overview of all funds, and is the default when
 you don't specify a project/fund.
 """)
     parser.add_argument(
         '--output-file', '-O',
         metavar='PATH',
         type=Path,
         help="""Write the report to this file, or stdout when PATH is `-`.
 The default is stdout for text reports, and a generated filename for ODS
 reports.
 """)
     cliutil.add_loglevel_argument(parser)
     parser.add_argument(
         'search_terms',
         metavar='FILTER',
         type=cliutil.SearchTerm.arg_parser('project', 'rt-id'),
         nargs=argparse.ZERO_OR_MORE,
         help="""Report on postings that match this criteria. The format is
 NAME=TERM. TERM is a link or word that must exist in a posting's NAME
 metadata to match. A single ticket number is a shortcut for
 `rt-id=rt:NUMBER`. Any other word is a shortcut for `project=TERM`.
 """)
     args = parser.parse_args(arglist)
     if args.report_type is None:
         if any(term.meta_key == 'project' for term in args.search_terms):
             args.report_type = ReportType.TEXT
         else:
             args.report_type = ReportType.ODS
     return args
 def diff_year(date: datetime.date, diff: int) -> datetime.date:
     new_year = date.year + diff
     try:
         return date.replace(year=new_year)
     except ValueError:
         # The original date is Feb 29, which doesn't exist in the new year.
         if diff < 0:
             return datetime.date(new_year, 2, 28)
         else:
             return datetime.date(new_year, 3, 1)
 def main(arglist: Optional[Sequence[str]]=None,
          stdout: TextIO=sys.stdout,
          stderr: TextIO=sys.stderr,
          config: Optional[configmod.Config]=None,
 ) -> int:
     args = parse_arguments(arglist)
     cliutil.set_loglevel(logger, args.loglevel)
     if config is None:
         config = configmod.Config()
         config.load_file()
     if args.stop_date is None:
         if args.start_date is None:
             args.stop_date = datetime.date.today()
         else:
             args.stop_date = diff_year(args.start_date, 1)
     if args.start_date is None:
         args.start_date = diff_year(args.stop_date, -1)
     returncode = 0
     books_loader = config.books_loader()
     if books_loader is None:
         entries, load_errors, _ = books.Loader.load_none(config.config_file_path())
     else:
         entries, load_errors, _ = books_loader.load_fy_range(args.start_date, args.stop_date)
     for error in load_errors:
         bc_printer.print_error(error, file=stderr)
         returncode |= ReturnFlag.LOAD_ERRORS
+        returncode |= cliutil.ReturnFlag.LOAD_ERRORS
     postings = (
         post
         for post in data.Posting.from_entries(entries)
         if post.meta.date < args.stop_date
+    )
     for search_term in args.search_terms:
         postings = search_term.filter_postings(postings)
     fund_postings = {
         key: related
         for key, related in core.RelatedPostings.group_by_meta(postings, 'project')
         if isinstance(key, str)
+    }
     period_cls = core.PeriodPostings.with_start_date(args.start_date)
     fund_map = collections.OrderedDict(
         (fund, dict(period_cls.group_by_account(fund_postings[fund])))
         for fund in sorted(fund_postings, key=lambda s: locale.strxfrm(s.casefold()))
+    )
     if not fund_map:
         logger.warning("no matching postings found to report")
         returncode |= ReturnFlag.NOTHING_TO_REPORT
+        returncode |= cliutil.ReturnFlag.NOTHING_TO_REPORT
     elif args.report_type is ReportType.TEXT:
         out_file = cliutil.text_output(args.output_file, stdout)
         report = TextReport(args.start_date, args.stop_date, out_file)
         report.write(fund_map.items())
     else:
         ods_report = ODSReport(args.start_date, args.stop_date)
         ods_report.write(fund_map.items())
         if args.output_file is None:
             out_dir_path = config.repository_path() or Path()
             args.output_file = out_dir_path / 'FundReport_{}_{}.ods'.format(
                 args.start_date.isoformat(), args.stop_date.isoformat(),
+            )
             logger.info("Writing report to %s", args.output_file)
         ods_file = cliutil.bytes_output(args.output_file, stdout)
         ods_report.save_file(ods_file)
-    return 0 if returncode == 0 else 16 + returncode
+    return cliutil.ReturnFlag.returncode(returncode)
 entry_point = cliutil.make_entry_point(__name__, PROGNAME)
 if __name__ == '__main__':
     exit(entry_point())

conservancy_beancount/reports/ledger.py

➞

Show inline comments

 """ledger.py - General ledger report from Beancount
 This tool produces a spreadsheet that shows postings in Beancount, organized
 by account.
 Specify the date range you want to report with the ``--begin`` and ``--end``
 options.
 Select the accounts you want to report with the ``--account`` option. You can
 specify this option multiple times. The report will include at least one sheet
 for each account you specify. Subaccounts will be reported on that sheet as
 well.
 Select the postings you want to report by passing metadata search terms in
 ``name=value`` format.
 Run ``ledger-report --help`` for abbreviations and other options.
 Examples
 --------
 Report all activity related to a given project::
     ledger-report project=NAME
 Get all Assets postings for a given month to help with reconciliation::
     ledger-report -a Assets -b 2018-05-01 -e 2018-06-01
 """
 # Copyright © 2020  Brett Smith
+#
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (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 argparse
 import collections
 import datetime
 import enum
 import itertools
 import operator
 import logging
 import sys
 from typing import (
     Any,
     Callable,
     Dict,
     Iterable,
     Iterator,
     List,
     Mapping,
     Optional,
     Sequence,
     Set,
     TextIO,
     Tuple,
     Union,
+)
 from ..beancount_types import (
     Transaction,
+)
 from pathlib import Path
 import odf.table  # type:ignore[import]
 from beancount.core import data as bc_data
 from beancount.parser import printer as bc_printer
 from . import core
 from .. import books
 from .. import cliutil
 from .. import config as configmod
 from .. import data
 from .. import ranges
 from .. import rtutil
 PostTally = List[Tuple[int, data.Account]]
 PROGNAME = 'ledger-report'
 logger = logging.getLogger('conservancy_beancount.reports.ledger')
 class LedgerODS(core.BaseODS[data.Posting, None]):
     CORE_COLUMNS: Sequence[str] = [
         'Date',
         data.Metadata.human_name('entity'),
         'Description',
         'Original Amount',
         'Booked Amount',
+    ]
     ACCOUNT_COLUMNS: Dict[str, Sequence[str]] = collections.OrderedDict([
         ('Income', ['project', 'rt-id', 'receipt', 'income-type', 'memo']),
         ('Expenses', ['project', 'rt-id', 'receipt', 'approval', 'expense-allocation']),
         ('Equity', ['rt-id']),
         ('Assets:Receivable', ['project', 'rt-id', 'invoice', 'approval', 'contract', 'purchase-order']),
         ('Liabilities:Payable', ['project', 'rt-id', 'invoice', 'approval', 'contract', 'purchase-order']),
         ('Assets:PayPal', ['rt-id', 'paypal-id', 'receipt', 'approval']),
         ('Assets', ['rt-id', 'receipt', 'approval', 'bank-statement']),
         ('Liabilities', ['rt-id', 'receipt', 'approval', 'bank-statement']),
     ])
     # Excel 2003 was limited to 65,536 rows per worksheet.
     # While we can probably count on all our users supporting more modern
     # formats (Excel 2007 supports over 1 million rows per worksheet),
     # keeping the default limit conservative seems good to avoid running into
     # other limits (like the number of hyperlinks per worksheet), plus just
     # better for human organization and readability.
     SHEET_SIZE = 65500
     def __init__(self,
                  start_date: datetime.date,
                  stop_date: datetime.date,
                  accounts: Optional[Sequence[str]]=None,
                  rt_wrapper: Optional[rtutil.RT]=None,
                  sheet_size: Optional[int]=None,
                  totals_with_entries: Optional[Sequence[str]]=None,
                  totals_without_entries: Optional[Sequence[str]]=None,
     ) -> None:
         if sheet_size is None:
             sheet_size = self.SHEET_SIZE
         if totals_with_entries is None:
             totals_with_entries = [s for s in self.ACCOUNT_COLUMNS if ':' not in s]
         if totals_without_entries is None:
             totals_without_entries = totals_with_entries
         super().__init__(rt_wrapper)
         self.date_range = ranges.DateRange(start_date, stop_date)
         self.sheet_size = sheet_size
         self.totals_with_entries = totals_with_entries
         self.totals_without_entries = totals_without_entries
         self.report_name = "Ledger"
         if accounts is None:
             self.accounts = set(data.Account.iter_accounts())
             self.required_sheet_names = list(self.ACCOUNT_COLUMNS)
         else:
             self.accounts = set()
             self.required_sheet_names = []
             for acct_spec in accounts:
                 subaccounts = frozenset(data.Account.iter_accounts_by_hierarchy(acct_spec))
                 if subaccounts:
                     self.accounts.update(subaccounts)
                     self._require_sheet(acct_spec)
                 else:
                     account_roots_map = collections.defaultdict(list)
                     for account in data.Account.iter_accounts_by_classification(acct_spec):
                         self.accounts.add(account)
                         account_roots_map[account.root_part()].append(account)
                     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.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
     @classmethod
     def _split_sheet(
             cls,
             tally_by_account: PostTally,
             sheet_size: int,
             sheet_name: str,
     ) -> Iterator[str]:
         total = 0
         for index, (count, account) in enumerate(tally_by_account):
             total += count
             if total > sheet_size:
                 break
         else:
             # All the accounts fit in this sheet.
             yield sheet_name
             return
         if index == 0 and len(tally_by_account) == 1:
             # With one account, we can't split any further, so warn and stop.
             logger.warning(
                 "%s has %s rows, over size %s",
                 account, f'{count:,g}', f'{sheet_size:,g}',
+            )
             yield sheet_name
             return
         group_func = operator.methodcaller('root_part', sheet_name.count(':') + 2)
         maybe_split = cls._group_tally(tally_by_account[:index], group_func)
         must_split = cls._group_tally(tally_by_account[index:], group_func)
         for subkey, must_split_tally in sorted(must_split.items()):
             split_names = cls._split_sheet(
                 maybe_split.get(subkey, []) + must_split_tally, sheet_size, subkey,
+            )
             # We must be willing to split out at least as many sheets as there
             # are accounts that didn't fit. Do that first.
             yield from itertools.islice(split_names, len(must_split_tally))
             # After that, we can be in one of two cases:
             # 1. There is no next sheet. All the accounts, including the
             #    maybe_splits and must_splits, fit on planned subsheets.
             #    Update state to note we don't need a sheet for them anymore.
             # 2. The next sheet is named `subkey`, and is planned to include
             #    all of our maybe_split accounts. However, we don't need to
             #    yield that sheet name, because those accounts already fit in
             #    the sheet we're planning, and it would be a needless split.
             next_sheet_name = next(split_names, None)
             if next_sheet_name is None:
                 maybe_split.pop(subkey, None)
             else:
                 assert next_sheet_name == subkey
                 assert not any(split_names)
         if maybe_split:
             yield sheet_name
     @classmethod
     def plan_sheets(
             cls,
             tally_by_account: Mapping[data.Account, int],
             base_sheets: Sequence[str],
             sheet_size: int,
     ) -> Sequence[str]:
         sorted_tally: PostTally = [
             (count, account)
             for account, count in tally_by_account.items()
+        ]
         sorted_tally.sort()
         split_tally = cls._group_tally(
             sorted_tally,
             operator.methodcaller('is_under', *base_sheets),
+        )
         return [
             sheet_name
             for key in base_sheets
             for sheet_name in cls._split_sheet(split_tally[key], sheet_size, key)
+        ]
     # The write() override does its own sectioning by account, so this method
     # goes unused.
     def section_key(self, row: data.Posting) -> None:
         return None
     def metadata_columns_for(self, sheet_name: str) -> Sequence[str]:
         columns_key = data.Account(sheet_name).is_under(*self.ACCOUNT_COLUMNS)
         # columns_key must not be None because ACCOUNT_COLUMNS has an entry
         # for all five root accounts.
         assert columns_key is not None
         return self.ACCOUNT_COLUMNS[columns_key]
     def start_sheet(self, sheet_name: str) -> None:
         self.use_sheet(sheet_name.replace(':', ' '))
         self.metadata_columns = self.metadata_columns_for(sheet_name)
         self.sheet_columns: Sequence[str] = [
             *self.CORE_COLUMNS,
             *(data.Metadata.human_name(meta_key) for meta_key in self.metadata_columns),
+        ]
         for col_name in self.sheet_columns:
             self.sheet.addElement(odf.table.TableColumn(
                 stylename=self.column_styles.get(col_name, self.default_column),
             ))
         self.add_row(*(
             self.string_cell(col_name, stylename=self.style_bold)
             for col_name in self.sheet_columns
         ))
         self.lock_first_row()
     def _write_total_row(self,
                          date: datetime.date,
                          description: str,
                          balance: core.Balance,
     ) -> None:
         cells: List[odf.table.TableCell] = []
         for column in self.CORE_COLUMNS:
             if column == 'Date':
                 cell = self.date_cell(date, stylename=self.merge_styles(
                     self.style_bold, self.style_date,
                 ))
             elif column == 'Description':
                 cell = self.string_cell(description, stylename=self.style_bold)
             elif column == 'Booked Amount':
                 cell = self.balance_cell(self.norm_func(balance), stylename=self.style_bold)
             else:
                 cell = odf.table.TableCell()
             cells.append(cell)
         self.add_row(*cells)
     def _report_section_balance(self, key: data.Account, date_key: str) -> None:
         related = self.account_groups[key]
         if date_key == 'start':
             if not key.keeps_balance():
                 return
             date = self.date_range.start
             balance = related.start_bal
             description = "Opening Balance"
         else:
             date = self.date_range.stop
             if key.keeps_balance():
                 balance = related.stop_bal
                 description = "Ending Balance"
             else:
                 balance = related.period_bal
                 description = "Period Total"
         self._write_total_row(date, description, balance)
     def write_header(self, key: data.Account) -> None:
         self.add_row()
         self.add_row(
             odf.table.TableCell(),
             self.string_cell(
                 f"{key} {self.report_name}"
                 f" From {self.date_range.start.isoformat()}"
                 f" To {self.date_range.stop.isoformat()}",
                 stylename=self.style_bold,
                 numbercolumnsspanned=len(self.sheet_columns) - 1,
             ),
+        )
     def write_balance_sheet(self) -> None:
         self.use_sheet("Balance")
         self.sheet.addElement(odf.table.TableColumn(stylename=self.column_style(3)))
         self.sheet.addElement(odf.table.TableColumn(stylename=self.column_style(1.5)))
         self.add_row(
             self.string_cell("Account", stylename=self.style_bold),
             self.string_cell("Balance", stylename=self.style_bold),
+        )
         self.lock_first_row()
         self.add_row()
         self.add_row(self.string_cell(
             f"Ledger From {self.date_range.start.isoformat()}"
             f" To {self.date_range.stop.isoformat()}",
             stylename=self.merge_styles(self.style_centertext, self.style_bold),
             numbercolumnsspanned=2,
         ))
         self.add_row()
         for account, balance in core.account_balances(self.account_groups):
             if account is core.OPENING_BALANCE_NAME:
                 text = f"Balance as of {self.date_range.start.isoformat()}"
                 style = self.merge_styles(self.style_bold, self.style_endtext)
             elif account is core.ENDING_BALANCE_NAME:
                 text = f"Balance as of {self.date_range.stop.isoformat()}"
                 style = self.merge_styles(self.style_bold, self.style_endtext)
             else:
                 text = account
                 style = self.style_endtext
             self.add_row(
                 self.string_cell(text, stylename=style),
                 self.balance_cell(-balance, stylename=style),
+            )
     def _account_tally(self, account: data.Account) -> int:
         return len(self.account_groups[account])
     def write_entries(self, account: data.Account, rows: Iterable[data.Posting]) -> None:
         for row in rows:
             if row.cost is None:
                 amount_cell = odf.table.TableCell()
             else:
                 amount_cell = self.currency_cell(self.norm_func(row.units))
             self.add_row(
                 self.date_cell(row.meta.date),
                 self.string_cell(row.meta.get('entity') or ''),
                 self.string_cell(row.meta.txn.narration),
                 amount_cell,
                 self.currency_cell(self.norm_func(row.at_cost())),
                 *(self.meta_links_cell(row.meta.report_links(key))
                   if key in data.LINK_METADATA
                   else self.string_cell(row.meta.get(key, ''))
                   for key in self.metadata_columns),
+            )
     def write(self, rows: Iterable[data.Posting]) -> None:
         related_cls = core.PeriodPostings.with_start_date(self.date_range.start)
         self.account_groups = dict(related_cls.group_by_account(
             post for post in rows if post.meta.date < self.date_range.stop
         ))
         for empty_acct in self.accounts.difference(self.account_groups):
             self.account_groups[empty_acct] = related_cls()
         self.write_balance_sheet()
         tally_by_account_iter = (
             (account, self._account_tally(account))
             for account in self.accounts
+        )
         tally_by_account = {
             # 3 for the rows generated by start_section+end_section
             account: count + 3
             for account, count in tally_by_account_iter
+        }
         sheet_names = self.plan_sheets(
             tally_by_account, self.required_sheet_names, self.sheet_size,
+        )
         using_sheet_index = -1
         for sheet_index, account in core.sort_and_filter_accounts(
                 tally_by_account, sheet_names,
         ):
             if not account.is_open_on_date(self.date_range.start):
                 continue
             while using_sheet_index < sheet_index:
                 using_sheet_index += 1
                 self.start_sheet(sheet_names[using_sheet_index])
             self.norm_func = core.normalize_amount_func(account)
             postings = self.account_groups[account]
             if postings:
                 totals_set = self.totals_with_entries
             else:
                 totals_set = self.totals_without_entries
             want_totals = account.is_under(*totals_set) is not None
             if postings or want_totals:
                 self.write_header(account)
             if want_totals:
                 self._report_section_balance(account, 'start')
             self.write_entries(account, postings)
             if want_totals:
                 self._report_section_balance(account, 'stop')
         for index in range(using_sheet_index + 1, len(sheet_names)):
             self.start_sheet(sheet_names[index])
 class TransactionFilter(enum.IntFlag):
     ZERO = 1
     CREDIT = 2
     DEBIT = 4
     ALL = ZERO | CREDIT | DEBIT
     @classmethod
     def from_arg(cls, s: str) -> 'TransactionFilter':
         try:
             return cls[s.upper()]
         except KeyError:
             raise ValueError(f"unknown transaction filter {s!r}")
     @classmethod
     def post_flag(cls, post: data.Posting) -> int:
         norm_func = core.normalize_amount_func(post.account)
         number = norm_func(post.units.number)
         if not number:
             return cls.ZERO
         elif number > 0:
             return cls.CREDIT
         else:
             return cls.DEBIT
 class TransactionODS(LedgerODS):
     CORE_COLUMNS: Sequence[str] = [
         'Date',
         'Description',
         'Account',
         data.Metadata.human_name('entity'),
         'Original Amount',
         'Booked Amount',
+    ]
     METADATA_COLUMNS: Sequence[str] = [
         'project',
         'rt-id',
         'receipt',
         'check',
         'invoice',
         'contract',
         'approval',
         'paypal-id',
         'check-number',
         'bank-statement',
+    ]
     def __init__(self,
                  start_date: datetime.date,
                  stop_date: datetime.date,
                  accounts: Optional[Sequence[str]]=None,
                  rt_wrapper: Optional[rtutil.RT]=None,
                  sheet_size: Optional[int]=None,
                  totals_with_entries: Optional[Sequence[str]]=None,
                  totals_without_entries: Optional[Sequence[str]]=None,
                  txn_filter: int=TransactionFilter.ALL,
     ) -> None:
         super().__init__(
             start_date,
             stop_date,
             accounts,
             rt_wrapper,
             sheet_size,
             totals_with_entries,
             totals_without_entries,
+        )
         self.txn_filter = txn_filter
         if self.txn_filter == TransactionFilter.CREDIT:
             self.report_name = "Receipts"
         elif self.txn_filter == TransactionFilter.DEBIT:
             self.report_name = "Disbursements"
         else:
             self.report_name = "Transactions"
     def _wanted_txns(self, postings: Iterable[data.Posting]) -> Iterator[Transaction]:
         last_txn: Optional[Transaction] = None
         for post in postings:
             txn = post.meta.txn
             if (txn is not last_txn
                 and TransactionFilter.post_flag(post) & self.txn_filter):
                 yield txn
                 last_txn = txn
     def metadata_columns_for(self, sheet_name: str) -> Sequence[str]:
         return self.METADATA_COLUMNS
     def write_balance_sheet(self) -> None:
         return
     def _report_section_balance(self, key: data.Account, date_key: str) -> None:
         if self.txn_filter == TransactionFilter.ALL:
             super()._report_section_balance(key, date_key)
         elif date_key == 'stop':
             balance = core.Balance(
                 post.at_cost()
                 for txn in self._wanted_txns(self.account_groups[key])
                 for post in data.Posting.from_txn(txn)
                 if post.account == key
+            )
             self._write_total_row(self.date_range.stop, "Period Activity", balance)
     def _account_tally(self, account: data.Account) -> int:
         return sum(len(txn.postings)
                    for txn in self._wanted_txns(self.account_groups[account]))
     def write_entries(self, account: data.Account, rows: Iterable[data.Posting]) -> None:
         for txn in self._wanted_txns(rows):
             post_list = list(data.Posting.from_txn(txn))
             post_list.sort(key=lambda post: (
 if post.account == account else 1,
                 -abs(post.at_cost().number),
             ))
             postings = iter(post_list)
             post1 = next(postings)
             if post1.cost is None:
                 amount_cell = odf.table.TableCell()
             else:
                 amount_cell = self.currency_cell(self.norm_func(post1.units))
             self.add_row(
                 self.date_cell(txn.date),
                 self.string_cell(txn.narration),
                 self.string_cell(post1.account),
                 self.string_cell(post1.meta.get('entity') or ''),
                 amount_cell,
                 self.currency_cell(self.norm_func(post1.at_cost())),
                 *(self.meta_links_cell(post1.meta.report_links(key))
                   if key in data.LINK_METADATA
                   else self.string_cell(post1.meta.get(key, ''))
                   for key in self.metadata_columns),
+            )
             for post in postings:
                 meta_cells: List[odf.table.TableCell] = []
                 for meta_key in self.metadata_columns:
                     try:
                         dup = post.meta[meta_key] is txn.meta[meta_key]
                     except KeyError:
                         dup = False
                     if dup:
                         meta_cell = odf.table.TableCell()
                     elif meta_key in data.LINK_METADATA:
                         meta_cell = self.meta_links_cell(post.meta.report_links(meta_key))
                     else:
                         meta_cell = self.string_cell(post.meta.get(meta_key, ''))
                     meta_cells.append(meta_cell)
                 if post.cost is None:
                     amount_cell = odf.table.TableCell()
                 else:
                     amount_cell = self.currency_cell(self.norm_func(post.units))
                 self.add_row(
                     odf.table.TableCell(),
                     odf.table.TableCell(),
                     self.string_cell(post.account),
                     self.string_cell(post.meta.get('entity') or ''),
                     amount_cell,
                     self.currency_cell(self.norm_func(post.at_cost())),
                     *meta_cells,
+                )
 class ReturnFlag(enum.IntFlag):
     LOAD_ERRORS = 1
     NOTHING_TO_REPORT = 8
 class CashReportAction(argparse.Action):
     def __call__(self,
                  parser: argparse.ArgumentParser,
                  namespace: argparse.Namespace,
                  values: Union[Sequence[Any], str, None]=None,
                  option_string: Optional[str]=None,
     ) -> None:
         namespace.txn_filter = self.const
         if namespace.accounts is None:
             namespace.accounts = []
         namespace.accounts.append('Assets:PayPal')
         namespace.accounts.append('Cash')
         if namespace.stop_date is None:
             namespace.stop_date = datetime.date.today()
 def parse_arguments(arglist: Optional[Sequence[str]]=None) -> argparse.Namespace:
     parser = argparse.ArgumentParser(prog=PROGNAME)
     cliutil.add_version_argument(parser)
     parser.add_argument(
         '--disbursements',
         action=CashReportAction,
         const=TransactionFilter.DEBIT,
         nargs=0,
         help="""Shortcut to set all the necessary options to generate a cash
 disbursements report.
 """)
     parser.add_argument(
         '--receipts',
         action=CashReportAction,
         const=TransactionFilter.CREDIT,
         nargs=0,
         help="""Shortcut to set all the necessary options to generate a cash
 receipts report.
 """)
     parser.add_argument(
         '--begin', '--start', '-b',
         dest='start_date',
         metavar='DATE',
         type=cliutil.date_arg,
         help="""Date to start reporting entries, inclusive, in YYYY-MM-DD format.
 The default is one year ago.
 """)
     parser.add_argument(
         '--end', '--stop', '-e',
         dest='stop_date',
         metavar='DATE',
         type=cliutil.date_arg,
         help="""Date to stop reporting entries, exclusive, in YYYY-MM-DD format.
 The default is a year after the start date, or 30 days from today if the start
 date was also not specified.
 """)
     parser.add_argument(
         '--transactions', '-t',
         dest='txn_filter',
         metavar='TYPE',
         type=TransactionFilter.from_arg,
         help="""Report whole transactions rather than individual postings.
 The type argument selects which type of transactions to report. Choices are
 credit, debit, or all.
 """)
     parser.add_argument(
         '--account', '-a',
         dest='accounts',
         metavar='ACCOUNT',
         action='append',
         help="""Show this account in the report. You can specify this option
 multiple times. You can specify a part of the account hierarchy, or an account
 classification from metadata. If not specified, the default set adapts to your
 search criteria.
 """)
     parser.add_argument(
         '--show-totals', '-S',
         metavar='ACCOUNT',
         action='append',
         help="""When entries for this account appear in the report, include
 account balance(s) as well. You can specify this option multiple times. Pass in
 a part of the account hierarchy. The default is all accounts.
 """)
     parser.add_argument(
         '--add-totals', '-T',
         metavar='ACCOUNT',
         action='append',
         help="""When an account could be included in the report but does not
 have any entries in the date range, include a header and account balance(s) for
 it. You can specify this option multiple times. Pass in a part of the account
 hierarchy. The default set adapts to your search criteria.
 """)
     parser.add_argument(
         '--sheet-size', '--size',
         metavar='SIZE',
         type=int,
         default=LedgerODS.SHEET_SIZE,
         help="""Try to limit sheets to this many rows. The report will
 automatically create new sheets to make this happen. When that's not possible,
 it will issue a warning.
 """)
     parser.add_argument(
         '--output-file', '-O',
         metavar='PATH',
         type=Path,
         help="""Write the report to this file, or stdout when PATH is `-`.
 The default is `LedgerReport_<StartDate>_<StopDate>.ods`.
 """)
     cliutil.add_loglevel_argument(parser)
     parser.add_argument(
         'search_terms',
         metavar='FILTER',
         type=cliutil.SearchTerm.arg_parser('project', 'rt-id'),
         nargs=argparse.ZERO_OR_MORE,
         help="""Report on postings that match this criteria. The format is
 NAME=TERM. TERM is a link or word that must exist in a posting's NAME
 metadata to match. A single ticket number is a shortcut for
 `rt-id=rt:NUMBER`. Any other word is a shortcut for `project=TERM`.
 """)
     args = parser.parse_args(arglist)
     if args.add_totals is None and args.search_terms:
         args.add_totals = []
     if args.accounts is None:
         if any(term.meta_key == 'project' for term in args.search_terms):
             args.accounts = [
                 'Income',
                 'Expenses',
                 'Assets:Receivable',
                 'Assets:Prepaid',
                 'Liabilities:UnearnedIncome',
                 'Liabilities:Payable',
+            ]
         else:
             args.accounts = list(LedgerODS.ACCOUNT_COLUMNS)
     return args
 def diff_year(date: datetime.date, diff: int) -> datetime.date:
     new_year = date.year + diff
     try:
         return date.replace(year=new_year)
     except ValueError:
         # The original date is Feb 29, which doesn't exist in the new year.
         if diff < 0:
             return datetime.date(new_year, 2, 28)
         else:
             return datetime.date(new_year, 3, 1)
 def main(arglist: Optional[Sequence[str]]=None,
          stdout: TextIO=sys.stdout,
          stderr: TextIO=sys.stderr,
          config: Optional[configmod.Config]=None,
 ) -> int:
     args = parse_arguments(arglist)
     cliutil.set_loglevel(logger, args.loglevel)
     if config is None:
         config = configmod.Config()
         config.load_file()
     today = datetime.date.today()
     if args.start_date is None:
         args.start_date = diff_year(today, -1)
         if args.stop_date is None:
             args.stop_date = today + datetime.timedelta(days=30)
     elif args.stop_date is None:
         args.stop_date = diff_year(args.start_date, 1)
     returncode = 0
     books_loader = config.books_loader()
     if books_loader is None:
         entries, load_errors, options = books.Loader.load_none(config.config_file_path())
     else:
         entries, load_errors, options = books_loader.load_fy_range(args.start_date, args.stop_date)
     for error in load_errors:
         bc_printer.print_error(error, file=stderr)
         returncode |= ReturnFlag.LOAD_ERRORS
+        returncode |= cliutil.ReturnFlag.LOAD_ERRORS
     data.Account.load_from_books(entries, options)
     postings = data.Posting.from_entries(entries)
     for search_term in args.search_terms:
         postings = search_term.filter_postings(postings)
     rt_wrapper = config.rt_wrapper()
     if rt_wrapper is None:
         logger.warning("could not initialize RT client; spreadsheet links will be broken")
     try:
         if args.txn_filter is None:
             report = LedgerODS(
                 args.start_date,
                 args.stop_date,
                 args.accounts,
                 rt_wrapper,
                 args.sheet_size,
                 args.show_totals,
                 args.add_totals,
+            )
         else:
             report = TransactionODS(
                 args.start_date,
                 args.stop_date,
                 args.accounts,
                 rt_wrapper,
                 args.sheet_size,
                 args.show_totals,
                 args.add_totals,
                 args.txn_filter,
+            )
     except ValueError as error:
         logger.error("%s: %r", *error.args)
         return 2
     report.write(postings)
     if not any(report.account_groups.values()):
         logger.warning("no matching postings found to report")
         returncode |= ReturnFlag.NOTHING_TO_REPORT
+        returncode |= cliutil.ReturnFlag.NOTHING_TO_REPORT
     if args.output_file is None:
         out_dir_path = config.repository_path() or Path()
         args.output_file = out_dir_path / '{}Report_{}_{}.ods'.format(
             report.report_name,
             args.start_date.isoformat(),
             args.stop_date.isoformat(),
+        )
         logger.info("Writing report to %s", args.output_file)
     ods_file = cliutil.bytes_output(args.output_file, stdout)
     report.save_file(ods_file)
-    return 0 if returncode == 0 else 16 + returncode
+    return cliutil.ReturnFlag.returncode(returncode)
 entry_point = cliutil.make_entry_point(__name__, PROGNAME)
 if __name__ == '__main__':
     exit(entry_point())

conservancy_beancount/tools/opening_balances.py

➞

Show inline comments

 #!/usr/bin/env python3
 """opening_balances.py - Tool to generate opening balances transactions
 This tool generates an opening balances transaction for a given date and writes
 it to stdout. Use this when you close the books for a year to record the final
 balances for that year.
 Run it without arguments to generate opening balances for the current fiscal
 year. You can also specify a fiscal year to generate opening balances for, or
 even a specific date (which can be helpful for testing or debugging).
 """
 # SPDX-FileCopyrightText: © 2020 Martin Michlmayr <tbm@cyrius.com>
 # SPDX-FileCopyrightText: © 2020 Brett Smith
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (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 argparse
 import collections
 import copy
 import datetime
 import enum
 import locale
 import logging
 import sys
 from typing import (
     Dict,
     Hashable,
     Iterable,
     Iterator,
     Mapping,
     NamedTuple,
     Optional,
     Sequence,
     TextIO,
     Tuple,
+)
 from ..beancount_types import (
     Error,
     MetaKey,
     MetaValue,
     Transaction,
+)
 from decimal import Decimal, ROUND_HALF_EVEN, ROUND_HALF_UP
 from .. import books
 from .. import cliutil
 from .. import config as configmod
 from .. import data
 from ..reports.core import Balance
 from beancount.core import data as bc_data
 from beancount.core import display_context as bc_dcontext
 from beancount.parser import printer as bc_printer
 from beancount.core.convert import get_cost
 from beancount.core.inventory import Inventory
 from beancount.core.position import Position, get_position
 EQUITY_ACCOUNTS = frozenset([
     'Equity',
     'Expenses',
     'Income',
 ])
 FUND_ACCOUNTS = frozenset([
     'Assets:Prepaid',
     'Assets:Receivable',
     'Equity:Funds',
     'Equity:Realized',
     'Expenses',
     'Income',
     'Liabilities:Payable',
     'Liabilities:UnearnedIncome',
 ])
 RESTRICTED_ACCOUNT = data.Account('Equity:Funds:Restricted')
 UNRESTRICTED_ACCOUNT = data.Account('Equity:Funds:Unrestricted')
 PROGNAME = 'opening-balances'
 logger = logging.getLogger('conservancy_beancount.tools.opening_balances')
 def quantize_amount(
         amount: data.Amount,
         exp: Decimal=Decimal('.01'),
         rounding: str=ROUND_HALF_EVEN,
 ) -> data.Amount:
     return amount._replace(number=amount.number.quantize(exp, rounding=rounding))
 class AccountWithFund(NamedTuple):
     account: data.Account
     fund: Optional[MetaValue]
     def sortkey(self) -> Hashable:
         account, fund = self
         return (
 if fund is None else 1,
             locale.strxfrm(account),
             locale.strxfrm(str(fund).casefold()),
+        )
 class Posting(data.Posting):
     @staticmethod
     def _position_sortkey(position: Position) -> str:
         units, cost = position
         if cost is None:
             # Beancount type-declares that position.cost must be a Cost, but
             # in practice that's not true. Call get_position(post) on any
             # post without a cost and see what it returns. Hence the ignore.
             return units.currency  # type:ignore[unreachable]
         else:
             return f'{units.currency} {cost.currency} {cost.date.isoformat()}'
     @classmethod
     def build_opening(
             cls,
             key: AccountWithFund,
             meta_key: MetaKey,
             inventory: Inventory,
     ) -> Iterator[bc_data.Posting]:
         account, project = key
         if project is None:
             meta: Optional[Dict[MetaKey, MetaValue]] = None
         else:
             meta = {meta_key: project}
         for units, cost in sorted(inventory, key=cls._position_sortkey):
             if cost is None:
                 units = quantize_amount(units)
             yield bc_data.Posting(
                 account, units, cost, None, None, copy.copy(meta),
+            )
 class ReturnFlag(enum.IntFlag):
     LOAD_ERRORS = 1
 def parse_arguments(arglist: Optional[Sequence[str]]=None) -> argparse.Namespace:
     parser = argparse.ArgumentParser(prog=PROGNAME)
     cliutil.add_version_argument(parser)
     cliutil.add_loglevel_argument(parser)
     parser.add_argument(
         '--fund-metadata-key', '-m',
         metavar='KEY',
         dest='meta_key',
         default='project',
         help="""Name of the fund metadata key. Default %(default)s.
 """)
     parser.add_argument(
         '--unrestricted-fund', '-u',
         metavar='PROJECT',
         default='Conservancy',
         help="""Name of the unrestricted fund. Default %(default)s.
 """)
     parser.add_argument(
         'as_of_date',
         metavar='YEAR_OR_DATE',
         type=cliutil.year_or_date_arg,
         nargs='?',
         help="""Date to generate opening balances for. You can provide just
 a year to generate balances for the start of that fiscal year. Defaults to the
 current fiscal year.
 """)
     return parser.parse_args(arglist)
 def main(arglist: Optional[Sequence[str]]=None,
          stdout: TextIO=sys.stdout,
          stderr: TextIO=sys.stderr,
          config: Optional[configmod.Config]=None,
 ) -> int:
     args = parse_arguments(arglist)
     cliutil.set_loglevel(logger, args.loglevel)
     if config is None:
         config = configmod.Config()
         config.load_file()
     fy = config.fiscal_year_begin()
     if args.as_of_date is None:
         args.as_of_date = fy.for_date()
     if isinstance(args.as_of_date, int):
         args.as_of_date = fy.first_date(args.as_of_date)
     returncode = 0
     books_loader = config.books_loader()
     if books_loader is None:
         entries, load_errors, _ = books.Loader.load_none(config.config_file_path())
     else:
         entries, load_errors, _ = books_loader.load_fy_range(0, args.as_of_date)
     for error in load_errors:
         bc_printer.print_error(error, file=stderr)
         returncode |= ReturnFlag.LOAD_ERRORS
+        returncode |= cliutil.ReturnFlag.LOAD_ERRORS
     inventories: Mapping[AccountWithFund, Inventory] = collections.defaultdict(Inventory)
     for post in Posting.from_entries(entries):
         if post.meta.date >= args.as_of_date:
             continue
         account = post.account
         fund_acct_match = post.account.is_under(*FUND_ACCOUNTS)
         is_equity = account.root_part() in EQUITY_ACCOUNTS
         if fund_acct_match is None:
             project: MetaValue = None
         else:
             project = post.meta.get(args.meta_key)
             if project is None:
                 bc_printer.print_error(Error(
                     post.meta, "no fund specified", post.meta.txn,
                 ), file=stderr)
                 project = args.unrestricted_fund
             if is_equity:
                 if project == args.unrestricted_fund:
                     account = UNRESTRICTED_ACCOUNT
                 else:
                     account = RESTRICTED_ACCOUNT
         inventory = inventories[AccountWithFund(account, project)]
         if is_equity:
             inventory.add_amount(post.at_cost())
         else:
             inventory.add_position(get_position(post))
     opening_date = args.as_of_date - datetime.timedelta(1)
     opening = bc_data.Transaction(  # type:ignore[operator]
         None,  # meta
         opening_date,
         '*',
         None,  # payee
         f"Opening balances for FY{fy.for_date(args.as_of_date)}",
         frozenset(),  # tags
         frozenset(),  # links
         [post
          for key in sorted(inventories, key=AccountWithFund.sortkey)
          for post in Posting.build_opening(key, args.meta_key, inventories[key])
         ])
     balance = Balance(get_cost(get_position(post))
                       for post in opening.postings)
     for amount in balance.clean_copy().values():
         opening.postings.append(bc_data.Posting(
             UNRESTRICTED_ACCOUNT, quantize_amount(-amount), None, None, None,
             {args.meta_key: args.unrestricted_fund},
         ))
     dcontext = bc_dcontext.DisplayContext()
     dcontext.set_commas(True)
     bc_printer.print_entry(opening, dcontext, file=stdout)
-    return 0 if returncode == 0 else 16 + returncode
+    return cliutil.ReturnFlag.returncode(returncode)
 entry_point = cliutil.make_entry_point(__name__, PROGNAME)
 if __name__ == '__main__':
     exit(entry_point())

tests/test_reports_accrual.py

➞

Show inline comments

@@ ... / @@ -10,792 +10,792 @@ @@
 # 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 operator
 import re
 import babel.numbers
 import odf.opendocument
 import odf.table
 import odf.text
 import pytest
 from . import testutil
 from decimal import Decimal
 from typing import NamedTuple, Optional, Sequence
 from beancount.core import data as bc_data
 from beancount import loader as bc_loader
 from conservancy_beancount import cliutil
 from conservancy_beancount import data
 from conservancy_beancount import rtutil
 from conservancy_beancount.reports import accrual
 _accruals_load = bc_loader.load_file(testutil.test_path('books/accruals.beancount'))
 ACCRUAL_TXNS = [
     entry for entry in _accruals_load[0]
     if hasattr(entry, 'narration')
     and entry.narration != 'Opening balances'
+]
 ACCRUALS_COUNT = sum(
     for txn in ACCRUAL_TXNS
     for post in txn.postings
     if post.account.startswith(('Assets:Receivable:', 'Liabilities:Payable:'))
+)
 ACCOUNTS = [
     'Assets:Receivable:Accounts',
     'Assets:Receivable:Loans',
     'Liabilities:Payable:Accounts',
     'Liabilities:Payable:Vacation',
+]
 AGE_SUM_RE = re.compile(r'(?:\b(\d+) Years?)?(?: ?\b(\d+) Days?)?[–:]')
 class AgingRow(NamedTuple):
     date: datetime.date
     entity: Sequence[str]
     amount: Optional[Sequence[bc_data.Amount]]
     at_cost: bc_data.Amount
     rt_id: Sequence[str]
     invoice: Sequence[str]
     project: Sequence[str]
     @classmethod
     def make_simple(cls, date, entity, at_cost, invoice,
                     rt_id=None, orig_amount=None, project='Conservancy'):
         if isinstance(date, str):
             date = datetime.datetime.strptime(date, '%Y-%m-%d').date()
         if not isinstance(at_cost, tuple):
             at_cost = testutil.Amount(at_cost)
         if rt_id is None and invoice.startswith('rt:'):
             rt_id, _, _ = invoice.partition('/')
         return cls(date, [entity], orig_amount, at_cost, [rt_id], [invoice], [project])
     def check_row_match(self, sheet_row):
         cells = testutil.ODSCell.from_row(sheet_row)
         assert len(cells) >= len(self)
         cells = iter(cells)
         assert next(cells).value == self.date
         assert next(cells).text == '\0'.join(self.entity)
         assert next(cells).text == '\0'.join(
             babel.numbers.format_currency(number, currency, format_type='accounting')
             for number, currency in self.amount or ()
+        )
         usd_cell = next(cells)
         assert usd_cell.value_type == 'currency'
         assert usd_cell.value == self.at_cost.number
         assert next(cells).text == '\0'.join(self.project)
         for index, cell in enumerate(cells):
             links = cell.getElementsByType(odf.text.A)
             assert len(links) == len(cell.childNodes)
         assert index >= 1
 AGING_AP = [
     AgingRow.make_simple('2010-03-06', 'EarlyBird', -125, 'rt:44/440'),
     AgingRow.make_simple('2010-03-30', 'EarlyBird', 75, 'rt:490/4900'),
     AgingRow.make_simple('2010-04-25', 'Vendor', 200, 'FIXME'),
     AgingRow.make_simple('2010-04-30', 'Vendor', 220, 'rt:310/3120'),
     AgingRow.make_simple('2010-06-10', 'Lawyer', 280, 'rt:510/6100'),
     AgingRow.make_simple('2010-06-18', 'EuroGov', 1100, 'rt:520/5200',
                          orig_amount=[testutil.Amount(1000, 'EUR')]),
     AgingRow.make_simple('2010-06-20', 'StateGov', 50, 'Invoices/2010StateRegistration.pdf'),
+]
 AGING_AR = [
     AgingRow.make_simple('2010-03-05', 'EarlyBird', -500, 'rt:40/400'),
     AgingRow.make_simple('2010-05-15', 'MatchingProgram', 1500,
                          'rt://ticket/515/attachments/5150'),
     AgingRow.make_simple('2010-06-15', 'GrantCo', 5500, 'rt:470/4700',
                          project='Development Grant'),
     AgingRow.make_simple('2010-09-15', 'GrantCo', 6000, 'rt:470/4700',
                          project='Development Grant'),
+]
 class RTClient(testutil.RTClient):
     TICKET_DATA = {
         '40': [
             ('400', 'invoice feb.csv', 'text/csv', '40.4k'),
         ],
         '44': [
             ('440', 'invoice feb.csv', 'text/csv', '40.4k'),
         ],
         '310': [
             ('3100', 'VendorContract.pdf', 'application/pdf', '1.7m'),
             ('3120', 'VendorInvoiceB.pdf', 'application/pdf', '1.8m'),
         ],
         '490': [],
         '505': [],
         '510': [
             ('4000', 'contract.pdf', 'application/pdf', '1.4m'),
             ('5100', 'invoice april.pdf', 'application/pdf', '1.5m'),
             ('5105', 'payment.png', 'image/png', '51.5k'),
             ('6100', 'invoice may.pdf', 'application/pdf', '1.6m'),
         ],
         '515': [],
         '520': [],
+    }
 @pytest.fixture
 def accrual_postings():
     return data.Posting.from_entries(copy.deepcopy(ACCRUAL_TXNS))
 def accruals_by_meta(postings, value, key='invoice', wrap_type=iter):
     return wrap_type(
         post for post in postings
         if post.meta.get(key) == value
         and post.account.is_under('Assets:Receivable', 'Liabilities:Payable')
+    )
 def find_row_by_text(row_source, want_text):
     for row in row_source:
         try:
             found_row = row.childNodes[0].text == want_text
         except IndexError:
             found_row = False
         if found_row:
             return row
     pytest.fail(f"did not find row with text {want_text!r}")
 def check_age_sum(aging_rows, row, date):
     text = row.firstChild.text
     ages = [int(match.group(1) or 0) * 365 + int(match.group(2) or 0)
             for match in AGE_SUM_RE.finditer(text)]
     if len(ages) == 1:
         # datetime only supports a 10K year range so this should cover all of it
         if text.startswith('Total Aged Over '):
             age_range = range(ages[0], 3650000)
         else:
             age_range = range(-3650000, ages[0])
     elif len(ages) == 2:
         age_range = range(*ages)
     else:
         pytest.fail(f"row has incorrect age matches: {ages!r}")
     assert row.lastChild.value == sum(
         row.at_cost.number
         for row in aging_rows
         if row.at_cost.number > 0
         and (date - row.date).days in age_range
+    )
     return row.lastChild.value
 def check_aging_sheet(sheet, aging_rows, date):
     if not aging_rows:
         return
     rows = iter(sheet.getElementsByType(odf.table.TableRow))
     expect_rows = iter(aging_rows)
     row0 = find_row_by_text(rows, aging_rows[0].date.isoformat())
     next(expect_rows).check_row_match(row0)
     for actual, expected in zip(rows, expect_rows):
         expected.check_row_match(actual)
     row0 = find_row_by_text(rows, "Total Aged Over 1 Year: ")
     aging_sum = check_age_sum(aging_rows, row0, date)
     sums = 0
     for row in rows:
         if not row.firstChild:
             pass
         elif row.firstChild.text.startswith("Total Unpaid"):
             assert row.lastChild.value == aging_sum
             sums += 1
         else:
             aging_sum += check_age_sum(aging_rows, row, date)
     assert sums > 1
 def check_aging_ods(ods_file, date, recv_rows=AGING_AR, pay_rows=AGING_AP):
     ods_file.seek(0)
     ods = odf.opendocument.load(ods_file)
     sheets = ods.spreadsheet.getElementsByType(odf.table.Table)
     assert len(sheets) == 2
     check_aging_sheet(sheets[0], recv_rows, date)
     check_aging_sheet(sheets[1], pay_rows, date)
 @pytest.mark.parametrize('search_terms,expect_count,check_func', [
     ([], ACCRUALS_COUNT, lambda post: post.account.is_under(
         'Assets:Receivable:', 'Liabilities:Payable:',
     )),
     ([('rt-id', '^rt:505$')], 2, lambda post: post.meta['entity'] == 'DonorA'),
     ([('invoice', r'^rt:\D+515/')], 1, lambda post: post.meta['entity'] == 'MatchingProgram'),
     ([('entity', '^Lawyer$')], 3, lambda post: post.meta['rt-id'] == 'rt:510'),
     ([('entity', '^Lawyer$'), ('contract', '^rt:510/')], 2,
      lambda post: post.meta['invoice'].startswith('rt:510/')),
     ([('rt-id', '^rt:510$'), ('approval', '.')], 0, lambda post: False),
 ])
 def test_filter_search(accrual_postings, search_terms, expect_count, check_func):
     search_terms = [cliutil.SearchTerm._make(query) for query in search_terms]
     actual = list(accrual.filter_search(accrual_postings, search_terms))
     if expect_count < ACCRUALS_COUNT:
         assert ACCRUALS_COUNT > len(actual) >= expect_count
     else:
         assert len(actual) == ACCRUALS_COUNT
     for post in actual:
         assert check_func(post)
 @pytest.mark.parametrize('arg,expected', [
     ('aging', accrual.AgingReport),
     ('balance', accrual.BalanceReport),
     ('outgoing', accrual.OutgoingReport),
     ('age', accrual.AgingReport),
     ('bal', accrual.BalanceReport),
     ('out', accrual.OutgoingReport),
     ('outgoings', accrual.OutgoingReport),
 ])
 def test_report_type_by_name(arg, expected):
     assert accrual.ReportType.by_name(arg.lower()).value is expected
     assert accrual.ReportType.by_name(arg.title()).value is expected
     assert accrual.ReportType.by_name(arg.upper()).value is expected
 @pytest.mark.parametrize('arg', [
     'unknown',
     'blance',
     'outgong',
 ])
 def test_report_type_by_unknown_name(arg):
     # Raising ValueError helps argparse generate good messages.
     with pytest.raises(ValueError):
         accrual.ReportType.by_name(arg)
 @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):
     if acct_name.startswith('Assets:'):
         mult = 10
     else:
         mult = -10
     txn = testutil.Transaction(date=datetime.date(2019, 1, day), postings=[
         (acct_name, index * mult, {'invoice': invoice, 'entity': f'BadInvoice{day}'})
         for index in range(1, 4)
     ])
     postings = data.Posting.from_txn(txn)
     consistent = dict(accrual.AccrualPostings.make_consistent(iter(postings)))
     assert len(consistent) == 1
     _, actual = consistent.popitem()
     assert len(actual) == 3
     for act_post, exp_post in zip(actual, postings):
         assert act_post == exp_post
 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, 'entity': 'CrossAccount'})
         for acct_name in ACCOUNTS
     ])
     consistent = dict(accrual.AccrualPostings.make_consistent(data.Posting.from_txn(txn)))
     assert len(consistent) == len(ACCOUNTS)
     for key, posts in consistent.items():
         assert len(posts) == 1
 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
     ])
     consistent = dict(accrual.AccrualPostings.make_consistent(data.Posting.from_txn(txn)))
     assert len(consistent) == len(ACCOUNTS)
     for key, posts in consistent.items():
         assert len(posts) == 1
 @pytest.mark.parametrize('acct_name', ACCOUNTS)
 def test_make_consistent_across_entity(acct_name):
     amt_sign = operator.pos if acct_name.startswith('Assets') else operator.neg
     txn = testutil.Transaction(postings=[
         (acct_name, amt_sign(n), {'invoice': 'Inv/1.pdf', 'entity': f'Entity{n}'})
         for n in range(1, 4)
     ])
     consistent = dict(accrual.AccrualPostings.make_consistent(data.Posting.from_txn(txn)))
     assert len(consistent) == 3
     for key, posts in consistent.items():
         assert len(posts) == 1
 @pytest.mark.parametrize('acct_name', ACCOUNTS)
 def test_make_consistent_entity_differs_accrual_payment(acct_name):
     invoice = 'Invoices/DifferPay.pdf'
     txn = testutil.Transaction(postings=[
         # Depending on the account, the order of the accrual and payment might
         # be swapped here, but that shouldn't matter.
         (acct_name, 125, {'invoice': invoice, 'entity': 'Positive'}),
         (acct_name, -125, {'invoice': invoice, 'entity': 'Negative'}),
     ])
     related = list(data.Posting.from_txn(txn))
     consistent = accrual.AccrualPostings.make_consistent(related)
     _, actual = next(consistent)
     assert len(actual) == len(related)
     assert all(post in actual for post in related)
     assert next(consistent, None) is None
 def test_make_consistent_by_date_accruals_differ():
     meta = {'rt-id': '1', 'invoice': 'rt:1/2', 'entity': 'MultiDate'}
     entries = [testutil.Transaction(date=date, postings=[
         ('Assets:Receivable:Accounts', date.day * 100, meta),
     ]) for date in itertools.islice(testutil.date_seq(), 3)]
     actual = [group for _, group in
               accrual.AccrualPostings.make_consistent(data.Posting.from_entries(entries))]
     assert len(actual) == 3
     assert {post.units.number for group in actual for post in group} == {100, 200, 300}
 def test_make_consistent_by_date_with_exact_payment():
     meta = {'rt-id': '1', 'invoice': 'rt:1/3', 'entity': 'OnePayment'}
     entries = [testutil.Transaction(date=date, postings=[(
         'Assets:Receivable:Accounts',
 * (1 if date.day % 2 else -1),
         meta,
     )]) for date in itertools.islice(testutil.date_seq(), 3)]
     actual = [group for _, group in
               accrual.AccrualPostings.make_consistent(data.Posting.from_entries(entries))]
     assert len(actual) == 2
     assert sum(post.units.number for post in actual[0]) == 0
     assert len(actual[1]) == 1
     assert actual[1][0].meta.date.day == 3
 def test_make_consistent_by_date_with_underpayment():
     meta = {'rt-id': '1', 'invoice': 'rt:1/4', 'entity': 'UnderPayment'}
     entries = [testutil.Transaction(date=date, postings=[(
         'Assets:Receivable:Accounts',
 * (1 if date.day % 2 else -.5),
         meta,
     )]) for date in itertools.islice(testutil.date_seq(), 3)]
     actual = [group for _, group in
               accrual.AccrualPostings.make_consistent(data.Posting.from_entries(entries))]
     assert len(actual) == 2
     assert len(actual[0]) == 2
     assert actual[0][0].units.number == 40
     assert actual[0][1].units.number == -20
     assert len(actual[1]) == 1
     assert actual[1][0].meta.date.day == 3
 def test_make_consistent_by_date_with_overpayment():
     meta = {'rt-id': '1', 'invoice': 'rt:1/5', 'entity': 'OverPayment'}
     entries = [testutil.Transaction(date=date, postings=[(
         'Assets:Receivable:Accounts',
 * (1 if date.day % 2 else -1.5),
         meta,
     )]) for date in itertools.islice(testutil.date_seq(), 3)]
     actual = [group for _, group in
               accrual.AccrualPostings.make_consistent(data.Posting.from_entries(entries))]
     assert len(actual) == 2
     assert sum(post.units.number for post in actual[0]) == 0
     assert len(actual[1]) == 2
     assert actual[1][0].meta.date.day == 2
     assert actual[1][0].units.number == -25
     assert actual[1][1].meta.date.day == 3
 def test_make_consistent_by_date_with_late_payment():
     meta = {'rt-id': '1', 'invoice': 'rt:1/6', 'entity': 'LatePayment'}
     entries = [testutil.Transaction(date=date, postings=[(
         'Assets:Receivable:Accounts',
 * (-1 if date.day > 2 else 1),
         meta,
     )]) for date in itertools.islice(testutil.date_seq(), 3)]
     actual = [group for _, group in
               accrual.AccrualPostings.make_consistent(data.Posting.from_entries(entries))]
     assert len(actual) == 2
     assert len(actual[0]) == 2
     assert actual[0][0].meta.date.day == 1
     assert actual[0][1].meta.date.day == 3
     assert len(actual[1]) == 1
     assert actual[1][0].meta.date.day == 2
 def test_make_consistent_by_date_with_split_payments():
     meta = {'rt-id': '1', 'invoice': 'rt:1/7', 'entity': 'SplitPayments'}
     entries = [testutil.Transaction(date=date, postings=[(
         'Assets:Receivable:Accounts', amount, meta,
     )]) for date, amount in zip(testutil.date_seq(), [70, 80, -50, -100])]
     actual = [group for _, group in
               accrual.AccrualPostings.make_consistent(data.Posting.from_entries(entries))]
     assert len(actual) == 2
     assert [post.units.number for post in actual[0]] == [70, -50, -20]
     assert [post.units.number for post in actual[1]] == [80, -80]
 @pytest.mark.parametrize('account,day', itertools.product(
     ACCOUNTS,
     [1, 10, 20, 30],
 ))
 def test_make_consistent_with_three_one_split(account, day):
     meta = {'rt-id': '1', 'invoice': 'rt:1/8', 'entity': '3Split'}
     entries = [testutil.Transaction(date=datetime.date(2019, 5, dd), postings=[(
         account, dd, meta,
     )]) for dd in [5, 15, 25]]
     meta['entity'] = '1Split'
     entries.insert(day // 10, testutil.Transaction(
         date=datetime.date(2019, 5, day),
         postings=[(account, -45, meta)],
     ))
     postings = data.Posting.from_entries(entries)
     actual = dict(accrual.AccrualPostings.make_consistent(iter(postings)))
     if account.startswith('Assets:'):
         group_count = 3
         post_count = 2
     else:
         group_count = 1
         post_count = 4
     assert len(actual) == group_count
     for related in actual.values():
         assert len(related) == post_count
         assert sum(post.units.number for post in related) == 0
         assert all(post.meta['invoice'] == meta['invoice'] for post in related)
         assert {post.meta['entity'] for post in related} == {'1Split', '3Split'}
 @pytest.mark.parametrize('account', ACCOUNTS)
 def test_make_consistent_with_three_two_split(account):
     meta = {'rt-id': '1', 'invoice': 'rt:1/9'}
     entries = [testutil.Transaction(date=datetime.date(2019, 5, day), postings=[(
         account, day * (1 if day % 10 else -1.5), meta,
     )]) for day in range(5, 30, 5)]
     postings = data.Posting.from_entries(entries)
     actual = dict(accrual.AccrualPostings.make_consistent(iter(postings)))
     if account.startswith('Assets:'):
         group_count = 3
     else:
         group_count = 2
     assert len(actual) == group_count
     for related in actual.values():
         assert len(related) >= 2
         assert sum(post.units.number for post in related) == 0
         assert all(post.meta['invoice'] == meta['invoice'] for post in related)
 def check_output(output, expect_patterns):
     output.seek(0)
     testutil.check_lines_match(iter(output), expect_patterns)
 def run_outgoing(rt_id, postings, rt_client=None):
     if rt_client is None:
         rt_client = RTClient()
     rt_wrapper = rtutil.RT(rt_client)
     if not isinstance(postings, accrual.AccrualPostings):
         postings = accruals_by_meta(postings, rt_id, 'rt-id', wrap_type=accrual.AccrualPostings)
     output = io.StringIO()
     report = accrual.OutgoingReport(rt_wrapper, output)
     report.run({rt_id: postings})
     return output
 @pytest.mark.parametrize('invoice,expected', [
     ('rt:505/5050', "Zero balance outstanding since 2010-05-05"),
     ('rt:510/5100', "Zero balance outstanding since 2010-05-10"),
     ('rt:510/6100', "-280.00 USD outstanding since 2010-06-10"),
     ('rt://ticket/515/attachments/5150', "1,500.00 USD outstanding since 2010-05-15",),
 ])
 def test_balance_report(accrual_postings, invoice, expected, caplog):
     related = accruals_by_meta(accrual_postings, invoice, wrap_type=accrual.AccrualPostings)
     output = io.StringIO()
     report = accrual.BalanceReport(output)
     report.run({invoice: related})
     assert not caplog.records
     check_output(output, [invoice, expected])
 def test_outgoing_report(accrual_postings, caplog):
     rt_client = RTClient()
     output = run_outgoing('rt:510', accrual_postings, rt_client)
     rt_url = RTClient.DEFAULT_URL[:-9]
     rt_id_url = rf'\b{re.escape(f"{rt_url}Ticket/Display.html?id=510")}\b'
     contract_url = rf'\b{re.escape(f"{rt_url}Ticket/Attachment/4000/4000/contract.pdf")}\b'
     assert not caplog.records
     check_output(output, [
         r'^PAYMENT FOR APPROVAL:$',
         r'^REQUESTOR: Mx\. 510 <mx510@example\.org>$',
         r'^PAYMENT TO: Hon\. Mx\. 510$',
         r'^TOTAL TO PAY: \$280\.00$',
         fr'^AGREEMENT: {contract_url}',
         r'^BEANCOUNT ENTRIES:$',
     ])
     # Find the date line of the first transaction.
     # For each transaction, check for the date line, a metadata, and the
     # Expenses posting.
     for line in output:
         if not line.isspace():
             break
     assert re.match(r'\s*2010-06-10\s', line), \
         "first entry line did not have expected date"
     check_output(output, [
         fr'^\s+rt-id: "{rt_id_url}"$',
         r'^\s+Expenses:Services:Legal\s+220\.00 USD$',
         r'^\s*2010-06-10\s',
         fr'^\s+contract: "{contract_url}"$',
         r'^\s+Expenses:FilingFees\s+60\.00 USD$',
     ])
     assert rt_client.edits == {'510': {
         'CF_payment-amount': 'USD 280.00',
         'CF_payment-method': 'USD ACH',
     }}
     assert 'payment-method:' not in output.getvalue()
 def test_outgoing_report_custom_field_fallbacks(accrual_postings, caplog):
     rt_client = RTClient(want_cfs=False)
     output = run_outgoing('rt:510', accrual_postings, rt_client)
     assert not caplog.records
     check_output(output, [
         r'^PAYMENT FOR APPROVAL:$',
         r'^REQUESTOR: <mx510@example\.org>$',
         r'^PAYMENT TO:\s*$',
     ])
 def test_outgoing_report_fx_amounts(accrual_postings, caplog):
     rt_client = RTClient()
     output = run_outgoing('rt:520 rt:525', accrual_postings, rt_client)
     assert not caplog.records
     check_output(output, [
         r'^PAYMENT FOR APPROVAL:$',
         r'^REQUESTOR: Mx\. 520 <mx520@example\.org>$',
         r'^TOTAL TO PAY: 1,000\.00 EUR \(\$1,100.00\)$',
     ])
     assert rt_client.edits == {'520': {
         'CF_payment-amount': 'EUR 1,000.00 ($1,100.00)',
         'CF_payment-method': 'EUR Wire',
     }}
     assert 'payment-method:' not in output.getvalue()
 def test_outgoing_report_multi_invoice(accrual_postings, caplog):
     rt_client = RTClient()
     output = run_outgoing('rt:310', accrual_postings, rt_client)
     log, = caplog.records
     assert log.levelname == 'WARNING'
     assert log.message.startswith('cannot set payment-method for rt:310: ')
     check_output(output, [
         r'^PAYMENT FOR APPROVAL:$',
         r'^REQUESTOR: Mx\. 310 <mx310@example\.org>$',
         r'^TOTAL TO PAY: \$420.00$',
     ])
     assert rt_client.edits == {'310': {
         'CF_payment-amount': 'USD 420.00',
     }}
     assert 'payment-method:' not in output.getvalue()
 @pytest.mark.parametrize('arg', [
     'usd ach',
     '  eur  wire',
     'cad   vendorportal  ',
     ' gbp check ',
 ])
 def test_outgoing_report_good_payment_method(caplog, accrual_postings, arg):
     rt_id = 'rt:40'
     meta = {'rt-id': rt_id, 'invoice': 'rt:40/100', 'payment-method': arg}
     txn = testutil.Transaction(postings=[
         ('Liabilities:Payable:Accounts', -100, meta),
     ])
     rt_client = RTClient()
     run_outgoing(rt_id, data.Posting.from_txn(txn), rt_client)
     assert not caplog.records
     cf_values = rt_client.edits[rt_id[3:]]['CF_payment-method'].split()
     assert cf_values[0] == arg.split()[0].upper()
     assert len(cf_values) > 1
 @pytest.mark.parametrize('arg', [
     '',
     'usd',
     'usd nonexistent',
     'check',
     'us check',
     *testutil.NON_STRING_METADATA_VALUES,
 ])
 def test_outgoing_report_bad_payment_method(caplog, accrual_postings, arg):
     rt_id = 'rt:40'
     meta = {'rt-id': rt_id, 'invoice': 'rt:40/100', 'payment-method': arg}
     txn = testutil.Transaction(postings=[
         ('Liabilities:Payable:Accounts', -100, meta),
     ])
     rt_client = RTClient()
     run_outgoing(rt_id, data.Posting.from_txn(txn), rt_client)
     assert caplog.records
     for log in caplog.records:
         assert log.levelname == 'WARNING'
         assert log.message.startswith(f'cannot set payment-method for {rt_id}: ')
     assert 'CF_payment-method' not in rt_client.edits[rt_id[3:]]
 def test_outgoing_report_without_rt_id(accrual_postings, caplog):
     invoice = 'rt://ticket/515/attachments/5150'
     related = accruals_by_meta(
         accrual_postings, invoice, wrap_type=accrual.AccrualPostings,
+    )
     output = run_outgoing(None, related)
     assert caplog.records
     log = caplog.records[0]
     assert log.message.startswith(
         f"can't generate outgoings report for 2010-05-15 MatchingProgram {invoice}"
         " because no RT ticket available:",
+    )
     assert not output.getvalue()
 def run_aging_report(postings, today):
     postings = (
         post for post in postings
         if post.account.is_under('Assets:Receivable', 'Liabilities:Payable')
+    )
     groups = dict(accrual.AccrualPostings.make_consistent(postings))
     output = io.BytesIO()
     rt_wrapper = rtutil.RT(RTClient())
     report = accrual.AgingReport(rt_wrapper, output, today)
     report.run(groups)
     return output
 @pytest.mark.parametrize('date', [
     datetime.date(2010, 3, 1),
     # Both these dates are chosen for their off-by-one potential:
     # the first is exactly 30 days after the 2010-06-10 payable;
     # the second is exactly 60 days after the 2010-05-15 receivable.
     datetime.date(2010, 7, 10),
     datetime.date(2010, 7, 14),
     # The remainder just shuffle the age buckets some.
     datetime.date(2010, 12, 1),
     datetime.date(2011, 6, 1),
     datetime.date(2011, 12, 1),
     datetime.date(2012, 3, 1),
 ])
 def test_aging_report_date_cutoffs(accrual_postings, date):
     output = run_aging_report(accrual_postings, date)
     check_aging_ods(output, date)
 def test_aging_report_entity_consistency(accrual_postings):
     date = datetime.date.today()
     output = run_aging_report((
         post for post in accrual_postings
         if post.meta.get('rt-id') == 'rt:480'
         and post.units.number < 0
     ), date)
     check_aging_ods(output, date, [], [
         AgingRow.make_simple('2010-04-15', 'MultiPartyA', 125, 'rt:480/4800'),
         AgingRow.make_simple('2010-04-15', 'MultiPartyB', 125, 'rt:480/4800'),
     ])
 def run_main(arglist, config=None, out_type=io.StringIO):
     if config is None:
         config = testutil.TestConfig(
             books_path=testutil.test_path('books/accruals.beancount'),
             rt_client=RTClient(),
+        )
     if out_type is io.BytesIO:
         arglist.insert(0, '--output-file=-')
     output = out_type()
     errors = io.StringIO()
     retcode = accrual.main(arglist, output, errors, config)
     output.seek(0)
     errors.seek(0)
     return retcode, output, errors
 def check_main_fails(arglist, config, error_flags):
     retcode, output, errors = run_main(arglist, config)
     assert retcode > 16
     assert (retcode - 16) & error_flags
     assert not output.getvalue()
     return errors
 @pytest.mark.parametrize('arglist', [
     ['--report-type=balance', 'entity=EarlyBird'],
     ['--report-type=outgoing', 'entity=EarlyBird'],
 ])
 def test_output_excludes_payments(arglist):
     retcode, output, errors = run_main(arglist)
     assert not errors.getvalue()
     assert retcode == 0
     output.seek(0)
     for line in output:
         assert not re.match(r'\brt:4\d\b', line)
 @pytest.mark.parametrize('arglist,expect_invoice', [
     (['40'], 'rt:40/400'),
     (['44/440'], 'rt:44/440'),
 ])
 def test_output_payments_when_only_match(arglist, expect_invoice):
     retcode, output, errors = run_main(arglist)
     assert not errors.getvalue()
     assert retcode == 0
     check_output(output, [
         rf'^EarlyBird {re.escape(expect_invoice)}:$',
         r' outstanding since ',
     ])
 @pytest.mark.parametrize('arglist,expect_amount', [
     (['310'], 420),
     (['310/3120'], 220),
     (['-t', 'out', 'entity=Vendor'], 420),
 ])
 def test_main_outgoing_report(arglist, expect_amount):
     retcode, output, errors = run_main(arglist)
     assert not errors.getvalue()
     assert retcode == 0
     rt_url = RTClient.DEFAULT_URL[:-9]
     rt_id_url = re.escape(f'<{rt_url}Ticket/Display.html?id=310>')
     contract_url = re.escape(f'<{rt_url}Ticket/Attachment/3120/3120/VendorContract.pdf>')
     check_output(output, [
         r'^REQUESTOR: Mx\. 310 <mx310@example\.org>$',
         rf'^TOTAL TO PAY: \${expect_amount}\.00$',
         r'^\s*2010-04-30\s',
         r'^\s+Expenses:Travel\s+220 USD$',
     ])
 @pytest.mark.parametrize('arglist', [
     ['-t', 'balance'],
     ['515/5150'],
 ])
 def test_main_balance_report(arglist):
     retcode, output, errors = run_main(arglist)
     assert not errors.getvalue()
     assert retcode == 0
     check_output(output, [
         r'\brt://ticket/515/attachments/5150:$',
         r'^\s+1,500\.00 USD outstanding since 2010-05-15$',
     ])
 def test_main_balance_report_because_no_rt_id():
     invoice = 'Invoices/2010StateRegistration.pdf'
     retcode, output, errors = run_main([invoice])
     assert not errors.getvalue()
     assert retcode == 0
     check_output(output, [
         rf'\b{re.escape(invoice)}:$',
         r'^\s+-50\.00 USD outstanding since 2010-06-20$',
     ])
 @pytest.mark.parametrize('arglist', [
     [],
     ['entity=Lawyer'],
 ])
 def test_main_aging_report(arglist):
     if arglist:
         recv_rows = [row for row in AGING_AR if 'Lawyer' in row.entity]
         pay_rows = [row for row in AGING_AP if 'Lawyer' in row.entity]
     else:
         recv_rows = AGING_AR
         pay_rows = AGING_AP
     retcode, output, errors = run_main(arglist, out_type=io.BytesIO)
     assert not errors.getvalue()
     assert retcode == 0
     check_aging_ods(output, datetime.date.today(), recv_rows, pay_rows)
 def test_main_no_books():
-    errors = check_main_fails([], testutil.TestConfig(), 1 | 8)
+    errors = check_main_fails([], testutil.TestConfig(), 1 | 2)
     testutil.check_lines_match(iter(errors), [
         r':[01]: +no books to load in configuration\b',
     ])
 @pytest.mark.parametrize('arglist', [
     ['499'],
     ['505/99999'],
     ['-t', 'balance', 'entity=NonExistent'],
 ])
 def test_main_no_matches(arglist, caplog):
-    check_main_fails(arglist, None, 8)
+    check_main_fails(arglist, None, 2)
     testutil.check_logs_match(caplog, [
         ('WARNING', 'no matching entries found to report'),
     ])
 def test_main_no_rt(caplog):
     config = testutil.TestConfig(
         books_path=testutil.test_path('books/accruals.beancount'),
+    )
-    check_main_fails(['-t', 'out'], config, 4)
+    check_main_fails(['-t', 'out'], config, 16)
     testutil.check_logs_match(caplog, [
         ('ERROR', 'unable to generate outgoing report: RT client is required'),
     ])

tests/test_reports_fund.py

➞

Show inline comments

 """test_reports_fund.py - Unit tests for fund report"""
 # Copyright © 2020  Brett Smith
+#
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (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 pytest
 from . import testutil
 import babel.numbers
 import odf.opendocument
 import odf.table
 from beancount import loader as bc_loader
 from conservancy_beancount import data
 from conservancy_beancount.reports import core
 from conservancy_beancount.reports import fund
 from decimal import Decimal
 _ledger_load = bc_loader.load_file(testutil.test_path('books/fund.beancount'))
 START_DATE = datetime.date(2018, 3, 1)
 MID_DATE = datetime.date(2019, 3, 1)
 STOP_DATE = datetime.date(2020, 3, 1)
 EQUITY_ROOT_ACCOUNTS = ('Expenses:', 'Equity:', 'Income:')
 OPENING_BALANCES = {
     'Alpha': 3000,
     'Bravo': 2000,
     'Charlie': 1000,
     'Conservancy': 4000,
     'Delta': 0,
+}
 BALANCES_BY_YEAR = {
     ('Conservancy', 2018): [
         ('Income:Other', 40),
         ('Expenses:Other', -4),
         ('Assets:Receivable:Accounts', 40),
         ('Liabilities:Payable:Accounts', 4),
     ],
     ('Conservancy', 2019): [
         ('Income:Other', 42),
         ('Expenses:Other', Decimal('-4.20')),
         ('Equity:Realized:CurrencyConversion', Decimal('6.20')),
         ('Assets:Receivable:Accounts', -40),
         ('Liabilities:Payable:Accounts', -4),
     ],
     ('Alpha', 2018): [
         ('Income:Other', 60),
         ('Liabilities:UnearnedIncome', 30),
         ('Assets:Prepaid:Expenses', 20),
     ],
     ('Alpha', 2019): [
         ('Income:Other', 30),
         ('Expenses:Other', -26),
         ('Assets:Prepaid:Expenses', -20),
         ('Liabilities:UnearnedIncome', -30),
     ],
     ('Bravo', 2018): [
         ('Expenses:Other', -20),
     ],
     ('Bravo', 2019): [
         ('Income:Other', 200),
     ],
     ('Delta', 2018): [
         ('Income:Other', Decimal('.40')),
     ],
     ('Delta', 2019): [
         ('Income:Other', Decimal('4.60')),
     ],
+}
 @pytest.fixture
 def fund_entries():
     return copy.deepcopy(_ledger_load[0])
 def split_text_lines(output):
     for line in output:
         account, amount = line.rsplit(None, 1)
         yield account.strip(), amount
 def format_amount(amount, currency='USD'):
     return babel.numbers.format_currency(
         amount, currency, format_type='accounting',
+    )
 def check_text_balances(actual, expected, *expect_accounts):
     balance = Decimal()
     for expect_account in expect_accounts:
         expect_amount = expected[expect_account]
         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)
     for year in range(2018, stop_date.year):
         try:
             amounts = BALANCES_BY_YEAR[(project, year)]
         except KeyError:
             pass
         else:
             for account, amount in amounts:
                 if year < start_date.year and account.startswith(EQUITY_ROOT_ACCOUNTS):
                     balance_amount += amount
                 else:
                     expected[account] += amount
     actual = split_text_lines(output)
     next(actual); next(actual)  # Discard headers
     open_acct, open_amt = next(actual)
     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,
         'Equity:Realized:CurrencyConversion',
         'Income:Other',
         'Expenses:Other',
+    )
     end_acct, end_amt = next(actual)
     assert end_acct == "{} balance as of {}".format(
         project, stop_date.isoformat(),
+    )
     assert end_amt == format_amount(balance_amount)
     balance_amount += check_text_balances(
         actual, expected,
         'Assets:Receivable:Accounts',
         'Assets:Prepaid:Expenses',
         'Liabilities:Payable:Accounts',
         'Liabilities:UnearnedIncome',
+    )
     assert next(actual, None) is None
 def check_cell_balance(cell, balance):
     if balance:
         assert cell.value == balance
     else:
         assert not cell.value
 def check_ods_sheet(sheet, account_balances, *, full):
     if full:
         account_bals = account_balances.copy()
         account_bals['Unrestricted'] = account_bals.pop('Conservancy')
     else:
         account_bals = {
             key: balances
             for key, balances in account_balances.items()
             if key != 'Conservancy' and any(v >= .5 for v in balances.values())
+        }
         totals = {key: Decimal() for key in
                   ['opening', 'Income', 'Expenses', 'Equity:Realized']}
         for fund, balances in account_bals.items():
             for key in totals:
                 totals[key] += balances[key]
         account_bals[''] = totals
     for row in itertools.islice(sheet.getElementsByType(odf.table.TableRow), 4, None):
         cells = iter(testutil.ODSCell.from_row(row))
         try:
             fund = next(cells).firstChild.text
         except (AttributeError, StopIteration):
             continue
         try:
             balances = account_bals.pop(fund)
         except KeyError:
             pytest.fail(f"report included unexpected fund {fund}")
         check_cell_balance(next(cells), balances['opening'])
         check_cell_balance(next(cells), balances['Income'])
         check_cell_balance(next(cells), -balances['Expenses'])
         if full:
             check_cell_balance(next(cells), balances['Equity:Realized'])
         check_cell_balance(next(cells), sum(balances[key] for key in [
             'opening', 'Income', 'Expenses', 'Equity:Realized',
         ]))
         if full:
             check_cell_balance(next(cells), balances['Assets:Receivable'])
             check_cell_balance(next(cells), balances['Assets:Prepaid'])
             check_cell_balance(next(cells), balances['Liabilities'])
             check_cell_balance(next(cells), balances['Liabilities:Payable'])
         assert next(cells, None) is None
     assert not account_bals, "did not see all funds in report"
 def check_ods_report(ods, start_date, stop_date):
     account_bals = collections.OrderedDict((key, {
         'opening': Decimal(amount),
         'Income': Decimal(0),
         'Expenses': Decimal(0),
         'Equity:Realized': Decimal(0),
         'Assets:Receivable': Decimal(0),
         'Assets:Prepaid': Decimal(0),
         'Liabilities:Payable': Decimal(0),
         'Liabilities': Decimal(0),  # UnearnedIncome
     }) for key, amount in sorted(OPENING_BALANCES.items()))
     for fund, year in itertools.product(account_bals, range(2018, stop_date.year)):
         try:
             amounts = BALANCES_BY_YEAR[(fund, year)]
         except KeyError:
             pass
         else:
             for account, amount in amounts:
                 if year < start_date.year and account.startswith(EQUITY_ROOT_ACCOUNTS):
                     acct_key = 'opening'
                 else:
                     acct_key, _, _ = account.rpartition(':')
                 account_bals[fund][acct_key] += amount
     sheets = iter(ods.getElementsByType(odf.table.Table))
     check_ods_sheet(next(sheets), account_bals, full=False)
     check_ods_sheet(next(sheets), account_bals, full=True)
     assert next(sheets, None) is None, "found unexpected sheet"
 def run_main(out_type, arglist, config=None):
     if config is None:
         config = testutil.TestConfig(
             books_path=testutil.test_path('books/fund.beancount'),
+        )
     arglist.insert(0, '--output-file=-')
     output = out_type()
     errors = io.StringIO()
     retcode = fund.main(arglist, output, errors, config)
     output.seek(0)
     return retcode, output, errors
 @pytest.mark.parametrize('project,start_date,stop_date', [
     ('Conservancy', START_DATE, STOP_DATE),
     ('project=Conservancy', MID_DATE, STOP_DATE),
     ('Conservancy', START_DATE, MID_DATE),
     ('Alpha', START_DATE, STOP_DATE),
     ('project=Alpha', MID_DATE, STOP_DATE),
     ('Alpha', START_DATE, MID_DATE),
     ('Bravo', START_DATE, STOP_DATE),
     ('project=Bravo', MID_DATE, STOP_DATE),
     ('Bravo', START_DATE, MID_DATE),
     ('project=Charlie', START_DATE, STOP_DATE),
 ])
 def test_text_report(project, start_date, stop_date):
     retcode, output, errors = run_main(io.StringIO, [
         '-b', start_date.isoformat(), '-e', stop_date.isoformat(), project,
     ])
     assert not errors.getvalue()
     assert retcode == 0
     check_text_report(output, project, start_date, stop_date)
 @pytest.mark.parametrize('start_date,stop_date', [
     (START_DATE, STOP_DATE),
     (MID_DATE, STOP_DATE),
     (START_DATE, MID_DATE),
 ])
 def test_ods_report(start_date, stop_date):
     retcode, output, errors = run_main(io.BytesIO, [
         '--begin', start_date.isoformat(), '--end', stop_date.isoformat(),
     ])
     assert not errors.getvalue()
     assert retcode == 0
     ods = odf.opendocument.load(output)
     check_ods_report(ods, start_date, stop_date)
 def test_main_no_postings(caplog):
     retcode, output, errors = run_main(io.StringIO, ['NonexistentProject'])
-    assert retcode == 24
+    assert retcode == 18
     assert any(log.levelname == 'WARNING' for log in caplog.records)

tests/test_reports_ledger.py

➞

Show inline comments

 """test_reports_ledger.py - Unit tests for general ledger report"""
 # Copyright © 2020  Brett Smith
+#
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (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 contextlib
 import copy
 import datetime
 import io
 import itertools
 import re
 import pytest
 from . import testutil
 import odf.table
 import odf.text
 from beancount.core import data as bc_data
 from beancount import loader as bc_loader
 from conservancy_beancount import data
 from conservancy_beancount.reports import core
 from conservancy_beancount.reports import ledger
 clean_account_meta = contextlib.contextmanager(testutil.clean_account_meta)
 Acct = data.Account
 _ledger_load = bc_loader.load_file(testutil.test_path('books/ledger.beancount'))
 DEFAULT_REPORT_SHEETS = [
     'Balance',
     'Income',
     'Expenses',
     'Equity',
     'Assets:Receivable',
     'Liabilities:Payable',
     'Assets:PayPal',
     'Assets',
     'Liabilities',
+]
 PROJECT_REPORT_SHEETS = DEFAULT_REPORT_SHEETS[:5] + [
     'Assets:Prepaid',
     'Liabilities:UnearnedIncome',
     'Liabilities:Payable',
+]
 del PROJECT_REPORT_SHEETS[3]
 OVERSIZE_RE = re.compile(
     r'^([A-Za-z0-9:]+) has ([0-9,]+) rows, over size ([0-9,]+)$'
+)
 START_DATE = datetime.date(2018, 3, 1)
 MID_DATE = datetime.date(2019, 3, 1)
 STOP_DATE = datetime.date(2020, 3, 1)
 REPORT_KWARGS = [
     {'report_class': ledger.LedgerODS},
     *({'report_class': ledger.TransactionODS, 'txn_filter': flags}
       for flags in ledger.TransactionFilter),
+]
 @pytest.fixture
 def ledger_entries():
     return copy.deepcopy(_ledger_load[0])
 def iter_accounts(entries):
     for entry in entries:
         if isinstance(entry, bc_data.Open):
             yield entry.account
 class NotFound(Exception): pass
 class NoSheet(NotFound): pass
 class NoHeader(NotFound): pass
 class ExpectedPostings(core.RelatedPostings):
     @classmethod
     def find_section(cls, ods, account):
         for sheet in ods.getElementsByType(odf.table.Table):
             sheet_account = sheet.getAttribute('name').replace(' ', ':')
             if sheet_account and account.is_under(sheet_account):
                 break
         else:
             raise NoSheet(account)
         rows = iter(sheet.getElementsByType(odf.table.TableRow))
         for row in rows:
             cells = row.childNodes
             if len(cells) == 2 and cells[-1].text.startswith(f'{account} '):
                 break
         else:
             raise NoHeader(account)
         return rows
     @classmethod
     def check_not_in_report(cls, ods, *accounts):
         for account in accounts:
             with pytest.raises(NotFound):
                 cls.find_section(ods, data.Account(account))
     @classmethod
     def check_in_report(cls, ods, account,
                         start_date=START_DATE, end_date=STOP_DATE, txn_filter=None):
         date = end_date + datetime.timedelta(days=1)
         txn = testutil.Transaction(date=date, postings=[
             (account, 0),
         ])
         related = cls(data.Posting.from_txn(txn))
         if txn_filter is None:
             related.check_report(ods, start_date, end_date)
         else:
             related.check_txn_report(ods, txn_filter, start_date, end_date)
     def slice_date_range(self, start_date, end_date):
         postings = enumerate(self)
         for start_index, post in postings:
             if start_date <= post.meta.date:
                 break
         else:
             start_index += 1
         if end_date <= post.meta.date:
             end_index = start_index
         else:
             for end_index, post in postings:
                 if end_date <= post.meta.date:
                     break
             else:
                 end_index = None
         return (self[:start_index].balance_at_cost(),
                 self[start_index:end_index])
     def check_report(self, ods, start_date, end_date, expect_totals=True):
         account = self[0].account
         norm_func = core.normalize_amount_func(account)
         open_bal, expect_posts = self.slice_date_range(start_date, end_date)
         open_bal = norm_func(open_bal)
         closing_bal = norm_func(expect_posts.balance_at_cost())
         rows = self.find_section(ods, account)
         if expect_totals and account.is_under('Assets', 'Liabilities'):
             opening_row = testutil.ODSCell.from_row(next(rows))
             assert opening_row[0].value == start_date
             assert opening_row[4].text == open_bal.format(None, empty='0', sep='\0')
             closing_bal += open_bal
         for expected in expect_posts:
             cells = iter(testutil.ODSCell.from_row(next(rows)))
             assert next(cells).value == expected.meta.date
             assert next(cells).text == (expected.meta.get('entity') or '')
             assert next(cells).text == (expected.meta.txn.narration or '')
             if expected.cost is None:
                 assert not next(cells).text
                 assert next(cells).value == norm_func(expected.units.number)
             else:
                 assert next(cells).value == norm_func(expected.units.number)
                 assert next(cells).value == norm_func(expected.at_cost().number)
         if expect_totals:
             closing_row = testutil.ODSCell.from_row(next(rows))
             assert closing_row[0].value == end_date
             empty = '$0.00' if expect_posts else '0'
             assert closing_row[4].text == closing_bal.format(None, empty=empty, sep='\0')
     def _post_data_from_row(self, row):
         if row[4].text:
             number = row[4].value
             match = re.search(r'([A-Z]{3})\d*Cell', row[4].getAttribute('stylename') or '')
             assert match
             currency = match.group(1)
         else:
             number = row[5].value
             currency = 'USD'
         return (row[2].text, row[3].text, number, currency)
     def _post_data_from_post(self, post, norm_func):
         return (
             post.account,
             post.meta.get('entity') or '',
             norm_func(post.units.number),
             post.units.currency,
+        )
     def check_txn_report(self, ods, txn_filter, start_date, end_date, expect_totals=True):
         account = self[0].account
         norm_func = core.normalize_amount_func(account)
         open_bal, expect_posts = self.slice_date_range(start_date, end_date)
         open_bal = norm_func(open_bal)
         period_bal = core.MutableBalance()
         rows = self.find_section(ods, account)
         if (expect_totals
             and txn_filter == ledger.TransactionFilter.ALL
             and account.is_under('Assets', 'Liabilities')):
             opening_row = testutil.ODSCell.from_row(next(rows))
             assert opening_row[0].value == start_date
             assert opening_row[5].text == open_bal.format(None, empty='0', sep='\0')
             period_bal += open_bal
         last_txn = None
         for post in expect_posts:
             txn = post.meta.txn
             post_flag = ledger.TransactionFilter.post_flag(post)
             if txn is last_txn or (not txn_filter & post_flag):
                 continue
             last_txn = txn
             row1 = testutil.ODSCell.from_row(next(rows))
             assert row1[0].value == txn.date
             assert row1[1].text == (txn.narration or '')
             expected = {self._post_data_from_post(post, norm_func)
                         for post in txn.postings}
             actual = {self._post_data_from_row(testutil.ODSCell.from_row(row))
                       for row in itertools.islice(rows, len(txn.postings) - 1)}
             actual.add(self._post_data_from_row(row1))
             assert actual == expected
             for post_acct, _, number, currency in expected:
                 if post_acct == account:
                     period_bal += testutil.Amount(number, currency)
         if expect_totals:
             closing_row = testutil.ODSCell.from_row(next(rows))
             assert closing_row[0].value == end_date
             empty = '$0.00' if period_bal else '0'
             assert closing_row[5].text == period_bal.format(None, empty=empty, sep='\0')
 def get_sheet_names(ods):
     return [sheet.getAttribute('name').replace(' ', ':')
             for sheet in ods.getElementsByType(odf.table.Table)]
 def check_oversize_logs(caplog, accounts, sheet_size):
     actual = {}
     for log in caplog.records:
         match = OVERSIZE_RE.match(log.message)
         if match:
             assert int(match.group(3).replace(',', '')) == sheet_size
             actual[match.group(1)] = int(match.group(2).replace(',', ''))
     expected = {name: size for name, size in accounts.items() if size > sheet_size}
     assert actual == expected
 def test_plan_sheets_no_change():
     have = {
         Acct('Assets:Cash'): 10,
         Acct('Income:Donations'): 20,
+    }
     want = ['Assets', 'Income']
     actual = ledger.LedgerODS.plan_sheets(have, want.copy(), 100)
     assert actual == want
 @pytest.mark.parametrize('have', [
     {},
     {Acct('Income:Other'): 10},
     {Acct('Assets:Checking'): 20, Acct('Expenses:Other'): 15},
 ])
 def test_plan_sheets_includes_accounts_without_transactions(have):
     want = ['Assets', 'Income', 'Expenses']
     actual = ledger.LedgerODS.plan_sheets(have, want.copy(), 100)
     assert actual == want
 def test_plan_sheets_single_split():
     have = {
         Acct('Assets:Cash'): 60,
         Acct('Assets:Checking'): 80,
         Acct('Income:Donations'): 50,
         Acct('Expenses:Travel'): 90,
         Acct('Expenses:FilingFees'): 25,
+    }
     want = ['Assets', 'Income', 'Expenses']
     actual = ledger.LedgerODS.plan_sheets(have, want, 100)
     assert actual == [
         'Assets:Checking',
         'Assets',
         'Income',
         'Expenses:Travel',
         'Expenses',
+    ]
 def test_plan_sheets_split_subtree():
     have = {
         Acct('Assets:Bank1:Checking'): 80,
         Acct('Assets:Bank1:Savings'): 10,
         Acct('Assets:Cash:USD'): 20,
         Acct('Assets:Cash:EUR'): 15,
+    }
     actual = ledger.LedgerODS.plan_sheets(have, ['Assets'], 100)
     assert actual == ['Assets:Bank1', 'Assets']
 def test_plan_sheets_ambiguous_split():
     have = {
         Acct('Assets:Bank1:Checking'): 80,
         Acct('Assets:Bank1:Savings'): 40,
         Acct('Assets:Receivable:Accounts'): 40,
         Acct('Assets:Cash'): 10,
+    }
     actual = ledger.LedgerODS.plan_sheets(have, ['Assets'], 100)
     # :Savings cannot fit with :Checking, so it's important that the return
     # value disambiguate that.
     assert actual == ['Assets:Bank1:Checking', 'Assets']
 def test_plan_sheets_oversize(caplog):
     have = {
         Acct('Assets:Checking'): 150,
         Acct('Assets:Cash'): 50,
+    }
     actual = ledger.LedgerODS.plan_sheets(have, ['Assets'], 100)
     assert actual == ['Assets:Checking', 'Assets']
     check_oversize_logs(caplog, have, 100)
 def test_plan_sheets_all_oversize(caplog):
     have = {
         Acct('Assets:Checking'): 150,
         Acct('Assets:Cash'): 150,
+    }
     actual = ledger.LedgerODS.plan_sheets(have, ['Assets'], 100)
     # In this case, each account should appear in alphabetical order.
     assert actual == ['Assets:Cash', 'Assets:Checking']
     check_oversize_logs(caplog, have, 100)
 def test_plan_sheets_full_split_required(caplog):
     have = {
         Acct('Assets:Bank:Savings'): 98,
         Acct('Assets:Bank:Checking'): 96,
         Acct('Assets:Bank:Investment'): 94,
+    }
     actual = ledger.LedgerODS.plan_sheets(have, ['Assets'], 100)
     assert actual == ['Assets:Bank:Checking', 'Assets:Bank:Savings', 'Assets']
     assert not caplog.records
 def build_report(ledger_entries, start_date, stop_date, *args,
                  report_class=ledger.LedgerODS, **kwargs):
     postings = list(data.Posting.from_entries(iter(ledger_entries)))
     with clean_account_meta():
         data.Account.load_openings_and_closings(iter(ledger_entries))
         report = report_class(start_date, stop_date, *args, **kwargs)
         report.write(iter(postings))
     return postings, report
 @pytest.mark.parametrize('report_kwargs', iter(REPORT_KWARGS))
 @pytest.mark.parametrize('start_date,stop_date', [
     (START_DATE, STOP_DATE),
     (START_DATE, MID_DATE),
     (MID_DATE, STOP_DATE),
     (START_DATE.replace(month=6), START_DATE.replace(month=12)),
     (STOP_DATE, STOP_DATE.replace(month=12)),
 ])
 def test_date_range_report(ledger_entries, start_date, stop_date, report_kwargs):
     txn_filter = report_kwargs.get('txn_filter')
     postings, report = build_report(ledger_entries, start_date, stop_date, **report_kwargs)
     expected = dict(ExpectedPostings.group_by_account(postings))
     for account in iter_accounts(ledger_entries):
         try:
             related = expected[account]
         except KeyError:
             ExpectedPostings.check_in_report(
                 report.document, account, start_date, stop_date, txn_filter,
+            )
         else:
             if txn_filter is None:
                 related.check_report(report.document, start_date, stop_date)
             else:
                 related.check_txn_report(
                     report.document, txn_filter, start_date, stop_date,
+                )
 @pytest.mark.parametrize('report_kwargs', iter(REPORT_KWARGS))
 @pytest.mark.parametrize('tot_accts', [
     (),
     ('Assets', 'Liabilities'),
     ('Income', 'Expenses'),
     ('Assets', 'Liabilities', 'Income', 'Expenses'),
 ])
 def test_report_filter_totals(ledger_entries, tot_accts, report_kwargs):
     txn_filter = report_kwargs.get('txn_filter')
     postings, report = build_report(ledger_entries, START_DATE, STOP_DATE,
                                     totals_with_entries=tot_accts,
                                     totals_without_entries=tot_accts,
                                     **report_kwargs)
     expected = dict(ExpectedPostings.group_by_account(postings))
     for account in iter_accounts(ledger_entries):
         expect_totals = account.startswith(tot_accts)
         if account in expected and expected[account][-1].meta.date >= START_DATE:
             if txn_filter is None:
                 expected[account].check_report(
                     report.document, START_DATE, STOP_DATE, expect_totals=expect_totals,
+                )
             else:
                 expected[account].check_txn_report(
                     report.document, txn_filter,
                     START_DATE, STOP_DATE, expect_totals=expect_totals,
+                )
         elif expect_totals:
             ExpectedPostings.check_in_report(
                 report.document, account, START_DATE, STOP_DATE, txn_filter,
+            )
         else:
             ExpectedPostings.check_not_in_report(report.document, account)
 @pytest.mark.parametrize('report_kwargs', iter(REPORT_KWARGS))
 @pytest.mark.parametrize('accounts', [
     ('Income', 'Expenses'),
     ('Assets:Receivable', 'Liabilities:Payable'),
 ])
 def test_account_names_report(ledger_entries, accounts, report_kwargs):
     txn_filter = report_kwargs.get('txn_filter')
     postings, report = build_report(ledger_entries, START_DATE, STOP_DATE,
                                     accounts, **report_kwargs)
     expected = dict(ExpectedPostings.group_by_account(postings))
     for account in iter_accounts(ledger_entries):
         if not account.startswith(accounts):
             ExpectedPostings.check_not_in_report(report.document, account)
         elif txn_filter is None:
             expected[account].check_report(report.document, START_DATE, STOP_DATE)
         else:
             expected[account].check_txn_report(
                 report.document, txn_filter, START_DATE, STOP_DATE,
+            )
 def run_main(arglist, config=None):
     if config is None:
         config = testutil.TestConfig(
             books_path=testutil.test_path('books/ledger.beancount'),
             rt_client=testutil.RTClient(),
+        )
     arglist.insert(0, '--output-file=-')
     output = io.BytesIO()
     errors = io.StringIO()
     with clean_account_meta():
         retcode = ledger.main(arglist, output, errors, config)
     output.seek(0)
     return retcode, output, errors
 def test_main(ledger_entries):
     retcode, output, errors = run_main([
         '-b', START_DATE.isoformat(),
         '-e', STOP_DATE.isoformat(),
     ])
     output.seek(0)
     assert not errors.getvalue()
     assert retcode == 0
     ods = odf.opendocument.load(output)
     assert get_sheet_names(ods) == DEFAULT_REPORT_SHEETS[:]
     postings = data.Posting.from_entries(iter(ledger_entries))
     expected = dict(ExpectedPostings.group_by_account(postings))
     for account in iter_accounts(ledger_entries):
         try:
             expected[account].check_report(ods, START_DATE, STOP_DATE)
         except KeyError:
             ExpectedPostings.check_in_report(ods, account)
 @pytest.mark.parametrize('acct_arg', [
     'Liabilities',
     'Accounts payable',
 ])
 def test_main_account_limit(ledger_entries, acct_arg):
     retcode, output, errors = run_main([
         '-a', acct_arg,
         '-b', START_DATE.isoformat(),
         '-e', STOP_DATE.isoformat(),
     ])
     assert not errors.getvalue()
     assert retcode == 0
     ods = odf.opendocument.load(output)
     assert get_sheet_names(ods) == ['Balance', 'Liabilities']
     postings = data.Posting.from_entries(ledger_entries)
     for account, expected in ExpectedPostings.group_by_account(postings):
         if account == 'Liabilities:UnearnedIncome':
             should_find = acct_arg == 'Liabilities'
         else:
             should_find = account.startswith('Liabilities')
         try:
             expected.check_report(ods, START_DATE, STOP_DATE)
         except NotFound:
             assert not should_find
         else:
             assert should_find
 def test_main_account_classification_splits_hierarchy(ledger_entries):
     retcode, output, errors = run_main([
         '-a', 'Cash',
         '-b', START_DATE.isoformat(),
         '-e', STOP_DATE.isoformat(),
     ])
     assert not errors.getvalue()
     assert retcode == 0
     ods = odf.opendocument.load(output)
     assert get_sheet_names(ods) == ['Balance', 'Assets']
     postings = data.Posting.from_entries(ledger_entries)
     for account, expected in ExpectedPostings.group_by_account(postings):
         should_find = (account == 'Assets:Checking' or account == 'Assets:PayPal')
         try:
             expected.check_report(ods, START_DATE, STOP_DATE)
         except NotFound:
             assert not should_find, f"{account} not found in report"
         else:
             assert should_find, f"{account} in report but should be excluded"
 @pytest.mark.parametrize('project,start_date,stop_date', [
     ('eighteen', START_DATE, MID_DATE.replace(day=30)),
     ('nineteen', MID_DATE, STOP_DATE),
 ])
 def test_main_project_report(ledger_entries, project, start_date, stop_date):
     postings = data.Posting.from_entries(iter(ledger_entries))
     for key, related in ExpectedPostings.group_by_meta(postings, 'project'):
         if key == project:
             break
     assert key == project
     retcode, output, errors = run_main([
         f'--begin={start_date.isoformat()}',
         f'--end={stop_date.isoformat()}',
         project,
     ])
     assert not errors.getvalue()
     assert retcode == 0
     ods = odf.opendocument.load(output)
     assert get_sheet_names(ods) == PROJECT_REPORT_SHEETS[:]
     expected = dict(ExpectedPostings.group_by_account(related))
     for account in iter_accounts(ledger_entries):
         try:
             expected[account].check_report(ods, start_date, stop_date)
         except KeyError:
             ExpectedPostings.check_not_in_report(ods, account)
 @pytest.mark.parametrize('flag', [
     '--disbursements',
     '--receipts',
 ])
 def test_main_cash_report(ledger_entries, flag):
     if flag == '--receipts':
         txn_filter = ledger.TransactionFilter.CREDIT
     else:
         txn_filter = ledger.TransactionFilter.DEBIT
     retcode, output, errors = run_main([
         flag,
         '-b', START_DATE.isoformat(),
         '-e', STOP_DATE.isoformat(),
     ])
     assert not errors.getvalue()
     assert retcode == 0
     ods = odf.opendocument.load(output)
     postings = data.Posting.from_entries(ledger_entries)
     for account, expected in ExpectedPostings.group_by_account(postings):
         if account == 'Assets:Checking' or account == 'Assets:PayPal':
             expected.check_txn_report(ods, txn_filter, START_DATE, STOP_DATE)
         else:
             expected.check_not_in_report(ods)
 @pytest.mark.parametrize('arg', [
     'Assets:NoneSuchBank',
     'Funny money',
 ])
 def test_main_invalid_account(caplog, arg):
     retcode, output, errors = run_main(['-a', arg])
     assert retcode == 2
     assert any(log.message.endswith(f': {arg!r}') for log in caplog.records)
 def test_main_no_postings(caplog):
     retcode, output, errors = run_main(['NonexistentProject'])
-    assert retcode == 24
+    assert retcode == 18
     assert any(log.levelname == 'WARNING' for log in caplog.records)

0 comments (0 inline, 0 general)