Merge pull request #771 from Zhuyuyangyy/fix/fractional-zero-whole-number

fix: format exact zero as a whole number in fractional

Author: staticdev

docs/usage.md

@@ -344,6 +344,9 @@ human_readable.fractional(1.5)
 
 human_readable.fractional(0.3)
 "3/10"
+
+human_readable.fractional(0.0)
+"0"
 ```
 
 ### Scientific notation

src/human_readable/numbers.py

@@ -191,6 +191,8 @@ def fractional(value: str | float) -> str:
         '1/3'
         >>> fractional(1)
         '1'
+        >>> fractional(0.0)
+        '0'
 
     This will always return a string.
 
@@ -202,6 +204,8 @@ def fractional(value: str | float) -> str:
 
     """
     number = float(value)
+    if number == 0:
+        return "0"
     whole_number = int(number)
     frac = fractions.Fraction(number - whole_number).limit_denominator(1000)
     numerator = frac.numerator

tests/unit/test_numbers.py

@@ -77,12 +77,21 @@ def test_ap_number(params: int, expected: str) -> None:
     [
         (1, "1"),  # whole number int
         (2.0, "2"),  # whole number float
+        (0, "0"),  # zero integer
+        (0.0, "0"),  # zero float
+        (-0.0, "0"),  # negative zero float
+        ("0", "0"),  # zero string
+        (-2, "-2"),  # negative whole number
         (5 / 6.0, "5/6"),  # simple fraction
         (8.9, "8 9/10"),  # compound fraction
         ("8.9", "8 9/10"),  # string fraction
+        (-0.5, "-1/2"),  # negative fraction
+        (-1.5, "-1 -1/2"),  # negative compound fraction
+        (0.3333333, "1/3"),  # limited denominator approximation
+        (0.0001, "0/1"),  # nonzero value rounded to zero by denominator limit
     ],
 )
-def test_fractional(params: int, expected: str) -> None:
+def test_fractional(params: str | float, expected: str) -> None:
     """Fractional number tests."""
     assert numbers.fractional(params) == expected