NPO-Accounting/conservancy_beancount Changeset - 32b62df5405f

Changeset - 32b62df5405f

Parent rev.

Child rev.

[Not reviewed]

0 3 0

Brett Smith - 4 years ago 2020-05-30 03:39:27
brettcsmith@brettcsmith.org

cliutil: Better implementation of is_main_script.

The old one could return True if you called accrual.main()
directly from one-off test scripts.

3 files changed with 21 insertions and 6 deletions:

conservancy_beancount/cliutil.py

conservancy_beancount/reports/accrual.py

tests/test_cliutil.py

0 comments (0 inline, 0 general)

conservancy_beancount/cliutil.py

➞

Show inline comments

@@ ... @@
 import argparse
 import enum
 import inspect
 import logging
 import operator
 import os
 import pkg_resources
 import signal
 import sys
 import traceback
 import types
 from pathlib import Path
 from typing import (
     Any,
     Iterable,
     NoReturn,
     Optional,
     Sequence,
     TextIO,
     Type,
     Union,
+)
 VERSION = pkg_resources.require(PKGNAME)[0].version
@@ ... @@
+    )
 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() -> bool:
+def is_main_script(prog_name: str) -> bool:
     """Return true if the caller is the "main" program."""
     stack = inspect.stack(context=False)
     return len(stack) <= 3 and stack[-1].function.startswith('<')
     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 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:
     if isinstance(logger, str):
         logger = logging.getLogger(logger)
     formatter = logging.Formatter(fmt)
     handler = logging.StreamHandler(stream)
     handler.setFormatter(formatter)
     logger.addHandler(handler)

conservancy_beancount/reports/accrual.py

➞

Show inline comments

@@ ... @@
 `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]
     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():
+    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 not None:
         entries, load_errors, _ = books_loader.load_fy_range(args.since)
     else:

tests/test_cliutil.py

➞

Show inline comments

@@ ... / @@ -18,24 +18,29 @@ import argparse @@
 import errno
 import io
 import inspect
 import logging
 import os
 import re
 import traceback
 import pytest
 from conservancy_beancount import cliutil
 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):
@@ ... / @@ -82,26 +87,30 @@ def test_excepthook_bug(exc_type, caplog): @@
         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))
 def test_is_main_script():
     assert not cliutil.is_main_script()
 @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):

0 comments (0 inline, 0 general)