Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Contents
Description
This PR fixes the logging pattern to a more pythonic approach - due to how the codebase had evolved, it had a mixed methods approach: some dependency injection (explicitly passing the logger to each function), and some module level singleton (importing it).
This wasn't good - and essentially introduced uncertainty into new logging (which pattern to use where), and how settings were then being instantiated in the two entrypoints. This shown in #92 where we had to rerun the settings (by importing
SyncDBManager
) to avoid them being cleared where logging was instantiated later in the app.(with this change, we are now able to remove the import of
SyncDBManager
that fixed that issue, and make settings instantiation cleaner)This PR therefore configures the logging once at each entrypoint, and enables each module to
import logger
instead of it being repeatedly injected and further boilerplate code. This is generally accepted as the Python approach to handling logging configuration: https://docs.python.org/3/howto/logging-cookbook.html#using-logging-in-multiple-modulesScreenshots, example outputs/behaviour etc.
✅ Added/updated tests?