Replace print() with warnings.warn() for warning messages#164
Merged
Conversation
…cross 15 files - Replace 20 print() calls used for warnings with warnings.warn(UserWarning, stacklevel=2) - Add 'import warnings' where not already present (8 files) - Affects 14 standardized algorithm files + OsipiBase.py - Makes warnings suppressible via warnings.filterwarnings() and testable via pytest.warns() - Preserves intentional display prints in osipi_print_requirements/bias/citation
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
2 participants
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.
Replace all print() calls used for warning/informational messages with proper warnings.warn() calls across the standardized algorithm implementations and OsipiBase.py. This makes warnings suppressible, testable with pytest.warns(), and consistent with Python best practices.
Pattern that i am using here -
stacklevel=2 ensures the warning points to the caller's code, not the library internals and UserWarning category allows users to filter/suppress via warnings.filterwarnings()
Fixes #163