Add grouped validation summary to stderr output#142
Open
DanielSebagala wants to merge 1 commit into
Open
Conversation
Adds ValidationSummaryHandler that collects all errors and warnings
during validation and prints a categorized summary at the end, grouped
by severity and sorted by frequency. This makes it easier for curators
to triage validation output at a glance rather than scanning a
chronological log stream.
Example output:
ERRORS (8):
[4] Normal sample id not in list...
[2] Value of numeric attribute is not a real number
WARNINGS (10):
[4] Unrecognized field in meta file
[1] Missing clinical data for a patient...
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.
Adds a
ValidationSummaryHandlertovalidateData.pythat prints a categorized summary of all errors and warnings at the end of validation.Problem
The current validator streams messages chronologically as they're found. For large studies with many issues, curators have to scroll through the full log to understand what went wrong and how often. The per-file summaries (line count with warnings/errors) help, but don't aggregate across the full study or group by message type.
Solution
A new
ValidationSummaryHandler(a standardlogging.Handlersubclass) collects all ERROR and WARNING messages during validation and prints a grouped, counted summary to stderr after validation completes:Changes
ValidationSummaryHandlerclass (~50 lines) afterMaxLevelTrackingHandlermain_validate()to register the handlerTesting
study_various_issues,study_es_3,study_wr_clin— all produce correct grouped summariesValidation of data {status}line