NPO-Accounting/conservancy_beancount Changeset - cd578289c463

Changeset - cd578289c463

Parent rev.

Child rev.

[Not reviewed]

0 6 0

Brett Smith - 4 years ago 2020-06-12 19:08:08
brettcsmith@brettcsmith.org

cliutil: Add make_entry_point() function.

This provides better logging setup, reduces the amount of boilerplate in
main, and replaces is_main_script().

6 files changed with 60 insertions and 43 deletions:

conservancy_beancount/cliutil.py

conservancy_beancount/reports/accrual.py

setup.py

tests/test_cliutil.py

tests/test_reports_accrual.py

tests/testutil.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 enum
 import inspect
 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 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 is_main_script(prog_name: str) -> bool:
     """Return true if the caller is the "main" program."""
     stack = iter(inspect.stack(context=False))
     next(stack)  # Discard the frame for calling this function
     caller_filename = next(stack).filename
     return all(frame.filename == caller_filename
                or Path(frame.filename).stem == prog_name
                for frame in stack)
 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]='',
                  loglevel: int=logging.INFO,
                  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)
     logger.setLevel(loglevel)
     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
 in the current directory.
 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 for postings from the
 beginning of the last fiscal year. 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 pass
 no search terms, it generates an aging report. If your search terms match a
 single outstanding payable, it writes an outgoing approval report.
 Otherwise, it writes a basic balance report. You can specify what report
 type you want with the ``--report-type`` option::
     # Write an outgoing approval report for all outstanding accruals for
     # Jane Doe, even if there's more than one
     accrual-report --report-type outgoing entity=Doe-Jane
     # Write an aging report for a specific project
     accrual-report --report-type aging project=ProjectName
 """
 # 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 sys
 import urllib.parse as urlparse
 from pathlib import Path
 from typing import (
     cast,
     Any,
     BinaryIO,
     Callable,
     Iterable,
     Iterator,
     List,
     Mapping,
     NamedTuple,
     Optional,
     Sequence,
     Set,
     TextIO,
     Tuple,
     TypeVar,
     Union,
+)
 from ..beancount_types import (
     Entries,
     Error,
     Errors,
     MetaKey,
     MetaValue,
     Transaction,
+)
 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[str], 'AccrualPostings']
 T = TypeVar('T')
 logger = logging.getLogger('conservancy_beancount.reports.accrual')
 class Sentinel:
     pass
 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__ = (
         'accrual_type',
         'end_balance',
         'account',
         'entity',
         'invoice',
+    )
     INCONSISTENT = Sentinel()
     def __init__(self,
                  source: Iterable[data.Posting]=(),
                  *,
                  _can_own: bool=False,
     ) -> None:
         super().__init__(source, _can_own=_can_own)
         self.account = self._single_item(post.account for post in self)
         if isinstance(self.account, Sentinel):
             self.accrual_type: Optional[AccrualAccount] = None
             norm_func: Callable[[T], T] = lambda x: x
             entity_pred: Callable[[data.Posting], bool] = bool
         else:
             self.accrual_type = AccrualAccount.by_account(self.account)
             norm_func = self.accrual_type.normalize_amount
             entity_pred = lambda post: norm_func(post.units).number > 0
         self.entity = self._single_item(self.entities(entity_pred))
         self.invoice = self._single_item(self.first_meta_links('invoice', None))
         self.end_balance = norm_func(self.balance_at_cost())
     def _single_item(self, seq: Iterable[T]) -> Union[T, Sentinel]:
         items = iter(seq)
         try:
             item1 = next(items)
         except StopIteration:
             all_same = False
         else:
             all_same = all(item == item1 for item in items)
         return item1 if all_same else self.INCONSISTENT
     def entities(self, pred: Callable[[data.Posting], bool]=bool) -> Iterator[MetaValue]:
         return filters.iter_unique(
             post.meta['entity']
             for post in self
             if pred(post) and 'entity' in post.meta
+        )
     def make_consistent(self) -> Iterator[Tuple[str, 'AccrualPostings']]:
         account_ok = isinstance(self.account, str)
         entity_ok = isinstance(self.entity, str)
         # `'/' in self.invoice` is just our heuristic to ensure that the
         # invoice metadata is "unique enough," and not just a placeholder
         # value like "FIXME". It can be refined if needed.
         invoice_ok = isinstance(self.invoice, str) and '/' in self.invoice
         if account_ok and entity_ok and invoice_ok:
             # type ignore for <https://github.com/python/mypy/issues/6670>
             yield (self.invoice, self)  # type:ignore[misc]
             return
         groups = collections.defaultdict(list)
         for post in self:
             post_invoice = self.invoice if invoice_ok else (
                 post.meta.get('invoice') or 'BlankInvoice'
+            )
             post_entity = self.entity if entity_ok else (
                 post.meta.get('entity') or 'BlankEntity'
+            )
             groups[f'{post.account} {post_invoice} {post_entity}'].append(post)
         type_self = type(self)
         for group_key, posts in groups.items():
             yield group_key, type_self(posts, _can_own=True)
     def is_paid(self, default: Optional[bool]=None) -> Optional[bool]:
         if self.accrual_type is None:
             return default
         else:
             return self.end_balance.le_zero()
     def is_zero(self, default: Optional[bool]=None) -> Optional[bool]:
         if self.accrual_type is None:
             return default
         else:
             return self.end_balance.is_zero()
     def since_last_nonzero(self) -> 'AccrualPostings':
         for index, (post, balance) in enumerate(self.iter_with_balance()):
             if balance.is_zero():
                 start_index = index
         try:
             empty = start_index == index
         except NameError:
             empty = True
         return self if empty else self[start_index + 1:]
     @property
     def rt_id(self) -> Union[str, None, Sentinel]:
         return self._single_item(self.first_meta_links('rt-id', None))
 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, Optional[data.Account]]):
     COLUMNS = [
         'Date',
         'Entity',
         'Invoice Amount',
         'Booked Amount',
         'Project',
         'Ticket',
         'Invoice',
         'Approval',
         'Contract',
         'Purchase Order',
+    ]
     COL_COUNT = len(COLUMNS)
     def __init__(self,
                  rt_wrapper: rtutil.RT,
                  date: datetime.date,
                  logger: logging.Logger,
     ) -> None:
         super().__init__()
         self.rt_wrapper = rt_wrapper
         self.date = date
         self.logger = logger
     def init_styles(self) -> None:
         super().init_styles()
         self.style_widecol = self.replace_child(
             self.document.automaticstyles,
             odf.style.Style,
             name='WideCol',
+        )
         self.style_widecol.setAttribute('family', 'table-column')
         self.style_widecol.addElement(odf.style.TableColumnProperties(
             columnwidth='1.25in',
         ))
     def section_key(self, row: AccrualPostings) -> Optional[data.Account]:
         if isinstance(row.account, str):
             return row.account
         else:
             return None
     def start_spreadsheet(self) -> None:
         for accrual_type in AccrualAccount:
             self.use_sheet(accrual_type.name.title())
             for index in range(self.COL_COUNT):
                 stylename = self.style_widecol if index else ''
                 self.sheet.addElement(odf.table.TableColumn(stylename=stylename))
             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: Optional[data.Account]) -> None:
         if key is None:
             return
         self.age_thresholds = list(AccrualAccount.by_account(key).value.aging_thresholds)
         self.age_balances = [core.MutableBalance() for _ in self.age_thresholds]
         accrual_date = self.date - datetime.timedelta(days=self.age_thresholds[-1])
         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" Accrued by {accrual_date.isoformat()} Unpaid by {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: Optional[data.Account]) -> None:
         if key is None:
             return
         total_balance = core.MutableBalance()
         text_style = self.merge_styles(self.style_bold, self.style_endtext)
         text_span = 4
         last_age_text: Optional[str] = None
         self.add_row()
         for threshold, balance in zip(self.age_thresholds, self.age_balances):
             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}"
             else:
                 age_range = f"{age_text}–{last_age_text}"
             self.add_row(
                 self.string_cell(
                     f"Total Aged {age_range}: ",
                     stylename=text_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=text_style,
                 numbercolumnsspanned=text_span,
             ),
             *(odf.table.TableCell() for _ in range(1, text_span)),
             self.balance_cell(total_balance),
+        )
     def _link_seq(self, row: AccrualPostings, key: MetaKey) -> Iterator[Tuple[str, str]]:
         for href in row.all_meta_links(key):
             text: Optional[str] = None
             rt_ids = self.rt_wrapper.parse(href)
             if rt_ids is not None:
                 ticket_id, attachment_id = rt_ids
                 if attachment_id is None:
                     text = f'RT#{ticket_id}'
                 href = self.rt_wrapper.url(ticket_id, attachment_id) or href
             else:
                 # '..' pops the ODS filename off the link path. In other words,
                 # make the link relative to the directory the ODS is in.
                 href = f'../{href}'
             if text is None:
                 href_path = Path(urlparse.urlparse(href).path)
                 text = urlparse.unquote(href_path.name)
             yield (href, text)
     def write_row(self, row: AccrualPostings) -> None:
         age = (self.date - row[0].meta.date).days
         if row.end_balance.ge_zero():
             for index, threshold in enumerate(self.age_thresholds):
                 if age >= threshold:
                     self.age_balances[index] += row.end_balance
                     break
             else:
                 return
         raw_balance = row.balance()
         if row.accrual_type is not None:
             raw_balance = row.accrual_type.normalize_amount(raw_balance)
         if raw_balance == row.end_balance:
             amount_cell = odf.table.TableCell()
         else:
             amount_cell = self.balance_cell(raw_balance)
         projects = {post.meta.get('project') or None for post in row}
         projects.discard(None)
         self.add_row(
             self.date_cell(row[0].meta.date),
             self.multiline_cell(row.entities()),
             amount_cell,
             self.balance_cell(row.end_balance),
             self.multiline_cell(sorted(projects)),
             self.multilink_cell(self._link_seq(row, 'rt-id')),
             self.multilink_cell(self._link_seq(row, 'invoice')),
             self.multilink_cell(self._link_seq(row, 'approval')),
             self.multilink_cell(self._link_seq(row, 'contract')),
             self.multilink_cell(self._link_seq(row, 'purchase-order')),
+        )
 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: List[AccrualPostings] = []
         for group in groups.values():
             if group.is_zero():
                 # Cheap optimization: don't slice and dice groups we're not
                 # going to report anyway.
                 continue
             elif group.accrual_type is None:
                 group = group.since_last_nonzero()
             else:
                 # Filter out new accruals after the report date.
                 # e.g., cover the case that the same invoices has multiple
                 # postings over time, and we don't want to report too-recent
                 # ones.
                 cutoff_date = self.ods.date - datetime.timedelta(
                     days=group.accrual_type.value.aging_thresholds[-1],
+                )
                 group = AccrualPostings(
                     post for post in group.since_last_nonzero()
                     if post.meta.date <= cutoff_date
                     or group.accrual_type.normalize_amount(post.units.number) < 0
+                )
             if group and not group.is_zero():
                 rows.append(group)
         rows.sort(key=lambda related: (
             related.account,
             related[0].meta.date,
             ('\0'.join(related.entities())
              if related.entity is related.INCONSISTENT
              else related.entity),
         ))
         self.ods.write(rows)
         self.ods.save_file(self.out_bin)
 class BalanceReport(BaseReport):
     def _report(self, posts: AccrualPostings, index: int) -> Iterable[str]:
         posts = posts.since_last_nonzero()
         date_s = posts[0].meta.date.strftime('%Y-%m-%d')
         if index:
             yield ""
         yield f"{posts.invoice}:"
         yield f"  {posts.balance_at_cost()} outstanding since {date_s}"
 class OutgoingReport(BaseReport):
     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_id = posts.rt_id
         if rt_id is None:
             raise ValueError("no rt-id links found")
         elif isinstance(rt_id, Sentinel):
             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 _report(self, posts: AccrualPostings, index: int) -> Iterable[str]:
         posts = posts.since_last_nonzero()
         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:
             self.logger.error(
                 "can't generate outgoings report for %s because no RT ticket available: %s",
                 posts.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()
         balance_s = posts.end_balance.format(None)
         raw_balance = -posts.balance()
         if raw_balance != posts.end_balance:
             balance_s = f'{raw_balance} ({balance_s})'
         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"TOTAL TO PAY: {balance_s}"
         yield f"AGREEMENT: {contract_s}"
         yield f"PAYMENT TO: {ticket.get('CF.{payment-to}') or requestor_name}"
         yield f"PAYMENT METHOD: {ticket.get('CF.{payment-method}', '')}"
         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, '{}')
                 yield bc_printer.format_entry(txn)
 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=-1,
         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 -1 (start from the
 previous fiscal year).
 """)
     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 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:
     if cliutil.is_main_script(PROGNAME):
         global logger
         logger = logging.getLogger(PROGNAME)
         sys.excepthook = cliutil.ExceptHook(logger)
     args = parse_arguments(arglist)
