Simple logging system

[PinkShnack]

As outlined in #30, we should have a logging system for when files don't open correctly.

Features

• The logging system will output to a temporary afmformats.log file in the temp folder.
  • this can be picked up by github actions as an artifact for ci debugging
• %s string formatting used to keep with py3.6
• unit test for debugger
• show screenshots of local file, terminal output and ci artifact

[PinkShnack]

CI screenshots showing:
artifacts location

debug file (downloaded locally, looks like lots of interesting things to fix... displayed using TailViewer)

[PinkShnack]

Screenshot of local debug examples (just python console - found error with a docs example!)

[paulmueller]

Thanks for the PR!

IMO creating log files automatically on import without the user doing anything else seems a bit invasive. I would propose to remove all calls to configure_logging() in the library and instead setup logging during pytest_configure. Downstream users (which also includes PyJibe) will likely just attach their own handlers to the afmformats logger, so a default afmformats.log FileHandler will be redundant.

Some additional comments:

• configure_logging() is called twice (in __init__.py and in logging_setup.py); such redundancies should be avoided
• The DEFAULT_LOG_PATH, as it is defined, is not a default log path, because it will be either AFMFORMATS_LOG_PATH or /tmp (on POSIX). I would suggest to define it directly as os.path.join(tempfile.gettempdir(), "afmformats.log") and then use it in configure_logging.

[PinkShnack]

Thanks for the PR!

IMO creating log files automatically on import without the user doing anything else seems a bit invasive.

I hadn't even considered this aspect! Thanks

I would propose to remove all calls to configure_logging() in the library and instead setup logging during pytest_configure. Downstream users (which also includes PyJibe) will likely just attach their own handlers to the afmformats logger, so a default afmformats.log FileHandler will be redundant.

I'll do that, and perhaps include in the docs that users can set configure_logging() when they want logging output + logged file. That way I'll combine the configure_logging and configure_console_logging.

Some additional comments:

• configure_logging() is called twice (in __init__.py and in logging_setup.py); such redundancies should be avoided

Thanks will do.

• The DEFAULT_LOG_PATH, as it is defined, is not a default log path, because it will be either AFMFORMATS_LOG_PATH or /tmp (on POSIX). I would suggest to define it directly as os.path.join(tempfile.gettempdir(), "afmformats.log") and then use it in configure_logging.

👍

[PinkShnack]

@paulmueller whenever you have time please check that this makes sense. Perhaps the debugging level at different points of the loading functions could be improved?

[paulmueller]

Looks good to me otherwise.

[PinkShnack]

Ready