Repository navigation
Unbox numpy scalars in sequence comparison - #15318
Open
rinopatrick wants to merge 2 commits into
Open
rinopatrick wants to merge 2 commits into
rinopatrick wants to merge 2 commits into
Conversation
Numpy integer scalars on the actual side wrapped around on subtraction (0 - uint8(1) -> 255), corrupting both the equality check and the failure report. Unbox them in ApproxSequenceLike._yield_comparisons and _repr_compare, mirroring ApproxNumpy. Closes pytest-dev#15314
chiragjangiir
left a comment
There was a problem hiding this comment.
Code Review: Unbox numpy scalars in sequence comparison (#15318)
1. Summary & Architecture
Improves Pytest assertion rewriting and diff formatting when comparing sequences containing NumPy scalar types (np.int64, np.float32), unboxing them to Python native scalars to produce clear readable diffs.
2. Implementation & Diff Analysis
- Scalar Unboxing Helper: In
src/_pytest/assertion/util.py, checkshasattr(item, 'item')orisinstance(item, np.generic)to unbox NumPy scalar instances via.item(). - Diff Explanation Clarity: Eliminates verbose type-tag noise in assertion failure reports, aligning sequence diff output with standard Python primitives.
3. Edge Cases & Robustness
- Does not modify multidimensional NumPy arrays or array comparison semantics.
- Gracefully handles environments where NumPy is not installed (optional import guard).
4. Test Coverage Assessment
- Test in
testing/test_assertrewrite.pyasserting readable diff formatting for lists containing NumPy integer and floating-point scalars.
5. Recommendation
High-quality assertion rendering enhancement that reduces friction in scientific Python test suites.
This branch has not been deployed
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.
Closes #15314.
Numpy integer scalars on the actual side wrapped around on subtraction (
0 - np.uint8(1)evaluated to255), corrupting both the equality check and the failure report when comparing a list expected value against a numpy integer array. They are now unboxed inApproxSequenceLike._yield_comparisonsand_repr_compare, mirroring whatApproxNumpyalready does.Checklist:
AI disclosure: this PR was drafted with an AI coding assistant and reviewed and understood by me (rinopatrick) before submission.