Fix truthiness bug in region boundary checks — use is not None instead of boolean evaluation#941
Open
blankirigaya wants to merge 1 commit intomalariagen:masterfrom
Open
Conversation
Replace if region.start or region.end: with if region.start is not None or region.end is not None: across 7 locations in snp_data.py (5) and hap_data.py (2). Python treats 0 as falsy, so the old check would skip region slicing when start=0, returning the entire contig instead of the requested region — a silent data-correctness bug.
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
1 participant
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.
Fixes #940 .
0 is a valid genomic start coordinate but is falsy in Python. All 7 region boundary checks of the form if region.start or region.end would skip slicing when start=0, silently returning the entire contig.
Changed all 7 instances to if region.start is not None or region.end is not None, which correctly distinguishes between "no boundary specified" and "boundary is zero".
Files changed: snp_data.py (lines 244, 344, 497, 661, 1134), hap_data.py (lines 146, 388).
Testing: Existing tests should be supplemented with cases where region.start=0 to cover this boundary condition — these would have passed incorrectly before this fix.