mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-10-02 22:54:42 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

[flake8-pyi] Avoid rewriting invalid type expressions in unnecessary-type-union (PYI055) (#14660)
Some checks are pending
CI / Determine changes (push) Waiting to run
Details
CI / cargo fmt (push) Waiting to run
Details
CI / cargo clippy (push) Blocked by required conditions
Details
CI / cargo test (linux) (push) Blocked by required conditions
Details
CI / cargo test (linux, release) (push) Blocked by required conditions
Details
CI / cargo test (windows) (push) Blocked by required conditions
Details
CI / cargo test (wasm) (push) Blocked by required conditions
Details
CI / cargo build (release) (push) Waiting to run
Details
CI / cargo build (msrv) (push) Blocked by required conditions
Details
CI / cargo fuzz build (push) Blocked by required conditions
Details
CI / fuzz parser (push) Blocked by required conditions
Details
CI / test scripts (push) Blocked by required conditions
Details
CI / ecosystem (push) Blocked by required conditions
Details
CI / cargo shear (push) Blocked by required conditions
Details
CI / python package (push) Waiting to run
Details
CI / pre-commit (push) Waiting to run
Details
CI / mkdocs (push) Waiting to run
Details
CI / formatter instabilities and black similarity (push) Blocked by required conditions
Details
CI / test ruff-lsp (push) Blocked by required conditions
Details
CI / benchmarks (push) Blocked by required conditions
Details

Browse source
This commit is contained in:
Simon Brugman 2024-11-28 19:30:50 +01:00 • committed by GitHub
parent 224fe75a76
commit abb3c6ea95
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 92 additions and 68 deletions
Download patch file Download diff file Expand all files Collapse all files

20
crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI055.py vendored
View file

@ -5,10 +5,10 @@ s: builtins.type[int] | builtins.type[str] | builtins.type[complex]
t: type[int] | type[str] | type[float] t: type[int] | type[str] | type[float]
u: builtins.type[int] | type[str] | builtins.type[complex] u: builtins.type[int] | type[str] | builtins.type[complex]
v: Union[type[float], type[complex]] v: Union[type[float], type[complex]]
w: Union[type[float, int], type[complex]] w: Union[type[float | int], type[complex]]
x: Union[Union[type[float, int], type[complex]]] x: Union[Union[type[Union[float, int]], type[complex]]]
y: Union[Union[Union[type[float, int], type[complex]]]] y: Union[Union[Union[type[float | int], type[complex]]]]
z: Union[type[complex], Union[Union[type[float, int]]]] z: Union[type[complex], Union[Union[type[Union[float, int]]]]]
def func(arg: type[int] | str | type[float]) -> None: def func(arg: type[int] | str | type[float]) -> None:
@ -16,8 +16,8 @@ def func(arg: type[int] | str | type[float]) -> None:
# OK # OK
x: type[int, str, float] x: type[int | str | float]
y: builtins.type[int, str, complex] y: builtins.type[int | str | complex]
z: Union[float, complex] z: Union[float, complex]
@ -68,3 +68,11 @@ def convert_union(union: UnionType) -> _T | None:
Union[type[_T] | type[Converter[_T]] | str] | Converter[_T] | Callable[[str], _T], ... # PYI055 Union[type[_T] | type[Converter[_T]] | str] | Converter[_T] | Callable[[str], _T], ... # PYI055
] = union.__args__ ] = union.__args__
... ...
# `type[float, int]`` is not valid, use `type[float|int]` or `type[Union[float, int]]`
# OK for PYI055, should be covered by another check.
a: Union[type[float, int], type[complex]]
b: Union[Union[type[float, int], type[complex]]]
c: Union[Union[Union[type[float, int], type[complex]]]]
d: Union[type[complex], Union[Union[type[float, int]]]]

19
crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI055.pyi vendored
View file

