[format check] Misleading scientific, engineering, or underscore grouping notations in float

[Pierre-Sassoulas]

Type of Changes

	Type
✓	✨ New feature

Description

A little experiment to gather feedback with primers and reviews (still a draft).

The idea is to enforce normalized ways to write number above a threshold or close to 0 in absolute value:

• Engineering notation (float)
• Scientific notation (float)
• Pep515 notation with underscore separated by pack of 3 digit (float or int)

Another idea could be to warn to use python's Decimal for number with more than 15 digits of precision, not sure if it should be the same checker though. We could also set/enforce a default precision for a project.

[Pierre-Sassoulas]

Never raised anywhere, the definition of the message cannot be found, not sure what it's about.

[codecov]

Codecov Report

❌ Patch coverage is 97.35450% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 95.98%. Comparing base (4eabe26) to head (bb5037e).

Files with missing lines	Patch %	Lines
pylint/checkers/format.py	97.35%	5 Missing ⚠️

❌ Your patch check has failed because the patch coverage (97.35%) is below the target coverage (100.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #10425      +/-   ##
==========================================
+ Coverage   95.96%   95.98%   +0.01%     
==========================================
  Files         176      176              
  Lines       19525    19710     +185     
==========================================
+ Hits        18738    18919     +181     
- Misses        787      791       +4     

Files with missing lines	Coverage Δ
pylint/checkers/format.py	97.31% <97.35%> (+0.31%)	⬆️

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[DanielNoord]

Seems useful, but would probably make it an extension? Or perhaps, first have it as an extension to get feedback?

[mbyrnepr2]

+1 for the idea

[Pierre-Sassoulas]

PEP 515 is talking about separating word in hexadecimal, might want to do something about it... later.

[github-actions]

🤖 Effect of this PR on checked open source code: 🤖

Effect on home-assistant:
The following messages are now emitted:

1. bad-float-notation:
   '1000000.0' is bigger than 1e6, and it should be written as '1_000_000.0' or '1e6' instead
   https://github.com/home-assistant/core/blob/ae84c7e15d70502c63f4c786486cb153d0b80aef/homeassistant/components/esphome/light.py#L244
2. bad-float-notation:
   '1000000.0' is bigger than 1e6, and it should be written as '1_000_000.0' or '1e6' instead
   https://github.com/home-assistant/core/blob/ae84c7e15d70502c63f4c786486cb153d0b80aef/homeassistant/util/unit_conversion.py#L795
3. bad-float-notation:
   '6356752.314245' is bigger than 1e6, and it should be written as '6.356752314245e6' or '6_356_752.314245' instead
   https://github.com/home-assistant/core/blob/ae84c7e15d70502c63f4c786486cb153d0b80aef/homeassistant/util/location.py#L26

Effect on music21:
The following messages are now emitted:

1. invalid-name:
   Attribute name "id" doesn't conform to '[a-z_][A-Za-z0-9_]{2,30}$' pattern
   https://github.com/cuthbertLab/music21/blob/e461154fce0d3675c78d73e847f73b9505561143/music21/prebase.py#L277

The following messages are no longer emitted:

1. invalid-name:
   Attribute name "id" doesn't conform to '[a-z_][A-Za-z0-9_]{2,30}$' pattern
   https://github.com/cuthbertLab/music21/blob/e461154fce0d3675c78d73e847f73b9505561143/music21/base.py#L612

Effect on django:
The following messages are now emitted:

1. invalid-name:
   Attribute name "ALLOWED_HOSTS" doesn't conform to snake_case naming style
   https://github.com/django/django/blob/bee64561a6e8cd22995c2b1254bab66dae892a6d/django/test/utils.py#L141
2. invalid-name:
   Attribute name "DEBUG" doesn't conform to snake_case naming style
   https://github.com/django/django/blob/bee64561a6e8cd22995c2b1254bab66dae892a6d/django/test/utils.py#L144
3. invalid-name:
   Attribute name "EMAIL_BACKEND" doesn't conform to snake_case naming style
   https://github.com/django/django/blob/bee64561a6e8cd22995c2b1254bab66dae892a6d/django/test/utils.py#L147
4. invalid-name:
   Attribute name "MIGRATION_MODULES" doesn't conform to snake_case naming style
   https://github.com/django/django/blob/bee64561a6e8cd22995c2b1254bab66dae892a6d/django/db/backends/base/creation.py#L79

Effect on sentry:
The following messages are now emitted:

1. bad-float-notation:
   '172422171096.56' is bigger than 1e6, and it should be written as '1.7242217109656e11' or '172.42217109656e9' or '172_422_171_096.56' instead
   https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/testutils/helpers/notifications.py#L289
2. bad-float-notation:
   '0.00' is smaller than 1e-6, and it should be written as '0.0' instead
   https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/options/defaults.py#L1319
3. bad-float-notation:
   '1541455200.0' is bigger than 1e6, and it should be written as '(3600 * 24 * 365 * 48) + (320 * 3600 * 24) + (22 * 3600)' or '1.5414552e9' or '1_541_455_200.0' instead
   https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/issue_examples.py#L53
4. bad-float-notation:
   '1541458800.0' is bigger than 1e6, and it should be written as '(3600 * 24 * 365 * 48) + (320 * 3600 * 24) + (23 * 3600)' or '1.5414588e9' or '1_541_458_800.0' instead
   https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/issue_examples.py#L54
5. bad-float-notation:
   '1541462400.0' is bigger than 1e6, and it should be written as '(3600 * 24 * 365 * 48) + (321 * 3600 * 24)' or '1.5414624e9' or '1_541_462_400.0' instead
   https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/issue_examples.py#L55
6. bad-float-notation:
   '1541466000.0' is bigger than 1e6, and it should be written as '(3600 * 24 * 365 * 48) + (321 * 3600 * 24) + (1 * 3600)' or '1.541466e9' or '1_541_466_000.0' instead
   https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/issue_examples.py#L56
7. bad-float-notation:
   '1541469600.0' is bigger than 1e6, and it should be written as '(3600 * 24 * 365 * 48) + (321 * 3600 * 24) + (2 * 3600)' or '1.5414696e9' or '1_541_469_600.0' instead
   https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/issue_examples.py#L57
8. bad-float-notation:
   '1541473200.0' is bigger than 1e6, and it should be written as '(3600 * 24 * 365 * 48) + (321 * 3600 * 24) + (3 * 3600)' or '1.5414732e9' or '1_541_473_200.0' instead
   https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/issue_examples.py#L58
9. bad-float-notation:
   '1541476800.0' is bigger than 1e6, and it should be written as '(3600 * 24 * 365 * 48) + (321 * 3600 * 24) + (4 * 3600)' or '1.5414768e9' or '1_541_476_800.0' instead
   https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/issue_examples.py#L59
10. bad-float-notation:
    '1541480400.0' is bigger than 1e6, and it should be written as '(3600 * 24 * 365 * 48) + (321 * 3600 * 24) + (5 * 3600)' or '1.5414804e9' or '1_541_480_400.0' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/issue_examples.py#L60
11. bad-float-notation:
    '1541484000.0' is bigger than 1e6, and it should be written as '(3600 * 24 * 365 * 48) + (321 * 3600 * 24) + (6 * 3600)' or '1.541484e9' or '1_541_484_000.0' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/issue_examples.py#L61
12. bad-float-notation:
    '1541487600.0' is bigger than 1e6, and it should be written as '(3600 * 24 * 365 * 48) + (321 * 3600 * 24) + (7 * 3600)' or '1.5414876e9' or '1_541_487_600.0' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/issue_examples.py#L62
13. bad-float-notation:
    '1541491200.0' is bigger than 1e6, and it should be written as '(3600 * 24 * 365 * 48) + (321 * 3600 * 24) + (8 * 3600)' or '1.5414912e9' or '1_541_491_200.0' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/issue_examples.py#L63
14. bad-float-notation:
    '1541494800.0' is bigger than 1e6, and it should be written as '(3600 * 24 * 365 * 48) + (321 * 3600 * 24) + (9 * 3600)' or '1.5414948e9' or '1_541_494_800.0' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/issue_examples.py#L64
15. bad-float-notation:
    '1541498400.0' is bigger than 1e6, and it should be written as '(3600 * 24 * 365 * 48) + (321 * 3600 * 24) + (10 * 3600)' or '1.5414984e9' or '1_541_498_400.0' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/issue_examples.py#L65
16. bad-float-notation:
    '1541502000.0' is bigger than 1e6, and it should be written as '(3600 * 24 * 365 * 48) + (321 * 3600 * 24) + (11 * 3600)' or '1.541502e9' or '1_541_502_000.0' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/issue_examples.py#L66
17. bad-float-notation:
    '1541505600.0' is bigger than 1e6, and it should be written as '(3600 * 24 * 365 * 48) + (321 * 3600 * 24) + (12 * 3600)' or '1.5415056e9' or '1_541_505_600.0' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/issue_examples.py#L67
18. bad-float-notation:
    '1541509200.0' is bigger than 1e6, and it should be written as '(3600 * 24 * 365 * 48) + (321 * 3600 * 24) + (13 * 3600)' or '1.5415092e9' or '1_541_509_200.0' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/issue_examples.py#L68
19. bad-float-notation:
    '1541512800.0' is bigger than 1e6, and it should be written as '(3600 * 24 * 365 * 48) + (321 * 3600 * 24) + (14 * 3600)' or '1.5415128e9' or '1_541_512_800.0' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/issue_examples.py#L69
20. bad-float-notation:
    '1541516400.0' is bigger than 1e6, and it should be written as '(3600 * 24 * 365 * 48) + (321 * 3600 * 24) + (15 * 3600)' or '1.5415164e9' or '1_541_516_400.0' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/issue_examples.py#L70
21. bad-float-notation:
    '1541520000.0' is bigger than 1e6, and it should be written as '(3600 * 24 * 365 * 48) + (321 * 3600 * 24) + (16 * 3600)' or '1.54152e9' or '1_541_520_000.0' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/issue_examples.py#L71
22. bad-float-notation:
    '1541523600.0' is bigger than 1e6, and it should be written as '(3600 * 24 * 365 * 48) + (321 * 3600 * 24) + (17 * 3600)' or '1.5415236e9' or '1_541_523_600.0' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/issue_examples.py#L72
23. bad-float-notation:
    '1541527200.0' is bigger than 1e6, and it should be written as '(3600 * 24 * 365 * 48) + (321 * 3600 * 24) + (18 * 3600)' or '1.5415272e9' or '1_541_527_200.0' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/issue_examples.py#L73
24. bad-float-notation:
    '1541530800.0' is bigger than 1e6, and it should be written as '(3600 * 24 * 365 * 48) + (321 * 3600 * 24) + (19 * 3600)' or '1.5415308e9' or '1_541_530_800.0' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/issue_examples.py#L74
25. bad-float-notation:
    '1541534400.0' is bigger than 1e6, and it should be written as '(3600 * 24 * 365 * 48) + (321 * 3600 * 24) + (20 * 3600)' or '1.5415344e9' or '1_541_534_400.0' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/issue_examples.py#L75
26. bad-float-notation:
    '1541538000.0' is bigger than 1e6, and it should be written as '(3600 * 24 * 365 * 48) + (321 * 3600 * 24) + (21 * 3600)' or '1.541538e9' or '1_541_538_000.0' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/issue_examples.py#L76
27. bad-float-notation:
    '1658770772.902' is bigger than 1e6, and it should be written as '1.658770772902e9' or '1_658_770_772.902' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/replay_examples.py#L123
28. bad-float-notation:
    '1658770772.902' is bigger than 1e6, and it should be written as '1.658770772902e9' or '1_658_770_772.902' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/replay_examples.py#L129
29. bad-float-notation:
    '1658770772.902' is bigger than 1e6, and it should be written as '1.658770772902e9' or '1_658_770_772.902' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/replay_examples.py#L130
30. bad-float-notation:
    '1665063926.125' is bigger than 1e6, and it should be written as '1.665063926125e9' or '1_665_063_926.125' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/replay_examples.py#L145
31. bad-float-notation:
    '1665063926.125' is bigger than 1e6, and it should be written as '1.665063926125e9' or '1_665_063_926.125' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/replay_examples.py#L151
32. bad-float-notation:
    '1665063926.833' is bigger than 1e6, and it should be written as '1.665063926833e9' or '1_665_063_926.833' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/replay_examples.py#L152
33. bad-float-notation:
    '1658770772.902' is bigger than 1e6, and it should be written as '1.658770772902e9' or '1_658_770_772.902' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/replay_examples.py#L170
34. bad-float-notation:
    '1658770772.902' is bigger than 1e6, and it should be written as '1.658770772902e9' or '1_658_770_772.902' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/replay_examples.py#L176
35. bad-float-notation:
    '1658770772.902' is bigger than 1e6, and it should be written as '1.658770772902e9' or '1_658_770_772.902' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/apidocs/examples/replay_examples.py#L177
36. bad-float-notation:
    '1504656000.0' is bigger than 1e6, and it should be written as '(3600 * 24 * 365 * 47) + (260 * 3600 * 24)' or '1.504656e9' or '1_504_656_000.0' instead
    https://github.com/getsentry/sentry/blob/244d66f54380a8940c55b689d152fcd98fc863d8/src/sentry/web/frontend/debug/mail.py#L198

This comment was generated for commit bb5037e