Changeset - 8516134687e8
[Not reviewed]
0 3 0
Brett Smith - 4 years ago 2019-11-11 15:18:21
brettcsmith@brettcsmith.org
hooks.ledger_entry: Improve date handling.

Check that we have the date field used in the payee line, and not just
'date'.
Allow other date fields to be None since they may not be used by the
template.
3 files changed with 24 insertions and 9 deletions:
0 comments (0 inline, 0 general)
import2ledger/hooks/ledger_entry.py
Show inline comments
...
 
@@ -215,34 +215,35 @@ class AccountSplitter:
 
                )
 

	
 
    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\}')
 
    PAYEE_LINE_RE = re.compile(r'^\{(\w*_)*date\}\s')
 
    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.date_field = 'date'
 
        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(';'):
...
 
@@ -264,54 +265,56 @@ class Template:
 
    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):
 
        match = self.PAYEE_LINE_RE.match(line1)
 
        if match:
 
            self.date_field = match.group(0)[1:-2]
 
            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()
 
        if template_vars.get(self.date_field) is None:
 
            raise errors.UserInputConfigurationError(
 
                "entry needs {} field but that's not set by the importer".format(
 
                    self.date_field,
 
                ), self.splitter.template_name)
 
        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'):
 
            if value is not None and (key == 'date' or 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):
setup.py
Show inline comments
...
 
@@ -21,24 +21,24 @@ all_extras_require = [
 
]
 

	
 
REQUIREMENTS['extras_require']['all_importers'] = all_extras_require
 
REQUIREMENTS['tests_require'] = [
 
    'pytest',
 
    'PyYAML',
 
    *all_extras_require,
 
]
 

	
 
setup(
 
    name='import2ledger',
 
    description="Import different sources of financial data to Ledger",
 
    version='0.10.0',
 
    version='0.10.1',
 
    author='Brett Smith',
 
    author_email='brettcsmith@brettcsmith.org',
 
    license='GNU AGPLv3+',
 

	
 
    packages=find_packages(include=['import2ledger', 'import2ledger.*']),
 
    entry_points={
 
        'console_scripts': ['import2ledger = import2ledger.__main__:main'],
 
    },
 

	
 
    **REQUIREMENTS,
 
)
tests/test_hook_ledger_entry.py
Show inline comments
...
 
@@ -173,24 +173,36 @@ def test_custom_payee_line():
 
def test_line1_not_custom_payee():
 
    render_vars = template_vars('VV', '15.00', other_vars={
 
        'custom_date': datetime.date(2014, 2, 12),
 
    })
 
    lines = render_lines(render_vars, 'Simplest')
 
    assert lines == [
 
        "",
 
        "2015/03/14 VV",
 
        "  Accrued:Accounts Receivable  15.00 USD",
 
        "  Income:Donations  -15.00 USD",
 
    ]
 

	
 
def test_custom_date_missing():
 
    render_vars = template_vars('YY', '20.00')
 
    with pytest.raises(errors.UserInputConfigurationError):
 
        render_lines(render_vars, 'Custom Payee')
 

	
 
def test_custom_date_is_none():
 
    render_vars = template_vars('YZ', '25.00', other_vars={
 
        'custom_date': None,
 
    })
 
    with pytest.raises(errors.UserInputConfigurationError):
 
        render_lines(render_vars, 'Custom Payee')
 

	
 
@pytest.mark.parametrize('amount,expect_fee', [
 
    (40, 3),
 
    (80, 6),
 
])
 
def test_conditional(amount, expect_fee):
 
    expect_cash = amount - expect_fee
 
    amount_s = '{:.02f}'.format(amount)
 
    render_vars = template_vars('Buyer', amount_s)
 
    lines = render_lines(render_vars, 'Conditional')
 
    assert lines == [
 
        "",
 
        "2015/03/14 Buyer",
0 comments (0 inline, 0 general)