Handle time better

Author: Pierre-Sassoulas

pylint/checkers/format.py

@@ -586,6 +586,25 @@ def to_standard_scientific_notation(cls, number: float) -> str:
             return base
         return f"{base}.0"
 
+    @classmethod
+    def to_understandable_time(cls, number: float) -> str:
+        if number % 3600 != 0:
+            return ""  # Not a suspected time
+        parts: list[int] = [3600]
+        number //= 3600
+        for divisor in (
+            24,
+            7,
+            365,
+        ):
+            if number % divisor == 0:
+                parts.append(divisor)
+                number //= divisor
+        remainder = int(number)
+        if remainder != 1:
+            parts.append(remainder)
+        return " * ".join([str(p) for p in parts])
+
     @classmethod
     def to_standard_engineering_notation(cls, number: float) -> str:
         base, exp = cls.to_standard_or_engineering_base(number)
@@ -652,14 +671,20 @@ def _check_bad_float_notation(  # pylint: disable=too-many-locals
             or self.linter.config.strict_underscore_notation
         )
 
-        def raise_bad_float_notation(reason: str) -> None:
+        def raise_bad_float_notation(
+            reason: str, time_suggestion: bool = False
+        ) -> None:
             suggested = set()
             if scientific:
                 suggested.add(self.to_standard_scientific_notation(value))
             if engineering:
                 suggested.add(self.to_standard_engineering_notation(value))
             if pep515:
                 suggested.add(self.to_standard_underscore_grouping(value))
+            if time_suggestion:
+                maybe_a_time = self.to_understandable_time(value)
+                if maybe_a_time:
+                    suggested.add(maybe_a_time)
             return self.add_message(
                 "bad-float-notation",
                 args=(string, reason, "' or '".join(sorted(suggested))),
@@ -708,10 +733,12 @@ def raise_bad_float_notation(reason: str) -> None:
                 1 / threshold
             )
             threshold = self.to_standard_scientific_notation(threshold)
+            if under_threshold:
+                return raise_bad_float_notation(
+                    f"is smaller than {close_to_zero_threshold}"
+                )
             return raise_bad_float_notation(
-                f"is smaller than {close_to_zero_threshold}"
-                if under_threshold
-                else f"is bigger than {threshold}"
+                f"is bigger than {threshold}", time_suggestion=True
             )
         if has_exponent:
             if self.linter.config.strict_underscore_notation or has_underscore:

tests/checkers/unittest_format.py

@@ -213,7 +213,7 @@ def test_disable_global_option_end_of_line() -> None:
         ("20e-9", "2e-8", "20e-9", "2e-08"),  # 2e-08 is what python offer on str(float)
         (
             # 15 significant digits because we get rounding error otherwise
-            # and 15 seems enough especially since we don't autofix
+            # and 15 seems enough especially since we don't auto-fix
             "10_5415_456_465498.16354698489",
             "1.05415456465498e14",
             "105.415456465498e12",

tests/functional/b/bad_float/bad_float_notation_default.py

@@ -132,3 +132,11 @@ def function_with_underscore(param=10.0_0e3, other_param=20.0_0e3):
     if i < 0:
         continue
     print("Let's not be really annoying.")
+
+
+#+3: [bad-float-notation]
+#+3: [bad-float-notation]
+#+3: [bad-float-notation]
+time_in_s_since_two_week_ago_at_16 = 1180800 # 2 * 24 * 3600 - (8 * 3600)
+time_in_s_since_last_year = 31536000 # 365 * 24 * 3600
+time_in_s_since_last_month = 2592000  # 30 * 24 * 3600

tests/functional/b/bad_float/bad_float_notation_default.txt

@@ -53,3 +53,6 @@ bad-float-notation:121:21:121:28::'1.5_6e3' has exponent and underscore at the s
 bad-float-notation:122:27:122:33::'15_6e2' has exponent and underscore at the same time, and it should be written as '1.56e4' or '15.600000000000001e3' or '15_600.0' instead:HIGH
 bad-float-notation:125:35:125:43::'10.0_0e3' has exponent and underscore at the same time, and it should be written as '10_000.0' or '10e3' or '1e4' instead:HIGH
 bad-float-notation:125:57:125:65::'20.0_0e3' has exponent and underscore at the same time, and it should be written as '20_000.0' or '20e3' or '2e4' instead:HIGH
+bad-float-notation:140:37:140:44::'1180800' is bigger than 1e6, and it should be written as '1.1808e6' or '1_180_800.0' or '3600 * 328' instead:HIGH
+bad-float-notation:141:28:141:36::'31536000' is bigger than 1e6, and it should be written as '3.1536e7' or '31.536e6' or '31_536_000.0' or '3600 * 24 * 365' instead:HIGH
+bad-float-notation:142:29:142:36::'2592000' is bigger than 1e6, and it should be written as '2.592e6' or '2_592_000.0' or '3600 * 24 * 30' instead:HIGH