@ -5,16 +5,16 @@ s: builtins.type[int] | builtins.type[str] | builtins.type[complex]
t: type[int] | type[str] | type[float] t: type[int] | type[str] | type[float]
u: builtins.type[int] | type[str] | builtins.type[complex] u: builtins.type[int] | type[str] | builtins.type[complex]
v: Union[type[float], type[complex]] v: Union[type[float], type[complex]]
w: Union[type[float, int], type[complex]] w: Union[type[Union[float, int]], type[complex]]
x: Union[Union[type[float, int], type[complex]]] x: Union[Union[type[Union[float, int]], type[complex]]]
y: Union[Union[Union[type[float, int], type[complex]]]] y: Union[Union[Union[type[Union[float, int]], type[complex]]]]
z: Union[type[complex], Union[Union[type[float, int]]]] z: Union[type[complex], Union[Union[type[Union[float, int]]]]]
def func(arg: type[int] | str | type[float]) -> None: ... def func(arg: type[int] | str | type[float]) -> None: ...
# OK # OK
x: type[int, str, float] x: type[int | str | float]
y: builtins.type[int, str, complex] y: builtins.type[int | str | complex]
z: Union[float, complex] z: Union[float, complex]
def func(arg: type[int, float] | str) -> None: ... def func(arg: type[int, float] | str) -> None: ...
@ -29,3 +29,10 @@ def func():
item3: Union[ # comment item3: Union[ # comment
type[requests_mock.Mocker], # another comment type[requests_mock.Mocker], # another comment
type[httpretty], type[str]] = requests_mock.Mocker type[httpretty], type[str]] = requests_mock.Mocker
# OK
w: Union[type[float, int], type[complex]]
x: Union[Union[type[float, int], type[complex]]]
y: Union[Union[Union[type[float, int], type[complex]]]]
z: Union[type[complex], Union[Union[type[float, int]]]]

7
crates/ruff_linter/src/rules/flake8_pyi/rules/unnecessary_type_union.rs
View file

