[`flake8-pyi`] Implement PYI054 #4775

density · 2023-06-01T03:52:49Z

Summary

Implement Y054 from https://github.com/PyCQA/flake8-pyi: Only numeric literals with a string representation <=10 characters long are permitted.

Test Plan

Added snapshot tests

ref: #848

crates/ruff/src/rules/flake8_pyi/rules/long_numeric_literals_in_stubs.rs

github-actions · 2023-06-01T04:05:57Z

PR Check Results

Ecosystem

ℹ️ ecosystem check detected changes. (+1, -0, 0 error(s))

typeshed (+1, -0)

+ stdlib/_winapi.pyi:60:39: PYI054 Numeric literals with a string representation longer than ten characters are not permitted

Rules changed: 1

Rule	Changes	Additions	Removals
PYI054	1	1	0

Benchmark

Linux

group                                      main                                   pr
-----                                      ----                                   --
linter/all-rules/large/dataset.py          1.00     14.3±0.11ms     2.8 MB/sec    1.00     14.3±0.15ms     2.8 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.01      3.4±0.01ms     4.9 MB/sec    1.00      3.4±0.01ms     4.9 MB/sec
linter/all-rules/numpy/globals.py          1.00    421.7±0.65µs     7.0 MB/sec    1.00    423.3±2.09µs     7.0 MB/sec
linter/all-rules/pydantic/types.py         1.01      5.9±0.04ms     4.3 MB/sec    1.00      5.9±0.02ms     4.4 MB/sec
linter/default-rules/large/dataset.py      1.00      6.8±0.02ms     6.0 MB/sec    1.00      6.8±0.02ms     6.0 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.00   1504.0±2.85µs    11.1 MB/sec    1.00   1504.6±2.09µs    11.1 MB/sec
linter/default-rules/numpy/globals.py      1.00    170.9±0.94µs    17.3 MB/sec    1.01    172.8±3.01µs    17.1 MB/sec
linter/default-rules/pydantic/types.py     1.00      3.1±0.01ms     8.2 MB/sec    1.00      3.1±0.01ms     8.3 MB/sec
parser/large/dataset.py                    1.00      5.1±0.01ms     7.9 MB/sec    1.01      5.2±0.01ms     7.9 MB/sec
parser/numpy/ctypeslib.py                  1.00   1009.8±2.46µs    16.5 MB/sec    1.00   1013.0±0.53µs    16.4 MB/sec
parser/numpy/globals.py                    1.00    104.3±0.18µs    28.3 MB/sec    1.00    104.6±0.27µs    28.2 MB/sec
parser/pydantic/types.py                   1.00      2.2±0.00ms    11.5 MB/sec    1.01      2.2±0.01ms    11.4 MB/sec

Windows

group                                      main                                   pr
-----                                      ----                                   --
linter/all-rules/large/dataset.py          1.00     16.9±0.12ms     2.4 MB/sec    1.00     16.9±0.11ms     2.4 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      4.3±0.06ms     3.8 MB/sec    1.00      4.3±0.02ms     3.8 MB/sec
linter/all-rules/numpy/globals.py          1.00    443.7±5.73µs     6.7 MB/sec    1.01    445.9±5.25µs     6.6 MB/sec
linter/all-rules/pydantic/types.py         1.00      7.2±0.04ms     3.6 MB/sec    1.01      7.2±0.08ms     3.5 MB/sec
linter/default-rules/large/dataset.py      1.00      8.5±0.04ms     4.8 MB/sec    1.00      8.5±0.09ms     4.8 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.01  1799.9±25.99µs     9.3 MB/sec    1.00  1782.6±12.55µs     9.3 MB/sec
linter/default-rules/numpy/globals.py      1.01    196.6±1.79µs    15.0 MB/sec    1.00    194.9±3.22µs    15.1 MB/sec
linter/default-rules/pydantic/types.py     1.01      3.9±0.04ms     6.6 MB/sec    1.00      3.8±0.03ms     6.6 MB/sec
parser/large/dataset.py                    1.00      6.7±0.03ms     6.1 MB/sec    1.00      6.7±0.03ms     6.1 MB/sec
parser/numpy/ctypeslib.py                  1.00   1267.6±7.15µs    13.1 MB/sec    1.00  1272.4±11.88µs    13.1 MB/sec
parser/numpy/globals.py                    1.00    131.9±0.86µs    22.4 MB/sec    1.00    131.8±1.04µs    22.4 MB/sec
parser/pydantic/types.py                   1.00      2.8±0.02ms     9.0 MB/sec    1.00      2.8±0.02ms     9.0 MB/sec

