Files
@ 7156529ceb23
Branch filter:
Location: NPO-Accounting/import2ledger/import2ledger/hooks/ledger_entry.py
7156529ceb23
12.5 KiB
text/x-python
nbpy2017: Report item rate names and final unit prices.
This keeps more of the RBI calculation in the templates, where it belongs.
Template logic has become more capable since this importer was first
written, which makes this change practical.
This keeps more of the RBI calculation in the templates, where it belongs.
Template logic has become more capable since this importer was first
written, which makes this change practical.
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 | import collections
import datetime
import decimal
import functools
import io
import logging
import operator
import re
import tokenize
import babel.numbers
from . import HOOK_KINDS
from .. import errors, strparse
logger = logging.getLogger('import2ledger.hooks.ledger_entry')
class TokenTransformer:
def __init__(self, source):
try:
source = source.readline
except AttributeError:
pass
self.in_tokens = tokenize.tokenize(source)
@classmethod
def from_bytes(cls, b):
return cls(io.BytesIO(b).readline)
@classmethod
def from_str(cls, s, encoding='utf-8'):
return cls.from_bytes(s.encode(encoding))
def __iter__(self):
for ttype, tvalue, _, _, _ in self.in_tokens:
try:
transformer = getattr(self, 'transform_' + tokenize.tok_name[ttype])
except AttributeError:
raise ValueError("{} token {!r} not supported".format(ttype, tvalue))
yield from transformer(ttype, tvalue)
def _noop_transformer(self, ttype, tvalue):
yield (ttype, tvalue)
transform_ENDMARKER = _noop_transformer
transform_NEWLINE = _noop_transformer
def transform_ENCODING(self, ttype, tvalue):
self.in_encoding = tvalue
return self._noop_transformer(ttype, tvalue)
def transform(self):
out_bytes = tokenize.untokenize(self)
return out_bytes.decode(self.in_encoding)
class AmountTokenTransformer(TokenTransformer):
SUPPORTED_NAMES = frozenset([
'if',
'else',
'and',
'or',
'not',
'in',
])
SUPPORTED_OPS = frozenset([
'(',
')',
'+',
'-',
'*',
'/',
'==',
'!=',
'<',
'<=',
'>',
'>=',
])
def __iter__(self):
tokens = super().__iter__()
for token in tokens:
yield token
if token[0] == tokenize.NAME:
break
else:
raise ValueError("no amount in expression")
yield from tokens
def transform_NAME(self, ttype, tvalue):
if tvalue in self.SUPPORTED_NAMES:
yield from self._noop_transformer(ttype, tvalue)
else:
raise ValueError("unsupported bare word {!r}".format(tvalue))
def transform_NUMBER(self, ttype, tvalue):
yield (tokenize.NAME, 'Decimal')
yield (tokenize.OP, '(')
yield (tokenize.STRING, repr(tvalue))
yield (tokenize.OP, ')')
def transform_OP(self, ttype, tvalue):
if tvalue == '{':
try:
name_type, name_value, _, _, _ = next(self.in_tokens)
close_type, close_value, _, _, _ = next(self.in_tokens)
if (name_type != tokenize.NAME
or name_value != name_value.lower()
or close_type != tokenize.OP
or close_value != '}'):
raise ValueError()
except (StopIteration, ValueError):
raise ValueError("opening { does not name variable")
yield (tokenize.NAME, name_value)
elif tvalue in self.SUPPORTED_OPS:
yield from self._noop_transformer(ttype, tvalue)
else:
raise ValueError("unsupported operator {!r}".format(tvalue))
transform_STRING = TokenTransformer._noop_transformer
class AccountSplitter:
EVAL_GLOBALS = {
'Decimal': decimal.Decimal,
}
TARGET_LINE_LEN = 78
# -4 because that's how many spaces prefix an account line.
TARGET_ACCTLINE_LEN = TARGET_LINE_LEN - 4
def __init__(self, signed_currencies, signed_currency_fmt, unsigned_currency_fmt,
template_name):
self.splits = []
self.metadata = []
self.signed_currency_fmt = signed_currency_fmt
self.unsigned_currency_fmt = unsigned_currency_fmt
self.signed_currencies = set(signed_currencies)
self.template_name = template_name
self._last_template_vars = object()
def is_empty(self):
return not self.splits
def add(self, account, amount_expr):
try:
clean_expr = AmountTokenTransformer.from_str(amount_expr).transform()
compiled_expr = compile(clean_expr, self.template_name, 'eval')
except (SyntaxError, tokenize.TokenError, ValueError) as error:
raise errors.UserInputConfigurationError(error.args[0], amount_expr)
else:
self.splits.append((account, compiled_expr))
self.metadata.append('')
def set_metadata(self, metadata_s):
self.metadata[-1] = metadata_s
def _currency_decimal(self, amount, currency):
return decimal.Decimal(babel.numbers.format_currency(amount, currency, '###0.###'))
def _balance_amounts(self, amounts, to_amount):
cmp_func = operator.lt if to_amount > 0 else operator.gt
should_balance = functools.partial(cmp_func, 0)
remainder = to_amount
balance_index = None
for index, (_, amount) in enumerate(amounts):
if should_balance(amount):
remainder -= amount
balance_index = index
if balance_index is None:
pass
elif (abs(remainder) / abs(to_amount)) >= decimal.Decimal('.1'):
raise errors.UserInputConfigurationError(
"template can't balance amounts to {}".format(to_amount),
self.template_name,
)
else:
account_name, start_amount = amounts[balance_index]
amounts[balance_index] = (account_name, start_amount + remainder)
def _build_amounts(self, template_vars):
try:
amounts = [
(account,
self._currency_decimal(eval(amount_expr, self.EVAL_GLOBALS, template_vars),
template_vars['currency']),
) for account, amount_expr in self.splits
]
except (ArithmeticError, NameError, TypeError, ValueError) as error:
raise errors.UserInputConfigurationError(
"{}: {}".format(type(error).__name__, error),
"template {!r}".format(self.template_name)
) from error
if sum(amt for _, amt in amounts) != 0:
self._balance_amounts(amounts, template_vars['amount'])
self._balance_amounts(amounts, -template_vars['amount'])
return amounts
def _iter_splits(self, template_vars):
amounts = self._build_amounts(template_vars)
if template_vars['currency'] in self.signed_currencies:
amt_fmt = self.signed_currency_fmt
else:
amt_fmt = self.unsigned_currency_fmt
for (account, amount), metadata in zip(amounts, self.metadata):
if amount == 0:
yield ''
else:
account_s = account.format_map(template_vars)
amount_s = babel.numbers.format_currency(amount, template_vars['currency'], amt_fmt)
sep_len = max(2, self.TARGET_ACCTLINE_LEN - len(account_s) - len(amount_s))
yield '\n {}{}{}{}'.format(
account_s, ' ' * sep_len, amount_s,
metadata.format_map(template_vars),
)
def render_next(self, template_vars):
if template_vars is not self._last_template_vars:
self._split_iter = self._iter_splits(template_vars)
self._last_template_vars = template_vars
return next(self._split_iter)
class Template:
ACCOUNT_SPLIT_RE = re.compile(r'(?:\t| )\s*')
DATE_FMT = '%Y/%m/%d'
PAYEE_LINE_RE = re.compile(r'\{(\w*_)*date\}')
SIGNED_CURRENCY_FMT = '¤#,##0.###;¤-#,##0.###'
UNSIGNED_CURRENCY_FMT = '#,##0.### ¤¤'
def __init__(self, template_s, signed_currencies=frozenset(),
date_fmt=DATE_FMT,
signed_currency_fmt=SIGNED_CURRENCY_FMT,
unsigned_currency_fmt=UNSIGNED_CURRENCY_FMT,
template_name='<template>'):
self.date_fmt = date_fmt
self.splitter = AccountSplitter(
signed_currencies, signed_currency_fmt, unsigned_currency_fmt, template_name)
lines = self._template_lines(template_s)
self.format_funcs = []
try:
self.format_funcs.append(next(lines).format_map)
except StopIteration:
return
metadata = []
for line in lines:
if line.startswith(';'):
metadata.append(line)
else:
self._add_str_func(metadata)
metadata = []
line = line.strip()
match = self.ACCOUNT_SPLIT_RE.search(line)
if match is None:
raise errors.UserInputError("no amount expression found", line)
account = line[:match.start()]
amount_expr = line[match.end():]
self.splitter.add(account, amount_expr)
self.format_funcs.append(self.splitter.render_next)
self._add_str_func(metadata)
self.format_funcs.append('\n'.format_map)
def _nonblank_lines(self, s):
for line in s.splitlines(True):
line = line.strip()
if line:
yield line
def _template_lines(self, template_s):
lines = self._nonblank_lines(template_s)
try:
line1 = next(lines)
except StopIteration:
return
if self.PAYEE_LINE_RE.match(line1):
yield '\n' + line1
else:
yield '\n{date} {payee}'
yield line1
yield from lines
def _add_str_func(self, str_seq):
str_flat = ''.join('\n ' + s for s in str_seq)
if not str_flat:
pass
elif self.splitter.is_empty():
self.format_funcs.append(str_flat.format_map)
else:
self.splitter.set_metadata(str_flat)
def render(self, template_vars):
# template_vars must have these keys. Raise a KeyError if not.
template_vars['currency']
template_vars['payee']
try:
date = template_vars['date']
except KeyError:
date = datetime.date.today()
render_vars = {
'amount': strparse.currency_decimal(template_vars['amount']),
'date': date.strftime(self.date_fmt),
}
for key, value in template_vars.items():
if key.endswith('_date'):
render_vars[key] = value.strftime(self.date_fmt)
all_vars = collections.ChainMap(render_vars, template_vars)
return ''.join(f(all_vars) for f in self.format_funcs)
def is_empty(self):
return not self.format_funcs
class LedgerEntryHook:
KIND = HOOK_KINDS.OUTPUT
def __init__(self, config):
self.config = config
@staticmethod
@functools.lru_cache()
def _load_template(config, section_name, config_key):
section_config = config.get_section(section_name)
try:
template_s = section_config[config_key]
except KeyError:
raise errors.UserInputConfigurationError(
"Ledger template not defined in [{}]".format(section_name),
config_key,
)
return Template(
template_s,
date_fmt=section_config['date_format'],
signed_currencies=[code.strip().upper() for code in section_config['signed_currencies'].split(',')],
signed_currency_fmt=section_config['signed_currency_format'],
unsigned_currency_fmt=section_config['unsigned_currency_format'],
template_name=config_key,
)
def run(self, entry_data):
try:
template_key = entry_data['ledger template']
except KeyError:
template_key = '{} {} ledger entry'.format(
strparse.rslice_words(entry_data['importer_module'], -1, '.', 1),
entry_data['importer_class'][:-8].lower(),
)
try:
template = self._load_template(self.config, None, template_key)
except errors.UserInputConfigurationError as error:
if error.strerror.startswith('Ledger template not defined '):
have_template = False
else:
raise
else:
have_template = not template.is_empty()
if not have_template:
logger.warning("no Ledger template defined as %r", template_key)
else:
with self.config.open_output_file() as out_file:
print(template.render(entry_data), file=out_file, end='')
|