@ -89,7 +89,12 @@ pub(crate) fn unnecessary_type_union<'a>(checker: &mut Checker, union: &'a Expr)
} }
match expr { match expr {
Expr::Subscript(ast::ExprSubscript { slice, value, .. }) => { Expr::Subscript(ast::ExprSubscript { slice, value, .. }) => {
if semantic.match_builtin_expr(value, "type") { // The annotation `type[a, b]` is not valid since `type` accepts
// a single parameter. This likely is a confusion with `type[a | b]` or
// `type[Union[a, b]]`. Do not emit a diagnostic for invalid type
// annotations.
if !matches!(**slice, Expr::Tuple(_)) && semantic.match_builtin_expr(value, "type")
{
type_exprs.push(slice); type_exprs.push(slice);
} else { } else {
other_exprs.push(expr); other_exprs.push(expr);

1
crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI055_PYI055.py.snap
View file

@ -167,3 +167,4 @@ PYI055.py:68:9: PYI055 [*] Multiple `type` members in a union. Combine them into
68 |+ type[_T | Converter[_T]] | str | Converter[_T] | Callable[[str], _T], ... # PYI055 68 |+ type[_T | Converter[_T]] | str | Converter[_T] | Callable[[str], _T], ... # PYI055
69 69 | ] = union.__args__ 69 69 | ] = union.__args__
70 70 | ... 70 70 | ...
71 71 |

113
crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI055_PYI055.pyi.snap
View file

@ -40,7 +40,7 @@ PYI055.pyi:5:4: PYI055 [*] Multiple `type` members in a union. Combine them into
5 |+t: type[int | str | float] 5 |+t: type[int | str | float]
6 6 | u: builtins.type[int] | type[str] | builtins.type[complex] 6 6 | u: builtins.type[int] | type[str] | builtins.type[complex]
7 7 | v: Union[type[float], type[complex]] 7 7 | v: Union[type[float], type[complex]]
8 8 | w: Union[type[float, int], type[complex]] 8 8 | w: Union[type[Union[float, int]], type[complex]]
PYI055.pyi:6:4: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[int | str | complex]`. PYI055.pyi:6:4: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[int | str | complex]`.
| |
@ -49,7 +49,7 @@ PYI055.pyi:6:4: PYI055 [*] Multiple `type` members in a union. Combine them into
6 | u: builtins.type[int] | type[str] | builtins.type[complex] 6 | u: builtins.type[int] | type[str] | builtins.type[complex]
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055
7 | v: Union[type[float], type[complex]] 7 | v: Union[type[float], type[complex]]
8 | w: Union[type[float, int], type[complex]] 8 | w: Union[type[Union[float, int]], type[complex]]
| |
= help: Combine multiple `type` members = help: Combine multiple `type` members
@ -60,8 +60,8 @@ PYI055.pyi:6:4: PYI055 [*] Multiple `type` members in a union. Combine them into
6 |-u: builtins.type[int] | type[str] | builtins.type[complex] 6 |-u: builtins.type[int] | type[str] | builtins.type[complex]
6 |+u: type[int | str | complex] 6 |+u: type[int | str | complex]
7 7 | v: Union[type[float], type[complex]] 7 7 | v: Union[type[float], type[complex]]
8 8 | w: Union[type[float, int], type[complex]] 8 8 | w: Union[type[Union[float, int]], type[complex]]
9 9 | x: Union[Union[type[float, int], type[complex]]] 9 9 | x: Union[Union[type[Union[float, int]], type[complex]]]
PYI055.pyi:7:4: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[Union[float, complex]]`. PYI055.pyi:7:4: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[Union[float, complex]]`.
| |
@ -69,8 +69,8 @@ PYI055.pyi:7:4: PYI055 [*] Multiple `type` members in a union. Combine them into
6 | u: builtins.type[int] | type[str] | builtins.type[complex] 6 | u: builtins.type[int] | type[str] | builtins.type[complex]
7 | v: Union[type[float], type[complex]] 7 | v: Union[type[float], type[complex]]
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055
8 | w: Union[type[float, int], type[complex]] 8 | w: Union[type[Union[float, int]], type[complex]]
9 | x: Union[Union[type[float, int], type[complex]]] 9 | x: Union[Union[type[Union[float, int]], type[complex]]]
| |
= help: Combine multiple `type` members = help: Combine multiple `type` members
@ -80,18 +80,18 @@ PYI055.pyi:7:4: PYI055 [*] Multiple `type` members in a union. Combine them into
6 6 | u: builtins.type[int] | type[str] | builtins.type[complex] 6 6 | u: builtins.type[int] | type[str] | builtins.type[complex]
7 |-v: Union[type[float], type[complex]] 7 |-v: Union[type[float], type[complex]]
7 |+v: type[Union[float, complex]] 7 |+v: type[Union[float, complex]]
8 8 | w: Union[type[float, int], type[complex]] 8 8 | w: Union[type[Union[float, int]], type[complex]]
9 9 | x: Union[Union[type[float, int], type[complex]]] 9 9 | x: Union[Union[type[Union[float, int]], type[complex]]]
10 10 | y: Union[Union[Union[type[float, int], type[complex]]]] 10 10 | y: Union[Union[Union[type[Union[float, int]], type[complex]]]]
PYI055.pyi:8:4: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[Union[float, int, complex]]`. PYI055.pyi:8:4: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[Union[Union[float, int], complex]]`.
| |
6 | u: builtins.type[int] | type[str] | builtins.type[complex] 6 | u: builtins.type[int] | type[str] | builtins.type[complex]
7 | v: Union[type[float], type[complex]] 7 | v: Union[type[float], type[complex]]
8 | w: Union[type[float, int], type[complex]] 8 | w: Union[type[Union[float, int]], type[complex]]
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055
9 | x: Union[Union[type[float, int], type[complex]]] 9 | x: Union[Union[type[Union[float, int]], type[complex]]]
10 | y: Union[Union[Union[type[float, int], type[complex]]]] 10 | y: Union[Union[Union[type[Union[float, int]], type[complex]]]]
| |
= help: Combine multiple `type` members = help: Combine multiple `type` members
@ -99,77 +99,77 @@ PYI055.pyi:8:4: PYI055 [*] Multiple `type` members in a union. Combine them into
5 5 | t: type[int] | type[str] | type[float] 5 5 | t: type[int] | type[str] | type[float]
6 6 | u: builtins.type[int] | type[str] | builtins.type[complex] 6 6 | u: builtins.type[int] | type[str] | builtins.type[complex]
7 7 | v: Union[type[float], type[complex]] 7 7 | v: Union[type[float], type[complex]]
8 |-w: Union[type[float, int], type[complex]] 8 |-w: Union[type[Union[float, int]], type[complex]]
8 |+w: type[Union[float, int, complex]] 8 |+w: type[Union[Union[float, int], complex]]
9 9 | x: Union[Union[type[float, int], type[complex]]] 9 9 | x: Union[Union[type[Union[float, int]], type[complex]]]
10 10 | y: Union[Union[Union[type[float, int], type[complex]]]] 10 10 | y: Union[Union[Union[type[Union[float, int]], type[complex]]]]
11 11 | z: Union[type[complex], Union[Union[type[float, int]]]] 11 11 | z: Union[type[complex], Union[Union[type[Union[float, int]]]]]
PYI055.pyi:9:4: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[Union[float, int, complex]]`. PYI055.pyi:9:4: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[Union[Union[float, int], complex]]`.
| |
7 | v: Union[type[float], type[complex]] 7 | v: Union[type[float], type[complex]]
8 | w: Union[type[float, int], type[complex]] 8 | w: Union[type[Union[float, int]], type[complex]]
9 | x: Union[Union[type[float, int], type[complex]]] 9 | x: Union[Union[type[Union[float, int]], type[complex]]]
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055
10 | y: Union[Union[Union[type[float, int], type[complex]]]] 10 | y: Union[Union[Union[type[Union[float, int]], type[complex]]]]
11 | z: Union[type[complex], Union[Union[type[float, int]]]] 11 | z: Union[type[complex], Union[Union[type[Union[float, int]]]]]
| |
= help: Combine multiple `type` members = help: Combine multiple `type` members
ℹ Safe fix ℹ Safe fix
6 6 | u: builtins.type[int] | type[str] | builtins.type[complex] 6 6 | u: builtins.type[int] | type[str] | builtins.type[complex]
7 7 | v: Union[type[float], type[complex]] 7 7 | v: Union[type[float], type[complex]]
8 8 | w: Union[type[float, int], type[complex]] 8 8 | w: Union[type[Union[float, int]], type[complex]]
9 |-x: Union[Union[type[float, int], type[complex]]] 9 |-x: Union[Union[type[Union[float, int]], type[complex]]]
9 |+x: type[Union[float, int, complex]] 9 |+x: type[Union[Union[float, int], complex]]
10 10 | y: Union[Union[Union[type[float, int], type[complex]]]] 10 10 | y: Union[Union[Union[type[Union[float, int]], type[complex]]]]
11 11 | z: Union[type[complex], Union[Union[type[float, int]]]] 11 11 | z: Union[type[complex], Union[Union[type[Union[float, int]]]]]
12 12 | 12 12 |
PYI055.pyi:10:4: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[Union[float, int, complex]]`. PYI055.pyi:10:4: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[Union[Union[float, int], complex]]`.
| |
8 | w: Union[type[float, int], type[complex]] 8 | w: Union[type[Union[float, int]], type[complex]]
9 | x: Union[Union[type[float, int], type[complex]]] 9 | x: Union[Union[type[Union[float, int]], type[complex]]]
10 | y: Union[Union[Union[type[float, int], type[complex]]]] 10 | y: Union[Union[Union[type[Union[float, int]], type[complex]]]]
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055
11 | z: Union[type[complex], Union[Union[type[float, int]]]] 11 | z: Union[type[complex], Union[Union[type[Union[float, int]]]]]
| |
= help: Combine multiple `type` members = help: Combine multiple `type` members
ℹ Safe fix ℹ Safe fix
7 7 | v: Union[type[float], type[complex]] 7 7 | v: Union[type[float], type[complex]]
8 8 | w: Union[type[float, int], type[complex]] 8 8 | w: Union[type[Union[float, int]], type[complex]]
9 9 | x: Union[Union[type[float, int], type[complex]]] 9 9 | x: Union[Union[type[Union[float, int]], type[complex]]]
10 |-y: Union[Union[Union[type[float, int], type[complex]]]] 10 |-y: Union[Union[Union[type[Union[float, int]], type[complex]]]]
10 |+y: type[Union[float, int, complex]] 10 |+y: type[Union[Union[float, int], complex]]
11 11 | z: Union[type[complex], Union[Union[type[float, int]]]] 11 11 | z: Union[type[complex], Union[Union[type[Union[float, int]]]]]
12 12 | 12 12 |
13 13 | def func(arg: type[int] | str | type[float]) -> None: ... 13 13 | def func(arg: type[int] | str | type[float]) -> None: ...
PYI055.pyi:11:4: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[Union[complex, float, int]]`. PYI055.pyi:11:4: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[Union[complex, Union[float, int]]]`.
| |
9 | x: Union[Union[type[float, int], type[complex]]] 9 | x: Union[Union[type[Union[float, int]], type[complex]]]
10 | y: Union[Union[Union[type[float, int], type[complex]]]] 10 | y: Union[Union[Union[type[Union[float, int]], type[complex]]]]
11 | z: Union[type[complex], Union[Union[type[float, int]]]] 11 | z: Union[type[complex], Union[Union[type[Union[float, int]]]]]
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055
12 | 12 |
13 | def func(arg: type[int] | str | type[float]) -> None: ... 13 | def func(arg: type[int] | str | type[float]) -> None: ...
| |
= help: Combine multiple `type` members = help: Combine multiple `type` members
ℹ Safe fix ℹ Safe fix
8 8 | w: Union[type[float, int], type[complex]] 8 8 | w: Union[type[Union[float, int]], type[complex]]
9 9 | x: Union[Union[type[float, int], type[complex]]] 9 9 | x: Union[Union[type[Union[float, int]], type[complex]]]
10 10 | y: Union[Union[Union[type[float, int], type[complex]]]] 10 10 | y: Union[Union[Union[type[Union[float, int]], type[complex]]]]
11 |-z: Union[type[complex], Union[Union[type[float, int]]]] 11 |-z: Union[type[complex], Union[Union[type[Union[float, int]]]]]
11 |+z: type[Union[complex, float, int]] 11 |+z: type[Union[complex, Union[float, int]]]
12 12 | 12 12 |
13 13 | def func(arg: type[int] | str | type[float]) -> None: ... 13 13 | def func(arg: type[int] | str | type[float]) -> None: ...
14 14 | 14 14 |
PYI055.pyi:13:15: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[int | float]`. PYI055.pyi:13:15: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[int | float]`.
| |
11 | z: Union[type[complex], Union[Union[type[float, int]]]] 11 | z: Union[type[complex], Union[Union[type[Union[float, int]]]]]
12 | 12 |
13 | def func(arg: type[int] | str | type[float]) -> None: ... 13 | def func(arg: type[int] | str | type[float]) -> None: ...
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PYI055
@ -179,14 +179,14 @@ PYI055.pyi:13:15: PYI055 [*] Multiple `type` members in a union. Combine them in
= help: Combine multiple `type` members = help: Combine multiple `type` members
ℹ Safe fix ℹ Safe fix
10 10 | y: Union[Union[Union[type[float, int], type[complex]]]] 10 10 | y: Union[Union[Union[type[Union[float, int]], type[complex]]]]
11 11 | z: Union[type[complex], Union[Union[type[float, int]]]] 11 11 | z: Union[type[complex], Union[Union[type[Union[float, int]]]]]
12 12 | 12 12 |
13 |-def func(arg: type[int] | str | type[float]) -> None: ... 13 |-def func(arg: type[int] | str | type[float]) -> None: ...
13 |+def func(arg: type[int | float] | str) -> None: ... 13 |+def func(arg: type[int | float] | str) -> None: ...
14 14 | 14 14 |
15 15 | # OK 15 15 | # OK
16 16 | x: type[int, str, float] 16 16 | x: type[int | str | float]
PYI055.pyi:23:7: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[requests_mock.Mocker | httpretty]`. PYI055.pyi:23:7: PYI055 [*] Multiple `type` members in a union. Combine them into one, e.g., `type[requests_mock.Mocker | httpretty]`.
| |
@ -270,3 +270,6 @@ PYI055.pyi:29:12: PYI055 [*] Multiple `type` members in a union. Combine them in
30 |- type[requests_mock.Mocker], # another comment 30 |- type[requests_mock.Mocker], # another comment
31 |- type[httpretty], type[str]] = requests_mock.Mocker 31 |- type[httpretty], type[str]] = requests_mock.Mocker
29 |+ item3: type[Union[requests_mock.Mocker, httpretty, str]] = requests_mock.Mocker 29 |+ item3: type[Union[requests_mock.Mocker, httpretty, str]] = requests_mock.Mocker
32 30 |
33 31 |
34 32 | # OK