check if logger is instantiated by the user and tests#25
Merged
DoctorRabbit55 merged 3 commits intoGFZ:mainfrom Sep 24, 2025
Merged
check if logger is instantiated by the user and tests#25DoctorRabbit55 merged 3 commits intoGFZ:mainfrom
DoctorRabbit55 merged 3 commits intoGFZ:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a warning mechanism to alert users when the swvo package is imported without a logger being configured, improving user experience by providing clear guidance on logger setup.
- Added logger initialization check with colored warning messages in
swvo/__init__.py - Created comprehensive tests to verify warning behavior for both presence and absence of logger handlers
- Tests cover both
swvoandswvo.iomodule imports to ensure consistent behavior
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
swvo/__init__.py |
Added logger handler check with colored warning output and setup instructions |
tests/io/test_logger.py |
Added parameterized tests to verify warning behavior across different modules |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #24
This pull request introduces a mechanism to warn users if a logger has not been instantiated when importing the
swvopackage, and adds tests to verify this behavior.Logger initialization warning:
swvo/__init__.pyto check for logger handlers and print a colored warning if none are present, along with instructions for basic logger instantiation.Testing logger warning behavior:
tests/io/test_logger.pyto test that the logger warning is printed when no handlers are present, and not printed when handlers exist, for bothswvoandswvo.iomodules.