-    cliutil.setup_logger(logger, args.loglevel, stderr)
+    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())
     elif args.report_type is ReportType.AGING:
         entries, load_errors, _ = books_loader.load_all()
     else:
         entries, load_errors, _ = books_loader.load_all(args.since)
     filters.remove_opening_balance_txn(entries)
     for error in load_errors:
         bc_printer.print_error(error, file=stderr)
         returncode |= 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
     # 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 starts by grouping postings together by
     # invoice link string, then uses AccrualReport.make_consistent() to split
     # out groups that need it.
     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
             and all(group.accrual_type is AccrualAccount.PAYABLE
                     and not group.is_paid()
                     and key  # Make sure we have a usable rt-id
                     for key, group in groups.items())
         ):
             args.report_type = ReportType.OUTGOING
     if args.report_type is not ReportType.OUTGOING:
         groups = {
             key: group
             for _, source in AccrualPostings.group_by_first_meta_link(postings, 'invoice')
             for key, group in source.make_consistent()
+        }
     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:
                 args.output_file = 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
     else:
         report.run(groups)
     return 0 if returncode == 0 else 16 + returncode
 entry_point = cliutil.make_entry_point(__name__, PROGNAME)
 if __name__ == '__main__':
-    exit(main())
+    exit(entry_point())

