Add `pyflakes.extend-generics` setting #4677

JonathanPlasse · 2023-05-27T09:49:10Z

Close False positive for unused import when using type as string with generic class behind TYPE_CHECKING flag #4654
Improve documentation

Summary

This setting has been added to fix a false positive where an object should be considered an annotated subscript (c.f. #4654).

Test Plan

A fixture has been added that tests with and without the new setting.

github-actions · 2023-05-27T10:01:24Z

PR Check Results

Ecosystem

✅ ecosystem check detected no changes.

Benchmark

Linux

group                                      main                                   pr
-----                                      ----                                   --
linter/all-rules/large/dataset.py          1.01     17.0±0.06ms     2.4 MB/sec    1.00     16.9±0.08ms     2.4 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      4.1±0.01ms     4.1 MB/sec    1.00      4.1±0.01ms     4.1 MB/sec
linter/all-rules/numpy/globals.py          1.00    511.4±1.42µs     5.8 MB/sec    1.00    513.5±2.86µs     5.7 MB/sec
linter/all-rules/pydantic/types.py         1.00      7.1±0.03ms     3.6 MB/sec    1.00      7.1±0.02ms     3.6 MB/sec
linter/default-rules/large/dataset.py      1.00      8.2±0.02ms     5.0 MB/sec    1.00      8.2±0.02ms     5.0 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.00   1811.7±5.98µs     9.2 MB/sec    1.01   1826.8±2.82µs     9.1 MB/sec
linter/default-rules/numpy/globals.py      1.00    205.3±0.41µs    14.4 MB/sec    1.02    210.0±2.05µs    14.0 MB/sec
linter/default-rules/pydantic/types.py     1.00      3.7±0.01ms     6.8 MB/sec    1.00      3.7±0.01ms     6.8 MB/sec
parser/large/dataset.py                    1.16      7.3±0.00ms     5.6 MB/sec    1.00      6.3±0.00ms     6.5 MB/sec
parser/numpy/ctypeslib.py                  1.14   1394.4±0.96µs    11.9 MB/sec    1.00   1224.8±0.84µs    13.6 MB/sec
parser/numpy/globals.py                    1.11    139.8±0.19µs    21.1 MB/sec    1.00    126.2±0.24µs    23.4 MB/sec
parser/pydantic/types.py                   1.14      3.1±0.00ms     8.3 MB/sec    1.00      2.7±0.00ms     9.5 MB/sec

Windows

group                                      main                                   pr
-----                                      ----                                   --
linter/all-rules/large/dataset.py          1.00     17.4±0.25ms     2.3 MB/sec    1.00     17.4±0.23ms     2.3 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      4.3±0.08ms     3.8 MB/sec    1.01      4.4±0.09ms     3.8 MB/sec
linter/all-rules/numpy/globals.py          1.00   510.3±13.31µs     5.8 MB/sec    1.01   513.3±12.74µs     5.7 MB/sec
linter/all-rules/pydantic/types.py         1.00      7.3±0.13ms     3.5 MB/sec    1.00      7.3±0.31ms     3.5 MB/sec
linter/default-rules/large/dataset.py      1.01      8.4±0.12ms     4.8 MB/sec    1.00      8.4±0.08ms     4.9 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.00  1803.2±24.97µs     9.2 MB/sec    1.00  1798.3±22.62µs     9.3 MB/sec
linter/default-rules/numpy/globals.py      1.00    204.2±3.99µs    14.4 MB/sec    1.06   216.2±19.85µs    13.6 MB/sec
linter/default-rules/pydantic/types.py     1.00      3.8±0.04ms     6.7 MB/sec    1.01      3.8±0.05ms     6.7 MB/sec
parser/large/dataset.py                    1.01      6.6±0.09ms     6.1 MB/sec    1.00      6.5±0.06ms     6.2 MB/sec
parser/numpy/ctypeslib.py                  1.01  1247.6±23.31µs    13.3 MB/sec    1.00  1229.2±21.13µs    13.5 MB/sec
parser/numpy/globals.py                    1.00    125.3±1.73µs    23.6 MB/sec    1.00    125.4±2.14µs    23.5 MB/sec
parser/pydantic/types.py                   1.00      2.8±0.03ms     9.1 MB/sec    1.00      2.8±0.04ms     9.1 MB/sec

JonathanPlasse · 2023-05-27T21:29:44Z

crates/ruff_python_semantic/src/analyze/typing.rs

+        let extend_annotated_subscripts: Vec<CallPath> = extend_annotated_subscripts
+            .iter()
+            .map(|target| from_qualified_name(target))
+            .collect();


Should this be computed in the setting initialization?
I copied extend_immutable_calls implementation.

MichaReiser · 2023-05-30T07:03:05Z

crates/ruff_python_semantic/src/analyze/typing.rs

+        let extend_annotated_subscripts: Vec<CallPath> = extend_annotated_subscripts
+            .iter()
+            .map(|target| from_qualified_name(target))
+            .collect();


Do we need the collect call here? It seems that we only iterate once.

Changed it.

charliermarsh · 2023-06-01T22:24:42Z

@JonathanPlasse - I decided to rename this, since annotated-subscripts is more of an internal concept.

last-partizan · 2023-06-02T08:01:04Z

crates/ruff/src/rules/pyflakes/snapshots/ruff__rules__pyflakes__tests__F401_F401_15.py.snap

+  5 |+    pass
+6 6 | 
+7 7 | 
+8 8 | class Foo:


I'm little late for the party, but isn't this PR supposed to eliminate this error?

I'm trying to test it, with following config:

[pyflakes] extend-generics = ["django.db.models.ForeignKey"]

> cargo r --bin ruff -- crates/ruff/resources/test/fixtures/pyflakes/F401_15.py ... crates/ruff/resources/test/fixtures/pyflakes/F401_15.py:5:25: F401 [*] `pathlib.Path` imported but unused

This works if you put ruff.toml in the same folder as F401_15.py.

Oh, great, thank you!

JonathanPlasse commented May 27, 2023

View reviewed changes

MichaReiser reviewed May 30, 2023

View reviewed changes

MichaReiser requested a review from charliermarsh May 30, 2023 07:03

JonathanPlasse force-pushed the add-pyflakes-extend-annotated-subscripts branch from 0f54a62 to f194eee Compare May 30, 2023 11:37

Add pyflakes.extend-annotated-subscripts

98d07a5

JonathanPlasse force-pushed the add-pyflakes-extend-annotated-subscripts branch from f194eee to 98d07a5 Compare May 31, 2023 11:04

charliermarsh added 2 commits June 1, 2023 18:03

Merge branch 'main' into add-pyflakes-extend-annotated-subscripts

207b60f

Rename to extend-generics

b9f404f

charliermarsh changed the title ~~Add pyflakes.extend-annotated-subscripts new setting~~ Add pyflakes.extend-generics setting Jun 1, 2023

charliermarsh enabled auto-merge (squash) June 1, 2023 22:12

charliermarsh merged commit edadd78 into astral-sh:main Jun 1, 2023

last-partizan reviewed Jun 2, 2023

View reviewed changes

JonathanPlasse deleted the add-pyflakes-extend-annotated-subscripts branch June 2, 2023 08:19

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

Add pyflakes.extend-generics setting (#4677)

e2ac0cd

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `pyflakes.extend-generics` setting #4677

Add `pyflakes.extend-generics` setting #4677

JonathanPlasse commented May 27, 2023

github-actions bot commented May 27, 2023 •

edited

Loading

JonathanPlasse May 27, 2023

MichaReiser May 30, 2023

JonathanPlasse May 30, 2023

charliermarsh commented Jun 1, 2023

last-partizan Jun 2, 2023

JonathanPlasse Jun 2, 2023

last-partizan Jun 2, 2023

Add pyflakes.extend-generics setting #4677

Add pyflakes.extend-generics setting #4677

Conversation

JonathanPlasse commented May 27, 2023

Summary

Test Plan

github-actions bot commented May 27, 2023 • edited Loading

PR Check Results

Ecosystem

Benchmark

Linux

Windows

JonathanPlasse May 27, 2023

Choose a reason for hiding this comment

MichaReiser May 30, 2023

Choose a reason for hiding this comment

JonathanPlasse May 30, 2023

Choose a reason for hiding this comment

charliermarsh commented Jun 1, 2023

last-partizan Jun 2, 2023

Choose a reason for hiding this comment

JonathanPlasse Jun 2, 2023

Choose a reason for hiding this comment

last-partizan Jun 2, 2023

Choose a reason for hiding this comment

Add `pyflakes.extend-generics` setting #4677

Add `pyflakes.extend-generics` setting #4677

github-actions bot commented May 27, 2023 •

edited

Loading