[red-knot] Detect (some) invalid protocols (#17488)

This commit is contained in:
Alex Waygood 2025-04-21 16:24:19 +01:00 committed by GitHub
parent 9ff4772a2c
commit 45b5dedee2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 76 additions and 19 deletions

View file

@ -136,13 +136,13 @@ If `Protocol` is present in the bases tuple, all other bases in the tuple must b
or `TypeError` is raised at runtime when the class is created. or `TypeError` is raised at runtime when the class is created.
```py ```py
# TODO: should emit `[invalid-protocol]` # error: [invalid-protocol] "Protocol class `Invalid` cannot inherit from non-protocol class `NotAProtocol`"
class Invalid(NotAProtocol, Protocol): ... class Invalid(NotAProtocol, Protocol): ...
# revealed: tuple[Literal[Invalid], Literal[NotAProtocol], typing.Protocol, typing.Generic, Literal[object]] # revealed: tuple[Literal[Invalid], Literal[NotAProtocol], typing.Protocol, typing.Generic, Literal[object]]
reveal_type(Invalid.__mro__) reveal_type(Invalid.__mro__)
# TODO: should emit an `[invalid-protocol`] error # error: [invalid-protocol] "Protocol class `AlsoInvalid` cannot inherit from non-protocol class `NotAProtocol`"
class AlsoInvalid(MyProtocol, OtherProtocol, NotAProtocol, Protocol): ... class AlsoInvalid(MyProtocol, OtherProtocol, NotAProtocol, Protocol): ...
# revealed: tuple[Literal[AlsoInvalid], Literal[MyProtocol], Literal[OtherProtocol], Literal[NotAProtocol], typing.Protocol, typing.Generic, Literal[object]] # revealed: tuple[Literal[AlsoInvalid], Literal[MyProtocol], Literal[OtherProtocol], Literal[NotAProtocol], typing.Protocol, typing.Generic, Literal[object]]

View file

@ -36,6 +36,7 @@ pub(crate) fn register_lints(registry: &mut LintRegistryBuilder) {
registry.register_lint(&INVALID_EXCEPTION_CAUGHT); registry.register_lint(&INVALID_EXCEPTION_CAUGHT);
registry.register_lint(&INVALID_METACLASS); registry.register_lint(&INVALID_METACLASS);
registry.register_lint(&INVALID_PARAMETER_DEFAULT); registry.register_lint(&INVALID_PARAMETER_DEFAULT);
registry.register_lint(&INVALID_PROTOCOL);
registry.register_lint(&INVALID_RAISE); registry.register_lint(&INVALID_RAISE);
registry.register_lint(&INVALID_SUPER_ARGUMENT); registry.register_lint(&INVALID_SUPER_ARGUMENT);
registry.register_lint(&INVALID_TYPE_CHECKING_CONSTANT); registry.register_lint(&INVALID_TYPE_CHECKING_CONSTANT);
@ -230,6 +231,34 @@ declare_lint! {
} }
} }
declare_lint! {
/// ## What it does
/// Checks for invalidly defined protocol classes.
///
/// ## Why is this bad?
/// An invalidly defined protocol class may lead to the type checker inferring
/// unexpected things. It may also lead to `TypeError`s at runtime.
///
/// ## Examples
/// A `Protocol` class cannot inherit from a non-`Protocol` class;
/// this raises a `TypeError` at runtime:
///
/// ```pycon
/// >>> from typing import Protocol
/// >>> class Foo(int, Protocol): ...
/// ...
/// Traceback (most recent call last):
/// File "<python-input-1>", line 1, in <module>
/// class Foo(int, Protocol): ...
/// TypeError: Protocols can only inherit from other protocols, got <class 'int'>
/// ```
pub(crate) static INVALID_PROTOCOL = {
summary: "detects invalid protocol class definitions",
status: LintStatus::preview("1.0.0"),
default_level: Level::Error,
}
}
declare_lint! { declare_lint! {
/// TODO #14889 /// TODO #14889
pub(crate) static INCONSISTENT_MRO = { pub(crate) static INCONSISTENT_MRO = {

View file

@ -99,8 +99,8 @@ use super::diagnostic::{
report_index_out_of_bounds, report_invalid_exception_caught, report_invalid_exception_cause, report_index_out_of_bounds, report_invalid_exception_caught, report_invalid_exception_cause,
report_invalid_exception_raised, report_invalid_type_checking_constant, report_invalid_exception_raised, report_invalid_type_checking_constant,
report_non_subscriptable, report_possibly_unresolved_reference, report_slice_step_size_zero, report_non_subscriptable, report_possibly_unresolved_reference, report_slice_step_size_zero,
report_unresolved_reference, INVALID_METACLASS, REDUNDANT_CAST, STATIC_ASSERT_ERROR, report_unresolved_reference, INVALID_METACLASS, INVALID_PROTOCOL, REDUNDANT_CAST,
SUBCLASS_OF_FINAL_CLASS, TYPE_ASSERTION_FAILURE, STATIC_ASSERT_ERROR, SUBCLASS_OF_FINAL_CLASS, TYPE_ASSERTION_FAILURE,
}; };
use super::slots::check_class_slots; use super::slots::check_class_slots;
use super::string_annotation::{ use super::string_annotation::{
@ -763,17 +763,21 @@ impl<'db> TypeInferenceBuilder<'db> {
continue; continue;
} }
// (2) Check for inheritance from plain `Generic`, let is_protocol = class.is_protocol(self.db());
// and from classes that inherit from `@final` classes
// (2) Iterate through the class's explicit bases to check for various possible errors:
// - Check for inheritance from plain `Generic`,
// - Check for inheritance from a `@final` classes
// - If the class is a protocol class: check for inheritance from a non-protocol class
for (i, base_class) in class.explicit_bases(self.db()).iter().enumerate() { for (i, base_class) in class.explicit_bases(self.db()).iter().enumerate() {
let base_class = match base_class { let base_class = match base_class {
Type::KnownInstance(KnownInstanceType::Generic) => { Type::KnownInstance(KnownInstanceType::Generic) => {
// `Generic` can appear in the MRO of many classes, // Unsubscripted `Generic` can appear in the MRO of many classes,
// but it is never valid as an explicit base class in user code. // but it is never valid as an explicit base class in user code.
self.context.report_lint_old( self.context.report_lint_old(
&INVALID_BASE, &INVALID_BASE,
&class_node.bases()[i], &class_node.bases()[i],
format_args!("Cannot inherit from plain `Generic`",), format_args!("Cannot inherit from plain `Generic`"),
); );
continue; continue;
} }
@ -782,9 +786,22 @@ impl<'db> TypeInferenceBuilder<'db> {
_ => continue, _ => continue,
}; };
if !base_class.is_final(self.db()) { if is_protocol
continue; && !(base_class.is_protocol(self.db())
|| base_class.is_known(self.db(), KnownClass::Object))
{
self.context.report_lint_old(
&INVALID_PROTOCOL,
&class_node.bases()[i],
format_args!(
"Protocol class `{}` cannot inherit from non-protocol class `{}`",
class.name(self.db()),
base_class.name(self.db()),
),
);
} }
if base_class.is_final(self.db()) {
self.context.report_lint_old( self.context.report_lint_old(
&SUBCLASS_OF_FINAL_CLASS, &SUBCLASS_OF_FINAL_CLASS,
&class_node.bases()[i], &class_node.bases()[i],
@ -795,6 +812,7 @@ impl<'db> TypeInferenceBuilder<'db> {
), ),
); );
} }
}
// (3) Check that the class's MRO is resolvable // (3) Check that the class's MRO is resolvable
match class.try_mro(self.db(), None).as_ref() { match class.try_mro(self.db(), None).as_ref() {

View file

@ -460,6 +460,16 @@
} }
] ]
}, },
"invalid-protocol": {
"title": "detects invalid protocol class definitions",
"description": "## What it does\nChecks for invalidly defined protocol classes.\n\n## Why is this bad?\nAn invalidly defined protocol class may lead to the type checker inferring\nunexpected things. It may also lead to `TypeError`s at runtime.\n\n## Examples\nA `Protocol` class cannot inherit from a non-`Protocol` class;\nthis raises a `TypeError` at runtime:\n\n```pycon\n>>> from typing import Protocol\n>>> class Foo(int, Protocol): ...\n...\nTraceback (most recent call last):\n File \"<python-input-1>\", line 1, in <module>\n class Foo(int, Protocol): ...\nTypeError: Protocols can only inherit from other protocols, got <class 'int'>\n```",
"default": "error",
"oneOf": [
{
"$ref": "#/definitions/Level"
}
]
},
"invalid-raise": { "invalid-raise": {
"title": "detects `raise` statements that raise invalid exceptions or use invalid causes", "title": "detects `raise` statements that raise invalid exceptions or use invalid causes",
"description": "Checks for `raise` statements that raise non-exceptions or use invalid\ncauses for their raised exceptions.\n\n## Why is this bad?\nOnly subclasses or instances of `BaseException` can be raised.\nFor an exception's cause, the same rules apply, except that `None` is also\npermitted. Violating these rules results in a `TypeError` at runtime.\n\n## Examples\n```python\ndef f():\n try:\n something()\n except NameError:\n raise \"oops!\" from f\n\ndef g():\n raise NotImplemented from 42\n```\n\nUse instead:\n```python\ndef f():\n try:\n something()\n except NameError as e:\n raise RuntimeError(\"oops!\") from e\n\ndef g():\n raise NotImplementedError from None\n```\n\n## References\n- [Python documentation: The `raise` statement](https://docs.python.org/3/reference/simple_stmts.html#raise)\n- [Python documentation: Built-in Exceptions](https://docs.python.org/3/library/exceptions.html#built-in-exceptions)", "description": "Checks for `raise` statements that raise non-exceptions or use invalid\ncauses for their raised exceptions.\n\n## Why is this bad?\nOnly subclasses or instances of `BaseException` can be raised.\nFor an exception's cause, the same rules apply, except that `None` is also\npermitted. Violating these rules results in a `TypeError` at runtime.\n\n## Examples\n```python\ndef f():\n try:\n something()\n except NameError:\n raise \"oops!\" from f\n\ndef g():\n raise NotImplemented from 42\n```\n\nUse instead:\n```python\ndef f():\n try:\n something()\n except NameError as e:\n raise RuntimeError(\"oops!\") from e\n\ndef g():\n raise NotImplementedError from None\n```\n\n## References\n- [Python documentation: The `raise` statement](https://docs.python.org/3/reference/simple_stmts.html#raise)\n- [Python documentation: Built-in Exceptions](https://docs.python.org/3/library/exceptions.html#built-in-exceptions)",