setup.py

➞

Show inline comments

 #!/usr/bin/env python3
 from setuptools import setup
 setup(
     name='conservancy_beancount',
     description="Plugin, library, and reports for reading Conservancy's books",
     version='1.1.11',
     author='Software Freedom Conservancy',
     author_email='info@sfconservancy.org',
     license='GNU AGPLv3+',
     install_requires=[
         'babel>=2.6',  # Debian:python3-babel
         'beancount>=2.2',  # Debian:beancount
         # 1.4.1 crashes when trying to save some documents.
         'odfpy>=1.4.0,!=1.4.1',  # Debian:python3-odf
         'PyYAML>=3.0',  # Debian:python3-yaml
         'regex',  # Debian:python3-regex
         'rt>=2.0',
     ],
     setup_requires=[
         'pytest-mypy',
         'pytest-runner',  # Debian:python3-pytest-runner
     ],
     tests_require=[
         'mypy>=0.770',  # Debian:python3-mypy
         'pytest',  # Debian:python3-pytest
     ],
     packages=[
         'conservancy_beancount',
         'conservancy_beancount.plugin',
         'conservancy_beancount.reports',
     ],
     entry_points={
         'console_scripts': [
-            'accrual-report = conservancy_beancount.reports.accrual:main',
+            'accrual-report = conservancy_beancount.reports.accrual:entry_point',
         ],
     },
+)

tests/test_cliutil.py

➞

