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

Pierre-Sassoulas · 2025-06-12T21:59:53Z

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 · 2025-06-12T22:01:39Z

pylint/checkers/format.py

+                if string.endswith("l"):
+                    self.add_message("lowercase-l-suffix", line=line_num)


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

codecov · 2025-06-12T22:13:34Z

Codecov Report

Attention: Patch coverage is 97.35450% with 5 lines in your changes missing coverage. Please review.

Project coverage is 95.90%. Comparing base (f5aa766) to head (dc7592d).

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.88%   95.90%   +0.01%     
==========================================
  Files         176      176              
  Lines       19140    19325     +185     
==========================================
+ Hits        18352    18533     +181     
- Misses        788      792       +4

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

🚀 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 · 2025-06-17T09:26:22Z

+1 for the idea

Pierre-Sassoulas · 2025-06-17T21:39:05Z

pylint/checkers/format.py

+                    "x" not in string  # not a hexadecimal
+                    and "o" not in string  # not an octal
+                    and "j" not in string  # not a complex


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

Co-authored-by: shauss <stephane.hauss@gmail.com>

…mplementation

…arily for easier primer reading)

github-actions · 2025-06-22T21:23:22Z

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

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

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/7442f7af28d28a2f6e5417f4cb45e08476be63ac/homeassistant/components/esphome/light.py#L244
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/7442f7af28d28a2f6e5417f4cb45e08476be63ac/homeassistant/util/location.py#L26

Effect on sentry:
The following messages are now emitted:

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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/issue_examples.py#L53
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/issue_examples.py#L54
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/issue_examples.py#L55
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/issue_examples.py#L56
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/issue_examples.py#L57
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/issue_examples.py#L58
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/issue_examples.py#L59
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/issue_examples.py#L60
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/issue_examples.py#L61
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/issue_examples.py#L62
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/issue_examples.py#L63
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/issue_examples.py#L64
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/issue_examples.py#L65
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/issue_examples.py#L66
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/issue_examples.py#L67
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/issue_examples.py#L68
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/issue_examples.py#L69
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/issue_examples.py#L70
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/issue_examples.py#L71
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/issue_examples.py#L72
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/issue_examples.py#L73
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/issue_examples.py#L74
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/issue_examples.py#L75
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/issue_examples.py#L76
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/replay_examples.py#L123
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/replay_examples.py#L129
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/replay_examples.py#L130
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/replay_examples.py#L145
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/replay_examples.py#L151
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/replay_examples.py#L152
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/replay_examples.py#L170
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/replay_examples.py#L176
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/apidocs/examples/replay_examples.py#L177
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/testutils/helpers/notifications.py#L289
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/0da785052b486eb791022727af5805a291d059a4/src/sentry/web/frontend/debug/mail.py#L198

This comment was generated for commit dc7592d

Pierre-Sassoulas added this to the 4.0.0 milestone Jun 12, 2025

Pierre-Sassoulas added the Enhancement ✨ label Jun 12, 2025

Pierre-Sassoulas commented Jun 12, 2025

View reviewed changes

Pierre-Sassoulas force-pushed the scientific-notation-formatting branch from fdf5bc1 to 18b00a7 Compare June 13, 2025 19:11

Pierre-Sassoulas changed the title ~~[format] Add a check for standard scientific notation~~ [format check] Misleading scientific notations and use of underscore grouping in float Jun 13, 2025

Pierre-Sassoulas marked this pull request as draft June 14, 2025 18:53

DanielNoord reviewed Jun 16, 2025

View reviewed changes

Pierre-Sassoulas changed the title ~~[format check] Misleading scientific notations and use of underscore grouping in float~~ [format check] Misleading scientific, engineering or underscore grouping notations in float Jun 17, 2025

Pierre-Sassoulas changed the title ~~[format check] Misleading scientific, engineering or underscore grouping notations in float~~ [format check] Misleading scientific, engineering, or underscore grouping notations in float Jun 17, 2025

Pierre-Sassoulas force-pushed the scientific-notation-formatting branch from f3ff9d4 to 1db9508 Compare June 17, 2025 21:35

Pierre-Sassoulas commented Jun 17, 2025

View reviewed changes

Pierre-Sassoulas force-pushed the scientific-notation-formatting branch from 1db9508 to 77a3d6b Compare June 18, 2025 12:29

This comment has been minimized.

Sign in to view

Pierre-Sassoulas and others added 6 commits June 21, 2025 08:08

[format] Add a check for standard scientific notation

fb38153

Add esoteric-underscore-grouping

c741b28

Co-authored-by: shauss <stephane.hauss@gmail.com>

Some design and add doc to give an idea of the design before actual i…

3bd3176

…mplementation

Fix bad initialization of class

10a9188

Fix the strict notation functional tests

9a577d2

Fix the 0 case and mixed underscore and exponent case

2886dc7

Pierre-Sassoulas force-pushed the scientific-notation-formatting branch from cbe8b6a to 2886dc7 Compare June 21, 2025 09:12

This comment has been minimized.

Sign in to view

Give a reason for why a notation is bad and display the float (tempor…

7d5672d

…arily for easier primer reading)

This comment has been minimized.

Sign in to view

Pierre-Sassoulas added 2 commits June 21, 2025 21:27

Optimize 0

0e2f2dc

Handle time better

35898de

This comment has been minimized.

Sign in to view

Pierre-Sassoulas force-pushed the scientific-notation-formatting branch from 8ba51e0 to 35898de Compare June 21, 2025 19:41

This comment has been minimized.

Sign in to view

Higher default value for the threshold

2cbc302

This comment has been minimized.

Sign in to view

Pierre-Sassoulas added 2 commits June 22, 2025 13:26

[refactor] Create a float formatter helper class

399f6bd

Do not raise on int

eee0865

This comment has been minimized.

Sign in to view

Pierre-Sassoulas added 2 commits June 22, 2025 17:38

Special case 0. too

292fc36

Handle the case where the number is just 3600 better

5374940

This comment has been minimized.

Sign in to view

Handle the case where the number is a number of hours in second better

dc7592d

Pierre-Sassoulas force-pushed the scientific-notation-formatting branch from afc04e3 to dc7592d Compare June 22, 2025 20:57

Pierre-Sassoulas mentioned this pull request Jul 9, 2025

Extra arg for "method" (self) and "classmethod" (cls) #10443

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

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

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

Uh oh!

Pierre-Sassoulas commented Jun 12, 2025 •

edited

Loading

Uh oh!

Pierre-Sassoulas Jun 12, 2025

Uh oh!

codecov bot commented Jun 12, 2025 •

edited

Loading

Uh oh!

DanielNoord left a comment

Uh oh!

mbyrnepr2 commented Jun 17, 2025

Uh oh!

Pierre-Sassoulas Jun 17, 2025

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

github-actions bot commented Jun 22, 2025

Uh oh!

Uh oh!

		if string.endswith("l"):
		self.add_message("lowercase-l-suffix", line=line_num)

Uh oh!

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

Are you sure you want to change the base?

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

Uh oh!

Conversation

Pierre-Sassoulas commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Type of Changes

Description

Uh oh!

Pierre-Sassoulas Jun 12, 2025

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

DanielNoord left a comment

Choose a reason for hiding this comment

Uh oh!

mbyrnepr2 commented Jun 17, 2025

Uh oh!

Pierre-Sassoulas Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

github-actions bot commented Jun 22, 2025

Uh oh!

Uh oh!

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

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

Pierre-Sassoulas commented Jun 12, 2025 •

edited

Loading

codecov bot commented Jun 12, 2025 •

edited

Loading