naturaldelta: include OverflowError in the int() guard so float('inf') returns unchanged#342
Open
HrachShah wants to merge 3 commits into
Open
Conversation
… -st, -nd, -rd, -th
…) returns unchanged
The docstring says naturaldelta returns non-number input unchanged. int(float('inf')) raises OverflowError (not ValueError or TypeError), so the existing except (ValueError, TypeError) clause let it escape.
The two new test cases (float('inf') and float('-inf')) fail on the pre-fix code with OverflowError and pass once OverflowError is added to the except tuple. The existing 'NaN' string case still returns "NaN" because str('NaN') is 'NaN' and float('NaN') → nan → int(nan) still raises ValueError which is still caught.
for more information, see https://pre-commit.ci
Member
|
There's already an approved PR for this: #334. What's wrong with that PR? What does this PR add or do better? |
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
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.
Fixes #333.
naturaldelta()documents that a non-finite float value (e.g.NaN,inf) is "returned unchanged." The previous code wrapped theint(value)probe inexcept (ValueError, TypeError), which catchesNaN(int(float('nan'))raisesValueError) but missesfloat('inf')andfloat('-inf')— those raiseOverflowErrorfrom the same conversion. The result was an uncaughtOverflowError: cannot convert float infinity to integerforhumanize.naturaldelta(float('inf')), in contradiction with the docstring.Adding
OverflowErrorto the caught tuple restores the documented behaviour:naturaldelta(float('inf'))now returns'inf'andnaturaldelta(float('-inf'))returns'-inf', symmetric with the existingNaNcase.Two new parametrized cases (
float("inf")andfloat("-inf")) on the existingtest_naturaldeltaexercise the issue. They fail on the pre-fix code with the exactOverflowErrorreported in #333 and pass with the fix. Themath.isfinite(test_input)guard on the existingnaturaldelta(-test_input)symmetry assertion is needed because-float('inf')isfloat('-inf')(and vice versa), so negating and re-formatting would not round-trip.Verified with
python3 -m pytest tests/: 727 passed, 69 skipped (unrelated).