Show inline comments

 """Test CLI utilities"""
 # 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 errno
 import io
 import inspect
 import logging
 import os
 import re
 import sys
 import traceback
 import pytest
 from pathlib import Path
 from conservancy_beancount import cliutil
 FILE_NAMES = ['-foobar', '-foo.bin']
 STREAM_PATHS = [None, Path('-')]
 class AlwaysEqual:
     def __eq__(self, other):
         return True
 class MockTraceback:
     def __init__(self, stack=None, index=0):
         if stack is None:
             stack = inspect.stack(context=False)
         self._stack = stack
         self._index = index
         frame_record = self._stack[self._index]
         self.tb_frame = frame_record.frame
         self.tb_lineno = frame_record.lineno
     @property
     def tb_next(self):
         try:
             return type(self)(self._stack, self._index + 1)
         except IndexError:
             return None
 @pytest.fixture(scope='module')
 def argparser():
     parser = argparse.ArgumentParser(prog='test_cliutil')
     cliutil.add_loglevel_argument(parser)
     cliutil.add_version_argument(parser)
     return parser
 @pytest.mark.parametrize('path_name', FILE_NAMES)
 def test_bytes_output_path(path_name, tmp_path):
     path = tmp_path / path_name
     stream = io.BytesIO()
     actual = cliutil.bytes_output(path, stream)
     assert actual is not stream
     assert str(actual.name) == str(path)
     assert 'w' in actual.mode
     assert 'b' in actual.mode
 @pytest.mark.parametrize('path', STREAM_PATHS)
 def test_bytes_output_stream(path):
     stream = io.BytesIO()
     actual = cliutil.bytes_output(path, stream)
     assert actual is stream
 @pytest.mark.parametrize('func_name', [
     'bytes_output',
     'text_output',
 ])
 def test_default_output(func_name):
     actual = getattr(cliutil, func_name)()
     assert actual.fileno() == sys.stdout.fileno()
 @pytest.mark.parametrize('path_name', FILE_NAMES)
 def test_text_output_path(path_name, tmp_path):
     path = tmp_path / path_name
     stream = io.StringIO()
     actual = cliutil.text_output(path, stream)
     assert actual is not stream
     assert str(actual.name) == str(path)
     assert 'w' in actual.mode
 @pytest.mark.parametrize('path', STREAM_PATHS)
 def test_text_output_stream(path):
     stream = io.StringIO()
     actual = cliutil.text_output(path, stream)
     assert actual is stream
 @pytest.mark.parametrize('errnum', [
     errno.EACCES,
     errno.EPERM,
     errno.ENOENT,
 ])
 def test_excepthook_oserror(errnum, caplog):
     error = OSError(errnum, os.strerror(errnum), 'TestFilename')
     with pytest.raises(SystemExit) as exc_check:
         cliutil.ExceptHook()(type(error), error, None)
     assert exc_check.value.args[0] == 4
     assert caplog.records
     for log in caplog.records:
         assert log.levelname == 'CRITICAL'
         assert log.message == f"I/O error: {error.filename}: {error.strerror}"
 @pytest.mark.parametrize('exc_type', [
     AttributeError,
     RuntimeError,
     ValueError,
 ])
 def test_excepthook_bug(exc_type, caplog):
     error = exc_type("test message")
     with pytest.raises(SystemExit) as exc_check:
         cliutil.ExceptHook()(exc_type, error, None)
     assert exc_check.value.args[0] == 3
     assert caplog.records
     for log in caplog.records:
         assert log.levelname == 'CRITICAL'
         assert log.message == f"internal {exc_type.__name__}: {error.args[0]}"
 def test_excepthook_traceback(caplog):
     error = KeyError('test')
     args = (type(error), error, MockTraceback())
     caplog.set_level(logging.DEBUG)
     with pytest.raises(SystemExit) as exc_check:
         cliutil.ExceptHook()(*args)
     assert caplog.records
     assert caplog.records[-1].message == ''.join(traceback.format_exception(*args))
 @pytest.mark.parametrize('prog_name,expected', [
     ('', False),
     (AlwaysEqual(), True),
 ])
 def test_is_main_script(prog_name, expected):
     assert cliutil.is_main_script(prog_name) == expected
 @pytest.mark.parametrize('arg,expected', [
     ('debug', logging.DEBUG),
     ('info', logging.INFO),
     ('warning', logging.WARNING),
     ('warn', logging.WARNING),
     ('error', logging.ERROR),
     ('err', logging.ERROR),
     ('critical', logging.CRITICAL),
     ('crit', logging.CRITICAL),
 ])
 def test_loglevel_argument(argparser, arg, expected):
     for method in ['lower', 'title', 'upper']:
         args = argparser.parse_args(['--loglevel', getattr(arg, method)()])
         assert args.loglevel is expected
 def test_setup_logger():
     stream = io.StringIO()
     logger = cliutil.setup_logger(
-        'test_cliutil', logging.INFO, stream, '%(name)s %(levelname)s: %(message)s',
         'test_cliutil', stream, '%(name)s %(levelname)s: %(message)s',
+    )
     logger.debug("test debug")
     logger.info("test info")
     assert stream.getvalue() == "test_cliutil INFO: test info\n"
     logger.critical("test crit")
     assert stream.getvalue() == "test_cliutil CRITICAL: test crit\n"
 @pytest.mark.parametrize('arg', [
     '--license',
     '--version',
     '--copyright',
 ])
 def test_version_argument(argparser, capsys, arg):
     with pytest.raises(SystemExit) as exc_check:
         args = argparser.parse_args(['--version'])
     assert exc_check.value.args[0] == 0
     stdout, _ = capsys.readouterr()
     lines = iter(stdout.splitlines())
     assert re.match(r'^test_cliutil version \d+\.\d+\.\d+', next(lines, "<EOF>"))

tests/test_reports_accrual.py

➞

