Quality: assert used for input validation instead of proper error handling#1276
Open
kumburovicbranko682-boop wants to merge 1 commit into
Conversation
…ndling
The `assert unary_red_code in _EQUIVALENT_NON_NAN_OPS` on line 42 is used to validate a function argument, not an internal invariant. When Python runs with the `-O` (optimize) flag, `assert` statements are stripped entirely. If a caller passes an invalid `unary_red_code`, the function will silently fall through to `_EQUIVALENT_NON_NAN_OPS[unary_red_code]` and raise a bare `KeyError` with no context about what went wrong or which inputs were invalid. For library code, argument validation should use explicit if/raise so it is never stripped by the interpreter. This also contradicts the project's own style guide ("Errors: try/except with raise").
Affected files: _unary_red_utils.py
Signed-off-by: kumburovicbranko682-boop <295886834+kumburovicbranko682-boop@users.noreply.github.com>
Contributor
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.
✨ Code Quality
Problem
The
assert unary_red_code in _EQUIVALENT_NON_NAN_OPSon line 42 is used to validate a function argument, not an internal invariant. When Python runs with the-O(optimize) flag,assertstatements are stripped entirely. If a caller passes an invalidunary_red_code, the function will silently fall through to_EQUIVALENT_NON_NAN_OPS[unary_red_code]and raise a bareKeyErrorwith no context about what went wrong or which inputs were invalid. For library code, argument validation should use explicit if/raise so it is never stripped by the interpreter. This also contradicts the project's own style guide ("Errors: try/except with raise").Severity:
mediumFile:
cupynumeric/_module/_unary_red_utils.pySolution
Replace the assert with a proper guard:
Changes
cupynumeric/_module/_unary_red_utils.py(modified)Testing
🤖 About this PR
This pull request was generated by ContribAI, an AI agent
that helps improve open source projects. The change was:
If you have questions or feedback about this PR, please comment below.
We appreciate your time reviewing this contribution!
Closes #1275