pygmt.binstats: Validate the quantile_value parameter #4332
+44
−2
Conversation
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
This commit adds input validation for quantile value, specifically that it is a number, and that it is between 0 and 100. It also adds testing for these changes, including modifying test_binstats_quantile() to pass a numeric value as a string.
seisman
reviewed
Jan 11, 2026
Comment on lines
+170
to
+178
| quantile_error_message = "quantile_value must be a value between 0 and 100." | ||
| try: | ||
| quantile_value_float = float(quantile_value) | ||
| except (ValueError, TypeError): | ||
| raise GMTInvalidInput(quantile_error_message) from None | ||
| if 0 <= quantile_value_float <= 100: | ||
| aliasdict["C"] += f"{quantile_value_float}" | ||
| else: | ||
| raise GMTInvalidInput(quantile_error_message) from None |
Member
There was a problem hiding this comment.
I don't think we should support a string value like quantile_value="75".
seisman
reviewed
Jan 11, 2026
Comment on lines
+170
to
+178
| quantile_error_message = "quantile_value must be a value between 0 and 100." | ||
| try: | ||
| quantile_value_float = float(quantile_value) | ||
| except (ValueError, TypeError): | ||
| raise GMTInvalidInput(quantile_error_message) from None | ||
| if 0 <= quantile_value_float <= 100: | ||
| aliasdict["C"] += f"{quantile_value_float}" | ||
| else: | ||
| raise GMTInvalidInput(quantile_error_message) from None |
Member
There was a problem hiding this comment.
Suggested change
| quantile_error_message = "quantile_value must be a value between 0 and 100." | |
| try: | |
| quantile_value_float = float(quantile_value) | |
| except (ValueError, TypeError): | |
| raise GMTInvalidInput(quantile_error_message) from None | |
| if 0 <= quantile_value_float <= 100: | |
| aliasdict["C"] += f"{quantile_value_float}" | |
| else: | |
| raise GMTInvalidInput(quantile_error_message) from None | |
| if not (isinstance(quantile_value, (int, float)) and (0 <= quantile_value <= 100): | |
| msg = "quantile_value must be a value between 0 and 100." | |
| raise GMTInvalidInput(msg) | |
| aliasdict["C"] += f"{quantile_value}" |
seisman
changed the title
seisman
added
maintenance
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.
Description of proposed changes
This adds input validation for quantile_value, specifically that it is a number, and that it is between 0 and 100. It also adds testing for this input validations, including modifying test_binstats_quantile() to pass a numeric value as a string.