Remove exit flow control from logging

truth-quark commented 1 month ago

As part of refactoring, remove program flow control from the logging module.

The main tasks are:

[ ] Remove sys.exit() calls from logging module (in error/critical calls)
[ ] Throw exceptions where logging errors were raised before (see list below)
[ ] Add a catch all exception handler (in um2nc or command line code?)

$ pwd
.../projects/amami
$ grep -Ern "[.](error|critical)[(]" amami
amami/parsers/um2nc_parser.py:67:        LOGGER.error(f"Too many arguments.\n\nusage: {' '.join(USAGE.split())}")
amami/parsers/um2nc_parser.py:71:        LOGGER.error(f"No input file provided.\n\nusage: {' '.join(USAGE.split())}")
amami/__init__logging_tinker.py:97:    LOGGER.error("How is this ERROR message formatted with tabs?\nHeres line 2\nHere's3\nThen line 4")
amami/um_utils.py:51:                    LOGGER.error(
amami/um_utils.py:59:                LOGGER.error(
amami/um_utils.py:67:                LOGGER.error(
amami/um_utils.py:167:        LOGGER.error(f"{um_filename.resolve()} does not appear to be a UM file.")
amami/um_utils.py:169:        LOGGER.error(f"{um_filename} does not appear to be a UM ancillary file.")
amami/um_utils.py:180:        LOGGER.error(
amami/commands/um2nc.py:46:        LOGGER.error(
amami/commands/um2nc.py:113:                LOGGER.error(
amami/commands/um2nc.py:122:            LOGGER.error(
amami/commands/um2nc.py:299:        LOGGER.error(
amami/commands/um2nc.py:482:        LOGGER.error(
amami/commands/um2nc.py:558:        LOGGER.error(e)
amami/commands/um2nc_tinker.py:63:        LOGGER.error(
amami/commands/um2nc_tinker.py:127:        LOGGER.error(e)
amami/commands/um2nc_tinker.py:151:        LOGGER.error(
amami/commands/um2nc_tinker.py:221:                LOGGER.error(
amami/commands/um2nc_tinker.py:230:            LOGGER.error(
amami/commands/um2nc_tinker.py:412:        LOGGER.error(
amami/helpers.py:26:        LOGGER.error(f"File '{abspath}' does not exist.")
amami/helpers.py:28:        LOGGER.error(f"Directory '{absdir}' does not exist.")

truth-quark commented 1 month ago

Also relates to issue #18.

atteggiani commented 1 month ago

This can be done but we need to change/add a few points to have the same result as we have now:

[ ] Implement at least one custom exception
[ ] Remove sys.exit() calls from logging module (in error/critical calls) and substitute those by raising a custom exception
[ ] Place the command line main() entry point function (Amami(sys.argv).run_command()) inside a try block
[ ] Add a global catch for all custom exceptions that logs the exception error (via logger.error()) and exits (via sys.exit())

ACCESS-NRI / amami

Remove exit flow control from logging #40