Files
@ 87760f6aea28
Branch filter:
Location: NPO-Accounting/conservancy_beancount/conservancy_beancount/reports/accrual.py
87760f6aea28
29.2 KiB
text/x-python
accrual: Clean up typing after recent bugfix.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 | #!/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 operator
import re
import sys
import urllib.parse as urlparse
from pathlib import Path
from typing import (
cast,
Any,
BinaryIO,
Callable,
Dict,
Iterable,
Iterator,
FrozenSet,
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 cliutil
from .. import config as configmod
from .. import data
from .. import filters
from .. import rtutil
PROGNAME = 'accrual-report'
STANDARD_PATH = Path('-')
CompoundAmount = TypeVar('CompoundAmount', data.Amount, core.Balance)
PostGroups = Mapping[Optional[MetaValue], 'AccrualPostings']
RTObject = Mapping[str, str]
logger = logging.getLogger('conservancy_beancount.reports.accrual')
class Sentinel:
pass
class Account(NamedTuple):
name: str
norm_func: Callable[[CompoundAmount], CompoundAmount]
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', lambda bal: bal, [365, 120, 90, 60],
)
PAYABLE = Account(
'Liabilities:Payable', operator.neg, [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")
class AccrualPostings(core.RelatedPostings):
def _meta_getter(key: MetaKey) -> Callable[[data.Posting], MetaValue]: # type:ignore[misc]
def meta_getter(post: data.Posting) -> MetaValue:
return post.meta.get(key)
return meta_getter
_FIELDS: Dict[str, Callable[[data.Posting], MetaValue]] = {
'account': operator.attrgetter('account'),
'contract': _meta_getter('contract'),
'invoice': _meta_getter('invoice'),
'purchase_order': _meta_getter('purchase-order'),
}
INCONSISTENT = Sentinel()
__slots__ = (
'accrual_type',
'accrued_entities',
'end_balance',
'paid_entities',
'account',
'accounts',
'contract',
'contracts',
'invoice',
'invoices',
'purchase_order',
'purchase_orders',
)
def __init__(self,
source: Iterable[data.Posting]=(),
*,
_can_own: bool=False,
) -> None:
super().__init__(source, _can_own=_can_own)
# The following type declarations tell mypy about values set in the for
# loop that are important enough to be referenced directly elsewhere.
self.account: Union[data.Account, Sentinel]
self.invoice: Union[MetaValue, Sentinel]
for name, get_func in self._FIELDS.items():
values = frozenset(get_func(post) for post in self)
setattr(self, f'{name}s', values)
if len(values) == 1:
one_value = next(iter(values))
else:
one_value = self.INCONSISTENT
setattr(self, name, one_value)
if self.account is self.INCONSISTENT:
self.accrual_type: Optional[AccrualAccount] = None
self.end_balance = self.balance_at_cost()
self.accrued_entities = self._collect_entities()
self.paid_entities = self.accrued_entities
else:
self.accrual_type = AccrualAccount.classify(self)
accrual_acct: Account = self.accrual_type.value
norm_func = accrual_acct.norm_func
self.end_balance = norm_func(self.balance_at_cost())
self.accrued_entities = self._collect_entities(
lambda post: norm_func(post.units).number > 0,
)
self.paid_entities = self._collect_entities(
lambda post: norm_func(post.units).number < 0,
)
def _collect_entities(self,
pred: Callable[[data.Posting], bool]=bool,
default: str='<empty>',
) -> FrozenSet[MetaValue]:
return frozenset(
post.meta.get('entity') or default
for post in self if pred(post)
)
def entities(self) -> Iterator[MetaValue]:
yield from self.accrued_entities
yield from self.paid_entities.difference(self.accrued_entities)
def make_consistent(self) -> Iterator[Tuple[MetaValue, 'AccrualPostings']]:
account_ok = isinstance(self.account, 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 invoice_ok:
yield (self.invoice, self)
return
groups = collections.defaultdict(list)
for post in self:
if invoice_ok:
key = f'{self.invoice} {post.account}'
else:
key = f'{post.account} {post.meta.get("entity")} {post.meta.get("invoice")}'
groups[key].append(post)
type_self = type(self)
for group_key, posts in groups.items():
yield group_key, type_self(posts, _can_own=True)
def report_inconsistencies(self) -> Iterable[Error]:
for field_name, get_func in self._FIELDS.items():
if getattr(self, field_name) is self.INCONSISTENT:
for post in self:
errmsg = 'inconsistent {} for invoice {}: {}'.format(
field_name.replace('_', '-'),
self.invoice or "<none>",
get_func(post),
)
yield Error(post.meta, errmsg, post.meta.txn)
costs = collections.defaultdict(set)
for post in self:
costs[post.units.currency].add(post.cost)
for code, currency_costs in costs.items():
if len(currency_costs) > 1:
for post in self:
if post.units.currency == code:
errmsg = 'inconsistent cost for invoice {}: {}'.format(
self.invoice or "<none>", post.cost,
)
yield Error(post.meta, errmsg, post.meta.txn)
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:]
class BaseReport:
def __init__(self, out_file: TextIO) -> None:
self.out_file = out_file
self.logger = logger.getChild(type(self).__name__)
def _report(self,
invoice: str,
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(str(invoice), groups[invoice], index):
print(line, file=self.out_file)
class AgingODS(core.BaseODS[AccrualPostings, Optional[data.Account]]):
COLUMNS = [
'Date',
'Entity',
'Invoice Amount',
'Booked Amount',
'Ticket',
'Invoice',
]
COL_COUNT = len(COLUMNS)
def __init__(self,
rt_client: rt.Rt,
date: datetime.date,
logger: logging.Logger,
) -> None:
super().__init__()
self.rt_client = rt_client
self.rt_wrapper = rtutil.RT(self.rt_client)
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.split(':')
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
self.add_row()
text_style = self.merge_styles(self.style_bold, self.style_endtext)
text_span = self.COL_COUNT - 1
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
self.add_row(
self.string_cell(
f"Total Aged Over {age_text}: ",
stylename=text_style,
numbercolumnsspanned=text_span,
),
*(odf.table.TableCell() for _ in range(1, text_span)),
self.balance_cell(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.value.norm_func(raw_balance)
if raw_balance == row.end_balance:
amount_cell = odf.table.TableCell()
else:
amount_cell = self.balance_cell(raw_balance)
self.add_row(
self.date_cell(row[0].meta.date),
self.multiline_cell(row.entities()),
amount_cell,
self.balance_cell(row.end_balance),
self.multilink_cell(self._link_seq(row, 'rt-id')),
self.multilink_cell(self._link_seq(row, 'invoice')),
)
class AgingReport(BaseReport):
def __init__(self,
rt_client: rt.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_client, date, self.logger)
def run(self, groups: PostGroups) -> None:
rows = list(group for group in groups.values() if not group.is_zero())
rows.sort(key=lambda related: (
related.account,
related[0].meta.date,
min(related.entities()) if related.accrued_entities else '',
))
self.ods.write(rows)
self.ods.save_file(self.out_bin)
class BalanceReport(BaseReport):
def _report(self,
invoice: str,
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"{invoice}:"
yield f" {posts.balance_at_cost()} outstanding since {date_s}"
class OutgoingReport(BaseReport):
def __init__(self, rt_client: rt.Rt, out_file: TextIO) -> None:
super().__init__(out_file)
self.rt_client = rt_client
self.rt_wrapper = rtutil.RT(rt_client)
def _primary_rt_id(self, posts: AccrualPostings) -> rtutil.TicketAttachmentIds:
rt_ids = posts.all_meta_links('rt-id')
rt_ids_count = len(rt_ids)
if rt_ids_count != 1:
raise ValueError(f"{rt_ids_count} rt-id links found")
parsed = rtutil.RT.parse(rt_ids.pop())
if parsed is None:
raise ValueError("rt-id is not a valid RT reference")
else:
return parsed
def _report(self,
invoice: str,
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",
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 = 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
@classmethod
def default_for(cls, groups: PostGroups) -> 'ReportType':
if len(groups) == 1 and all(
group.accrual_type is AccrualAccount.PAYABLE
and not group.is_paid()
for group in groups.values()
):
return cls.OUTGOING
else:
return cls.BALANCE
class ReturnFlag(enum.IntFlag):
LOAD_ERRORS = 1
CONSISTENCY_ERRORS = 2
REPORT_ERRORS = 4
NOTHING_TO_REPORT = 8
class SearchTerm(NamedTuple):
meta_key: MetaKey
pattern: str
@classmethod
def parse(cls, s: str) -> 'SearchTerm':
key_match = re.match(r'^[a-z][-\w]*=', s)
key: Optional[str]
if key_match:
key, _, raw_link = s.partition('=')
else:
key = None
raw_link = s
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 = 'invoice'
pattern = r'(?:^|\s){}(?:\s|$)'.format(re.escape(raw_link))
else:
ticket_id, attachment_id = rt_ids
if key is None:
key = 'rt-id' if attachment_id is None else 'invoice'
pattern = rtutil.RT.metadata_regexp(
ticket_id,
attachment_id,
first_link_only=key == 'rt-id' and attachment_id is None,
)
return cls(key, pattern)
def filter_search(postings: Iterable[data.Posting],
search_terms: Iterable[SearchTerm],
) -> Iterable[data.Posting]:
accounts = tuple(AccrualAccount.account_names())
postings = (post for post in postings if post.account.is_under(*accounts))
for meta_key, pattern in search_terms:
postings = filters.filter_meta_match(postings, meta_key, re.compile(pattern))
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',
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)
args.search_terms = [SearchTerm.parse(s) for s in args.search]
if args.report_type is None and not args.search_terms:
args.report_type = ReportType.AGING
return args
def get_output_path(output_path: Optional[Path],
default_path: Path=STANDARD_PATH,
) -> Optional[Path]:
if output_path is None:
output_path = default_path
if output_path == STANDARD_PATH:
return None
else:
return output_path
def get_output_bin(path: Optional[Path], stdout: TextIO) -> BinaryIO:
if path is None:
return open(stdout.fileno(), 'wb')
else:
return path.open('wb')
def get_output_text(path: Optional[Path], stdout: TextIO) -> TextIO:
if path is None:
return stdout
else:
return path.open('w')
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)
if config is None:
config = configmod.Config()
config.load_file()
books_loader = config.books_loader()
if books_loader is None:
entries: Entries = []
source = {
'filename': str(config.config_file_path()),
'lineno': 1,
}
load_errors: Errors = [Error(source, "no books to load in configuration", None)]
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)
returncode = 0
postings = filter_search(data.Posting.from_entries(entries), args.search_terms)
groups: PostGroups = dict(AccrualPostings.group_by_meta(postings, 'invoice'))
for error in load_errors:
bc_printer.print_error(error, file=stderr)
returncode |= ReturnFlag.LOAD_ERRORS
for related in groups.values():
for error in related.report_inconsistencies():
bc_printer.print_error(error, file=stderr)
returncode |= ReturnFlag.CONSISTENCY_ERRORS
if not groups:
logger.warning("no matching entries found to report")
returncode |= ReturnFlag.NOTHING_TO_REPORT
groups = {
key: posts
for source_posts in groups.values()
for key, posts in source_posts.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
if args.report_type is None:
args.report_type = ReportType.default_for(groups)
report: Optional[BaseReport] = None
output_path: Optional[Path] = None
if args.report_type is ReportType.AGING:
rt_client = config.rt_client()
if rt_client is None:
logger.error("unable to generate aging report: RT client is required")
else:
now = datetime.datetime.now()
default_path = Path(now.strftime('AgingReport_%Y-%m-%d_%H:%M.ods'))
output_path = get_output_path(args.output_file, default_path)
out_bin = get_output_bin(output_path, stdout)
report = AgingReport(rt_client, out_bin)
elif args.report_type is ReportType.OUTGOING:
rt_client = config.rt_client()
if rt_client is None:
logger.error("unable to generate outgoing report: RT client is required")
else:
output_path = get_output_path(args.output_file)
out_file = get_output_text(output_path, stdout)
report = OutgoingReport(rt_client, out_file)
else:
output_path = get_output_path(args.output_file)
out_file = get_output_text(output_path, stdout)
report = args.report_type.value(out_file)
if report is None:
returncode |= ReturnFlag.REPORT_ERRORS
else:
report.run(groups)
if args.output_file != output_path:
logger.info("Report saved to %s", output_path)
return 0 if returncode == 0 else 16 + returncode
if __name__ == '__main__':
exit(main())
|