Add input validation for dictionary -form region parameters in _parse_single_region and add mini-test to it#1230
Open
Batmend-bit wants to merge 4 commits intomalariagen:masterfrom
Open
Conversation
…_signle_region and add mini-test to it
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.
Summary
This PR adds input validation for the 'Mapping' code path in '_parse_single_region'. In the previous code, there was no problem only if the inputs were perfectly safe. However, there was no input validation; malformed dictionary inputs can be silently accepted and would cause issues later. This change makes the function fail fast with a clear, actionable error message at the point of entry.
Problem
The following malformed inputs can be silently accepted:
Therefore, I thought that input validation for the 'Mapping' is useful.
Solution
Added the following validation in the 'isinstance(region, Mapping)' branch:
_handle_region_coordsAdditionally added a docstring to clarify expected input structure and validation behavior.
Effect
Testing
New tests were added in 'tests/test_util.py' with pytest by covering:
ValueErrorTypeErrorAll tests passed when I ran it with poetry: poetry run pytest tests/test_util.py -v