…ndled by PYI054

density · 2023-06-01T04:48:26Z

crates/ruff/src/rules/flake8_pyi/rules/simple_defaults.rs

+            match operand.as_ref() {
+                // Ex) `-1`, `-3.14`, `2j`
+                Expr::Constant(ast::ExprConstant {
+                    value: Constant::Int(..) | Constant::Float(..) | Constant::Complex { .. },
+                    ..
+                }) => return true,
+                // Ex) `-math.inf`, `-math.pi`, etc.
+                Expr::Attribute(_) => {
+                    if model.resolve_call_path(operand).map_or(false, |call_path| {
+                        ALLOWED_MATH_ATTRIBUTES_IN_DEFAULTS.iter().any(|target| {
+                            // reject `-math.nan`
+                            call_path.as_slice() == *target && *target != ["math", "nan"]
+                        })
+                    }) {
+                        return true;
+                    }


Removed the checks on numeric literal length since it's now covered by PYI054.

MichaReiser · 2023-06-01T06:18:07Z

crates/ruff/src/rules/flake8_pyi/rules/long_numeric_literals_in_stub.rs

+/// Checks for numeric literals longer than 10 characters
+///
+/// ## Why is this bad?
+/// Long hardcoded numeric values are unlikely to be useful for users. Consider replacing them with ellipses.


Can we add an example on how using ellipses looks? I wouldn't know what to do from reading the message itself.

@MichaReiser added an example and updated the comment - lmk if looks good. thanks!

Implement PYI054

2ee4e48

density marked this pull request as ready for review June 1, 2023 03:52

density commented Jun 1, 2023

View reviewed changes

crates/ruff/src/rules/flake8_pyi/rules/long_numeric_literals_in_stubs.rs Outdated Show resolved Hide resolved

remove s

618d97d

charliermarsh self-requested a review June 1, 2023 04:43

density added 2 commits June 1, 2023 00:44

Remove check for long numeric literals from PYI015 since it is now ha…

d70b15e

…ndled by PYI054

fix comments

67f799e

density commented Jun 1, 2023

View reviewed changes

MichaReiser approved these changes Jun 1, 2023

View reviewed changes

density and others added 6 commits June 1, 2023 09:11

update reasoning

7d84af7

Merge branch 'main' into PYI054

4b8e59a

Rename rule

95e32d8

Merge branch 'main' into PYI054

bd0232c

Merge

b0790df

Add fix

17a09b3

charliermarsh enabled auto-merge (squash) June 2, 2023 01:03

charliermarsh added the rule Implementing or modifying a lint rule label Jun 2, 2023

Fix always

3360343

charliermarsh merged commit c68686b into astral-sh:main Jun 2, 2023

density deleted the PYI054 branch June 2, 2023 03:37

chenrui333 mentioned this pull request Jun 6, 2023

ruff 0.0.272 Homebrew/homebrew-core#133013

Merged

konstin pushed a commit that referenced this pull request Jun 13, 2023

[flake8-pyi] Implement PYI054 (#4775)

06e20c5

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[`flake8-pyi`] Implement PYI054 #4775

[`flake8-pyi`] Implement PYI054 #4775

density commented Jun 1, 2023

github-actions bot commented Jun 1, 2023 •

edited

Loading

density Jun 1, 2023

MichaReiser Jun 1, 2023

density Jun 1, 2023

[flake8-pyi] Implement PYI054 #4775

[flake8-pyi] Implement PYI054 #4775

Conversation

density commented Jun 1, 2023

Summary

Test Plan

github-actions bot commented Jun 1, 2023 • edited Loading

PR Check Results

Ecosystem

Benchmark

Linux

Windows

density Jun 1, 2023

Choose a reason for hiding this comment

MichaReiser Jun 1, 2023

Choose a reason for hiding this comment

density Jun 1, 2023

Choose a reason for hiding this comment

[`flake8-pyi`] Implement PYI054 #4775

[`flake8-pyi`] Implement PYI054 #4775

github-actions bot commented Jun 1, 2023 •

edited

Loading