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

@@ ... / @@ -15,13 +15,12 @@ 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
@@ ... @@
         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

conservancy_beancount/reports/accrual.py

➞

Show inline comments

@@ ... @@
 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()
@@ ... / @@ -750,8 +746,10 @@ def main(arglist: Optional[Sequence[str]]=None, @@
     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

@@ ... / @@ -32,10 +32,10 @@ setup( @@
         '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

@@ ... / @@ -30,17 +30,12 @@ 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
@@ ... / @@ -138,19 +133,12 @@ def test_excepthook_traceback(caplog): @@
     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),
@@ ... / @@ -163,17 +151,16 @@ def test_loglevel_argument(argparser, arg, expected): @@
         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',
 ])

tests/test_reports_accrual.py

➞

Show inline comments

@@ ... / @@ -587,18 +587,19 @@ def run_main(arglist, config=None): @@
+        )
     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):
@@ ... / @@ -683,27 +684,30 @@ def test_main_aging_report(tmp_path, arglist): @@
     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

@@ ... / @@ -66,12 +66,20 @@ 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:

0 comments (0 inline, 0 general)