Show inline comments

 """test_reports_accrual - Unit tests for accrual 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 logging
 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
 from conservancy_beancount.reports import core
 _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',
+]
 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', 11500, '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
     return None
 def check_aging_sheet(sheet, aging_rows, date, accrue_date):
     if not aging_rows:
         return
     if isinstance(accrue_date, int):
         accrue_date = date + datetime.timedelta(days=accrue_date)
     rows = iter(sheet.getElementsByType(odf.table.TableRow))
     for row in rows:
         if "Aging Report" in row.text:
             break
     else:
         assert None, "Header row not found"
     assert f"Accrued by {accrue_date.isoformat()}" in row.text
     assert f"Unpaid by {date.isoformat()}" in row.text
     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)
     for row in rows:
         if row.text.startswith("Total Aged "):
             break
     else:
         assert None, "Totals rows not found"
     actual_sum = Decimal(row.childNodes[-1].value)
     for row in rows:
         if row.text.startswith("Total Aged "):
             actual_sum += Decimal(row.childNodes[-1].value)
         else:
             break
     assert actual_sum == sum(
         row.at_cost.number
         for row in aging_rows
         if row.date <= accrue_date
         and row.at_cost.number > 0
+    )
 def check_aging_ods(ods_file,
                     date=None,
                     recv_rows=AGING_AR,
                     pay_rows=AGING_AP,
 ):
     if date is None:
         date = datetime.date.today()
     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, -60)
     check_aging_sheet(sheets[1], pay_rows, date, -30)
 @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', ACCOUNTS)
 def test_accrual_postings_consistent_account(acct_name):
     meta = {'invoice': '{acct_name} invoice.pdf'}
     txn = testutil.Transaction(postings=[
         (acct_name, 50, meta),
         (acct_name, 25, meta),
     ])
     related = accrual.AccrualPostings(data.Posting.from_txn(txn))
     assert related.account == acct_name
 def test_accrual_postings_entity():
     txn = testutil.Transaction(postings=[
         (ACCOUNTS[0], 25, {'entity': 'Accruee'}),
         (ACCOUNTS[0], -15, {'entity': 'Payee15'}),
         (ACCOUNTS[0], -10, {'entity': 'Payee10'}),
     ])
     related = accrual.AccrualPostings(data.Posting.from_txn(txn))
     assert related.entity == 'Accruee'
     assert set(related.entities()) == {'Accruee', 'Payee10', 'Payee15'}
 def test_accrual_postings_entities():
     txn = testutil.Transaction(postings=[
         (ACCOUNTS[0], 25, {'entity': 'Accruee'}),
         (ACCOUNTS[0], -15, {'entity': 'Payee15'}),
         (ACCOUNTS[0], -10, {'entity': 'Payee10'}),
     ])
     related = accrual.AccrualPostings(data.Posting.from_txn(txn))
     actual = related.entities()
     assert next(actual, None) == 'Accruee'
     assert set(actual) == {'Payee10', 'Payee15'}
 def test_accrual_postings_entities_no_duplicates():
     txn = testutil.Transaction(postings=[
         (ACCOUNTS[0], 25, {'entity': 'Accruee'}),
         (ACCOUNTS[0], -15, {'entity': 'Accruee'}),
         (ACCOUNTS[0], -10, {'entity': 'Other'}),
     ])
     related = accrual.AccrualPostings(data.Posting.from_txn(txn))
     actual = related.entities()
     assert next(actual, None) == 'Accruee'
     assert next(actual, None) == 'Other'
     assert next(actual, None) is None
 def test_accrual_postings_inconsistent_account():
     meta = {'invoice': 'invoice.pdf'}
     txn = testutil.Transaction(postings=[
         (acct_name, index, meta)
         for index, acct_name in enumerate(ACCOUNTS)
     ])
     related = accrual.AccrualPostings(data.Posting.from_txn(txn))
     assert related.account is related.INCONSISTENT
 def test_accrual_postings_rt_id():
     txn = testutil.Transaction(postings=[
         (ACCOUNTS[0], 10, {'rt-id': 'rt:90'}),
         (ACCOUNTS[0], 10, {'rt-id': 'rt:90 rt:92'}),
         (ACCOUNTS[0], 10, {'rt-id': 'rt:90 rt:94 rt:92'}),
     ])
     related = accrual.AccrualPostings(data.Posting.from_txn(txn))
     assert related.rt_id == 'rt:90'
 def test_accrual_postings_rt_id_inconsistent():
     txn = testutil.Transaction(postings=[
         (ACCOUNTS[0], 10, {'rt-id': 'rt:96'}),
         (ACCOUNTS[0], 10, {'rt-id': 'rt:98 rt:96'}),
     ])
     related = accrual.AccrualPostings(data.Posting.from_txn(txn))
     assert related.rt_id is related.INCONSISTENT
 def test_accrual_postings_rt_id_none():
     txn = testutil.Transaction(postings=[
         (ACCOUNTS[0], 10),
     ])
     related = accrual.AccrualPostings(data.Posting.from_txn(txn))
     assert related.rt_id is None
 @pytest.mark.parametrize('acct_name,invoice,day', testutil.combine_values(
     ACCOUNTS,
     ['FIXME', '', None, *testutil.NON_STRING_METADATA_VALUES],
     itertools.count(1),
 ))
 def test_make_consistent_bad_invoice(acct_name, invoice, day):
     txn = testutil.Transaction(date=datetime.date(2019, 1, day), postings=[
         (acct_name, index * 10, {'invoice': invoice, 'entity': f'BadInvoice{day}'})
         for index in range(1, 4)
     ])
     related = accrual.AccrualPostings(data.Posting.from_txn(txn))
     consistent = dict(related.make_consistent())
     assert len(consistent) == 1
     key = next(iter(consistent))
     assert acct_name in key
     if invoice:
         assert str(invoice) in key
     actual = consistent[key]
     assert actual
     assert len(actual) == 3
     for act_post, exp_post in zip(actual, txn.postings):
         assert act_post.units == exp_post.units
         assert act_post.meta.get('invoice') == invoice
 def test_make_consistent_across_accounts():
     invoice = 'Invoices/CrossAccount.pdf'
     txn = testutil.Transaction(date=datetime.date(2019, 2, 1), postings=[
         (acct_name, 100, {'invoice': invoice, 'entity': 'CrossAccount'})
         for acct_name in ACCOUNTS
     ])
     related = accrual.AccrualPostings(data.Posting.from_txn(txn))
     consistent = dict(related.make_consistent())
     assert len(consistent) == len(ACCOUNTS)
     for key, posts in consistent.items():
         assert len(posts) == 1
         assert posts.account in key
 def test_make_consistent_both_invoice_and_account():
     txn = testutil.Transaction(date=datetime.date(2019, 2, 2), postings=[
         (acct_name, 150) for acct_name in ACCOUNTS
     ])
     related = accrual.AccrualPostings(data.Posting.from_txn(txn))
     consistent = dict(related.make_consistent())
     assert len(consistent) == len(ACCOUNTS)
     for key, posts in consistent.items():
         assert len(posts) == 1
         assert posts.account in key
 @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)
     ])
     related = accrual.AccrualPostings(data.Posting.from_txn(txn))
     consistent = dict(related.make_consistent())
     assert len(consistent) == 3
     for key, posts in consistent.items():
         assert len(posts) == 1
         entities = posts.entities()
         assert next(entities, None) == posts.entity
         assert next(entities, None) is None
         assert posts.entity in key
 @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 = accrual.AccrualPostings(data.Posting.from_txn(txn))
     consistent = related.make_consistent()
     _, actual = next(consistent)
     assert actual is related
     assert next(consistent, None) is None
 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, core.RelatedPostings):
         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):
     output = run_outgoing('rt:510', accrual_postings)
     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'^TOTAL TO PAY: \$280\.00$',
         fr'^AGREEMENT: {contract_url}',
         r'^PAYMENT TO: Hon\. Mx\. 510$',
         r'^PAYMENT METHOD: payment method 510$',
         r'^BEANCOUNT ENTRIES:$',
         # For each transaction, check for the date line, a metadata, and the
         # Expenses posting.
         r'^\s*2010-06-10\s',
         fr'^\s+rt-id: "{rt_id_url}"$',
         r'^\s+Expenses:Services:Legal\s+220\.00 USD$',
         r'^\s*2010-06-12\s',
         fr'^\s+contract: "{contract_url}"$',
         r'^\s+Expenses:FilingFees\s+60\.00 USD$',
     ])
 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*$',
         r'^PAYMENT METHOD:\s*$',
     ])
 def test_outgoing_report_fx_amounts(accrual_postings, caplog):
     output = run_outgoing('rt:520 rt:525', accrual_postings)
     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\)$',
     ])
 def test_outgoing_report_multi_invoice(accrual_postings, caplog):
     output = run_outgoing('rt:310', accrual_postings)
     assert not caplog.records
     check_output(output, [
         r'^PAYMENT FOR APPROVAL:$',
         r'^REQUESTOR: Mx\. 310 <mx310@example\.org>$',
         r'^TOTAL TO PAY: \$420.00$',
     ])
 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 {invoice} because no RT ticket available:",
+    )
     assert not output.getvalue()
 def run_aging_report(postings, today=None):
     if today is None:
         today = datetime.date.today()
     postings = (
         post for post in postings
         if post.account.is_under('Assets:Receivable', 'Liabilities:Payable')
+    )
     groups = {
         key: group
         for _, related in accrual.AccrualPostings.group_by_meta(postings, 'invoice')
         for key, group in related.make_consistent()
+    }
     output = io.BytesIO()
     rt_wrapper = rtutil.RT(RTClient())
     report = accrual.AgingReport(rt_wrapper, output, today)
     report.run(groups)
     return output
 def test_aging_report(accrual_postings):
     output = run_aging_report(accrual_postings)
     check_aging_ods(output)
 @pytest.mark.parametrize('date,recv_end,pay_end', [
     # 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), 1, 5),
     (datetime.date(2010, 7, 14), 2, 5),
 ])
 def test_aging_report_date_cutoffs(accrual_postings, date, recv_end, pay_end):
     expect_recv = AGING_AR[:recv_end]
     expect_pay = AGING_AP[:pay_end]
     if 10 <= date.day < 12:
         # Take the 60 USD posting out of the invoice 510/6100 payable.
         expect_pay[-1] = expect_pay[-1]._replace(
             at_cost=testutil.Amount(expect_pay[-1].at_cost.number - 60),
+        )
     output = run_aging_report(accrual_postings, date)
     check_aging_ods(output, date, expect_recv, expect_pay)
 def test_aging_report_entity_consistency(accrual_postings):
     output = run_aging_report((
         post for post in accrual_postings
         if post.meta.get('rt-id') == 'rt:480'
         and post.units.number < 0
     ))
     check_aging_ods(output, None, [], [
         AgingRow.make_simple('2010-04-15', 'MultiPartyA', 125, 'rt:480/4800'),
         AgingRow.make_simple('2010-04-15', 'MultiPartyB', 125, 'rt:480/4800'),
     ])
 def test_aging_report_does_not_include_too_recent_postings(accrual_postings):
     # This date is after the Q3 posting, but too soon after for that to be
     # included in the aging report.
     date = datetime.date(2010, 10, 1)
     output = run_aging_report((
         post for post in accrual_postings
         if post.meta.get('rt-id') == 'rt:470'
     ), date)
     # Date+amount are both from the Q2 posting only.
     check_aging_ods(output, date, [
         AgingRow.make_simple('2010-06-15', 'GrantCo', 5500, 'rt:470/4700',
                              project='Development Grant'),
     ], [])
 def run_main(arglist, config=None):
     if config is None:
         config = testutil.TestConfig(
             books_path=testutil.test_path('books/accruals.beancount'),
             rt_client=RTClient(),
+        )
     output = io.StringIO()
     errors = io.StringIO()
     retcode = accrual.main(arglist, output, errors, config)
     return retcode, output, errors
-def check_main_fails(arglist, config, error_flags, error_patterns):
 def check_main_fails(arglist, config, error_flags):
     retcode, output, errors = run_main(arglist, config)
     assert retcode > 16
     assert (retcode - 16) & error_flags
     check_output(errors, error_patterns)
     assert not output.getvalue()
     errors.seek(0)
     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'^{re.escape(expect_invoice)}:$',
         r' outstanding since ',
     ])
 @pytest.mark.parametrize('arglist,expect_amount', [
     (['310'], 420),
     (['310/3120'], 220),
     (['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'],
     ['entity=MatchingProgram'],
 ])
 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', [
     [],
     ['-t', 'aging', 'entity=Lawyer'],
 ])
 def test_main_aging_report(tmp_path, 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
     output_path = tmp_path / 'AgingReport.ods'
     arglist.insert(0, f'--output-file={output_path}')
     retcode, output, errors = run_main(arglist)
     assert not errors.getvalue()
     assert retcode == 0
     assert not output.getvalue()
     with output_path.open('rb') as ods_file:
         check_aging_ods(ods_file, None, recv_rows, pay_rows)
 def test_main_no_books():
     check_main_fails([], testutil.TestConfig(), 1 | 8, [
     errors = check_main_fails([], testutil.TestConfig(), 1 | 8)
     testutil.check_lines_match(iter(errors), [
         r':[01]: +no books to load in configuration\b',
     ])
 @pytest.mark.parametrize('arglist', [
     ['499'],
     ['505/99999'],
     ['entity=NonExistent'],
 ])
 def test_main_no_matches(arglist):
     check_main_fails(arglist, None, 8, [
         r': WARNING: no matching entries found to report$',
 def test_main_no_matches(arglist, caplog):
     check_main_fails(arglist, None, 8)
     testutil.check_logs_match(caplog, [
         ('WARNING', 'no matching entries found to report'),
     ])
 def test_main_no_rt():
+def test_main_no_rt(caplog):
     config = testutil.TestConfig(
         books_path=testutil.test_path('books/accruals.beancount'),
+    )
     check_main_fails(['-t', 'out'], config, 4, [
         r': ERROR: unable to generate outgoing report: RT client is required\b',
     check_main_fails(['-t', 'out'], config, 4)
     testutil.check_logs_match(caplog, [
         ('ERROR', 'unable to generate outgoing report: RT client is required'),
     ])

tests/testutil.py

➞

Show inline comments

 """Mock Beancount objects for testing"""
 # 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 datetime
 import itertools
 import re
 import beancount.core.amount as bc_amount
 import beancount.core.data as bc_data
 import beancount.loader as bc_loader
 import odf.element
 import odf.opendocument
 import odf.table
 from decimal import Decimal
 from pathlib import Path
 from typing import Any, Optional, NamedTuple
 from conservancy_beancount import books, rtutil
 EXTREME_FUTURE_DATE = datetime.date(datetime.MAXYEAR, 12, 30)
 FUTURE_DATE = datetime.date.today() + datetime.timedelta(days=365 * 99)
 FY_START_DATE = datetime.date(2020, 3, 1)
 FY_MID_DATE = datetime.date(2020, 9, 1)
 PAST_DATE = datetime.date(2000, 1, 1)
 TESTS_DIR = Path(__file__).parent
 def _ods_cell_value_type(cell):
     assert cell.tagName == 'table:table-cell'
     return cell.getAttribute('valuetype')
 def _ods_cell_value(cell):
     value_type = cell.getAttribute('valuetype')
     if value_type == 'currency' or value_type == 'float':
         return Decimal(cell.getAttribute('value'))
     elif value_type == 'date':
         return datetime.datetime.strptime(
             cell.getAttribute('datevalue'), '%Y-%m-%d',
         ).date()
     else:
         return cell.getAttribute('value')
 def _ods_elem_text(elem):
     if isinstance(elem, odf.element.Text):
         return elem.data
     else:
         return '\0'.join(_ods_elem_text(child) for child in elem.childNodes)
 odf.element.Element.value_type = property(_ods_cell_value_type)
 odf.element.Element.value = property(_ods_cell_value)
 odf.element.Element.text = property(_ods_elem_text)
 def check_lines_match(lines, expect_patterns, source='output'):
     for pattern in expect_patterns:
         assert any(re.search(pattern, line) for line in lines), \
             f"{pattern!r} not found in {source}"
 def check_logs_match(caplog, expected):
     records = iter(caplog.records)
     for exp_level, exp_msg in expected:
         exp_level = exp_level.upper()
         assert any(
             log.levelname == exp_level and log.message == exp_msg for log in records
         ), f"{exp_level} log {exp_msg!r} not found"
 def check_post_meta(txn, *expected_meta, default=None):
     assert len(txn.postings) == len(expected_meta)
     for post, expected in zip(txn.postings, expected_meta):
         if not expected:
             assert not post.meta
         else:
             actual = None if post.meta is None else {
                 key: post.meta.get(key, default) for key in expected
+            }
             assert actual == expected
 def combine_values(*value_seqs):
     stop = 0
     for seq in value_seqs:
         try:
             stop = max(stop, len(seq))
         except TypeError:
             pass
     return itertools.islice(
         zip(*(itertools.cycle(seq) for seq in value_seqs)),
         stop,
+    )
 def date_seq(date=FY_MID_DATE, step=1):
     while True:
         yield date
         date += datetime.timedelta(days=step)
 def parse_date(s, fmt='%Y-%m-%d'):
     return datetime.datetime.strptime(s, fmt).date()
 def test_path(s):
     if s is None:
         return s
     s = Path(s)
     if not s.is_absolute():
         s = TESTS_DIR / s
     return s
 def Amount(number, currency='USD'):
     return bc_amount.Amount(Decimal(number), currency)
 def Cost(number, currency='USD', date=FY_MID_DATE, label=None):
     return bc_data.Cost(Decimal(number), currency, date, label)
 def Posting(account, number,
             currency='USD', cost=None, price=None, flag=None,
             _post_type=bc_data.Posting, _meta_type=None, **meta):
     if cost is not None:
         cost = Cost(*cost)
     if not meta:
         meta = None
     elif _meta_type:
         meta = _meta_type(meta)
     return _post_type(
         account,
         Amount(number, currency),
         cost,
         price,
         flag,
         meta,
+    )
 def Transaction(date=FY_MID_DATE, flag='*', payee=None,
                 narration='', tags=None, links=None, postings=(),
                 **meta):
     if isinstance(date, str):
         date = parse_date(date)
     meta.setdefault('filename', '<test>')
     meta.setdefault('lineno', 0)
     real_postings = []
     for post in postings:
         try:
             post.account
         except AttributeError:
             if isinstance(post[-1], dict):
                 args = post[:-1]
                 kwargs = post[-1]
             else:
                 args = post
                 kwargs = {}
             post = Posting(*args, **kwargs)
         real_postings.append(post)
     return bc_data.Transaction(
         meta,
         date,
         flag,
         payee,
         narration,
         set(tags or ''),
         set(links or ''),
         real_postings,
+    )
 LINK_METADATA_STRINGS = {
     'Invoices/304321.pdf',
     'rt:123/456',
     'rt://ticket/234',
+}
 NON_LINK_METADATA_STRINGS = {
     '',
     ' ',
     '     ',
+}
 NON_STRING_METADATA_VALUES = [
     Decimal(5),
     FY_MID_DATE,
     Amount(50),
     Amount(500, None),
+]
 OPENING_EQUITY_ACCOUNTS = itertools.cycle([
     'Equity:Funds:Unrestricted',
     'Equity:Funds:Restricted',
     'Equity:OpeningBalance',
 ])
 class ODSCell:
     @classmethod
     def from_row(cls, row):
         return row.getElementsByType(odf.table.TableCell)
     @classmethod
     def from_sheet(cls, spreadsheet):
         for row in spreadsheet.getElementsByType(odf.table.TableRow):
             yield list(cls.from_row(row))
     @classmethod
     def from_ods_file(cls, path):
         ods = odf.opendocument.load(path)
         return cls.from_sheet(ods.spreadsheet)
 def OpeningBalance(acct=None, **txn_meta):
     if acct is None:
         acct = next(OPENING_EQUITY_ACCOUNTS)
     return Transaction(**txn_meta, postings=[
         ('Assets:Receivable:Accounts', 100),
         ('Assets:Receivable:Loans', 200),
         ('Liabilities:Payable:Accounts', -15),
         ('Liabilities:Payable:Vacation', -25),
         (acct, -260),
     ])
 class TestBooksLoader(books.Loader):
     def __init__(self, source):
         self.source = source
     def load_all(self, from_year=None):
         return bc_loader.load_file(self.source)
     def load_fy_range(self, from_fy, to_fy=None):
         return self.load_all()
 class TestConfig:
     def __init__(self, *,
                  books_path=None,
                  payment_threshold=0,
                  repo_path=None,
                  rt_client=None,
     ):
         if books_path is None:
             self._books_loader = None
         else:
             self._books_loader = TestBooksLoader(books_path)
         self._payment_threshold = Decimal(payment_threshold)
         self.repo_path = test_path(repo_path)
         self._rt_client = rt_client
         if rt_client is None:
             self._rt_wrapper = None
         else:
             self._rt_wrapper = rtutil.RT(rt_client)
     def books_loader(self):
         return self._books_loader
     def config_file_path(self):
         return test_path('userconfig/conservancy_beancount/config.ini')
     def payment_threshold(self):
         return self._payment_threshold
     def repository_path(self):
         return self.repo_path
     def rt_client(self):
         return self._rt_client
     def rt_wrapper(self):
         return self._rt_wrapper
 class _TicketBuilder:
     MESSAGE_ATTACHMENTS = [
         ('(Unnamed)', 'multipart/alternative', '0b'),
         ('(Unnamed)', 'text/plain', '1.2k'),
         ('(Unnamed)', 'text/html', '1.4k'),
+    ]
     MISC_ATTACHMENTS = [
         ('Forwarded Message.eml', 'message/rfc822', '3.1k'),
         ('photo.jpg', 'image/jpeg', '65.2k'),
         ('ConservancyInvoice-301.pdf', 'application/pdf', '326k'),
         ('Company_invoice-2020030405_as-sent.pdf', 'application/pdf', '50k'),
         ('statement.txt', 'text/plain', '652b'),
         ('screenshot.png', 'image/png', '1.9m'),
+    ]
     def __init__(self):
         self.id_seq = itertools.count(1)
         self.misc_attchs = itertools.cycle(self.MISC_ATTACHMENTS)
     def new_attch(self, attch):
         return (str(next(self.id_seq)), *attch)
     def new_msg_with_attachments(self, attachments_count=1):
         for attch in self.MESSAGE_ATTACHMENTS:
             yield self.new_attch(attch)
         for _ in range(attachments_count):
             yield self.new_attch(next(self.misc_attchs))
     def new_messages(self, messages_count, attachments_count=None):
         for n in range(messages_count):
             if attachments_count is None:
                 att_count = messages_count - n
             else:
                 att_count = attachments_count
             yield from self.new_msg_with_attachments(att_count)
 class RTClient:
     _builder = _TicketBuilder()
     DEFAULT_URL = 'https://example.org/defaultrt/REST/1.0/'
     TICKET_DATA = {
         '1': list(_builder.new_messages(1, 3)),
         '2': list(_builder.new_messages(2, 1)),
         '3': list(_builder.new_messages(3, 0)),
+    }
     del _builder
     def __init__(self,
                  url=DEFAULT_URL,
                  default_login=None,
                  default_password=None,
                  proxy=None,
                  default_queue='General',
                  skip_login=False,
                  verify_cert=True,
                  http_auth=None,
                  want_cfs=True,
     ):
         self.url = url
         if http_auth is None:
             self.user = default_login
             self.password = default_password
             self.auth_method = 'login'
             self.login_result = skip_login or None
         else:
             self.user = http_auth.username
             self.password = http_auth.password
             self.auth_method = type(http_auth).__name__
             self.login_result = True
         self.last_login = None
         self.want_cfs = want_cfs
     def login(self, login=None, password=None):
         if login is None and password is None:
             login = self.user
             password = self.password
         self.login_result = bool(login and password and not password.startswith('bad'))
         self.last_login = (login, password, self.login_result)
         return self.login_result
     def get_attachments(self, ticket_id):
         try:
             return list(self.TICKET_DATA[str(ticket_id)])
         except KeyError:
             return None
     def get_attachment(self, ticket_id, attachment_id):
         try:
             att_seq = iter(self.TICKET_DATA[str(ticket_id)])
         except KeyError:
             return None
         att_id = str(attachment_id)
         multipart_id = None
         for attch in att_seq:
             if attch[0] == att_id:
                 break
             elif attch[2].startswith('multipart/'):
                 multipart_id = attch[0]
         else:
             return None
         tx_id = multipart_id or att_id
         if attch[1] == '(Unnamed)':
             filename = ''
         else:
             filename = attch[1]
         return {
             'id': att_id,
             'ContentType': attch[2],
             'Filename': filename,
             'Transaction': tx_id,
+        }
     def get_ticket(self, ticket_id):
         ticket_id_s = str(ticket_id)
         if ticket_id_s not in self.TICKET_DATA:
             return None
         retval = {
             'id': 'ticket/{}'.format(ticket_id_s),
             'numerical_id': ticket_id_s,
             'Requestors': [
                 f'mx{ticket_id_s}@example.org',
                 'requestor2@example.org',
             ],
+        }
         if self.want_cfs:
             retval['CF.{payment-method}'] = f'payment method {ticket_id_s}'
             retval['CF.{payment-to}'] = f'Hon. Mx. {ticket_id_s}'
         return retval
     def get_user(self, user_id):
         user_id_s = str(user_id)
         match = re.search(r'(\d+)@', user_id_s)
         if match is None:
             email = f'mx{user_id_s}@example.org'
             user_id_num = int(user_id_s)
         else:
             email = user_id_s
             user_id_num = int(match.group(1))
         retval = {
             'id': f'user/{user_id_num}',
             'EmailAddress': email,
             'Name': email,
+        }
         if self.want_cfs:
             retval['RealName'] = f'Mx. {user_id_num}'
         return retval

0 comments (0 inline, 0 general)