language-servers/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-10-01 06:11:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

[flake8-pyi] Fix false negative for PYI046 with unused generic protocols (#9405)

Browse source 
I just fixed this false negative in flake8-pyi
(https://github.com/PyCQA/flake8-pyi/pull/460), and then realised ruff
has the exact same bug! Luckily it's a very easy fix.

(The bug is that unused protocols go undetected if they're generic.)
This commit is contained in:
Alex Waygood 2024-01-05 18:56:04 +00:00 • committed by GitHub
parent 62eca330a8
commit cde4a7d7bf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 52 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

18
crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI046.py vendored
View file

@ -1,5 +1,5 @@
import typing import typing
from typing import Protocol from typing import Protocol, TypeVar
class _Foo(Protocol): class _Foo(Protocol):
@ -10,9 +10,23 @@ class _Bar(typing.Protocol):
bar: int bar: int
_T = TypeVar("_T")
class _Baz(Protocol[_T]):
x: _T
# OK # OK
class _UsedPrivateProtocol(Protocol): class _UsedPrivateProtocol(Protocol):
bar: int bar: int
def uses__UsedPrivateProtocol(arg: _UsedPrivateProtocol) -> None: ... # Also OK
class _UsedGenericPrivateProtocol(Protocol[_T]):
x: _T
def uses_some_private_protocols(
arg: _UsedPrivateProtocol, arg2: _UsedGenericPrivateProtocol[int]
) -> None: ...

18
crates/ruff_linter/resources/test/fixtures/flake8_pyi/PYI046.pyi vendored
View file

@ -1,5 +1,5 @@
import typing import typing
from typing import Protocol from typing import Protocol, TypeVar
class _Foo(object, Protocol): class _Foo(object, Protocol):
@ -10,9 +10,23 @@ class _Bar(typing.Protocol):
bar: int bar: int
_T = TypeVar("_T")
class _Baz(Protocol[_T]):
x: _T
# OK # OK
class _UsedPrivateProtocol(Protocol): class _UsedPrivateProtocol(Protocol):
bar: int bar: int
def uses__UsedPrivateProtocol(arg: _UsedPrivateProtocol) -> None: ... # Also OK
class _UsedGenericPrivateProtocol(Protocol[_T]):
x: _T
def uses_some_private_protocols(
arg: _UsedPrivateProtocol, arg2: _UsedGenericPrivateProtocol[int]
) -> None: ...

11
crates/ruff_linter/src/rules/flake8_pyi/rules/unused_private_type_definition.rs
View file

@ -1,5 +1,6 @@
use ruff_diagnostics::{Diagnostic, Violation}; use ruff_diagnostics::{Diagnostic, Violation};
use ruff_macros::{derive_message_formats, violation}; use ruff_macros::{derive_message_formats, violation};
use ruff_python_ast::helpers::map_subscript;
use ruff_python_ast::{self as ast, Expr, Stmt}; use ruff_python_ast::{self as ast, Expr, Stmt};
use ruff_python_semantic::Scope; use ruff_python_semantic::Scope;
use ruff_text_size::Ranged; use ruff_text_size::Ranged;
@ -243,11 +244,11 @@ pub(crate) fn unused_private_protocol(
continue; continue;
}; };
if !class_def if !class_def.bases().iter().any(|base| {
.bases() checker
.iter() .semantic()
.any(|base| checker.semantic().match_typing_expr(base, "Protocol")) .match_typing_expr(map_subscript(base), "Protocol")
{ }) {
continue; continue;
} }

7
crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI046_PYI046.py.snap
View file

@ -15,4 +15,11 @@ PYI046.py:9:7: PYI046 Private protocol `_Bar` is never used
10 | bar: int 10 | bar: int
| |
PYI046.py:16:7: PYI046 Private protocol `_Baz` is never used
|
16 | class _Baz(Protocol[_T]):
| ^^^^ PYI046
17 | x: _T
|

7
crates/ruff_linter/src/rules/flake8_pyi/snapshots/ruff_linter__rules__flake8_pyi__tests__PYI046_PYI046.pyi.snap
View file

@ -15,4 +15,11 @@ PYI046.pyi:9:7: PYI046 Private protocol `_Bar` is never used
10 | bar: int 10 | bar: int
| |
PYI046.pyi:16:7: PYI046 Private protocol `_Baz` is never used
|
16 | class _Baz(Protocol[_T]):
| ^^^^ PYI046
17 | x: _T
|