-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[pylint
] Implement singledispatch-method
(E1519
)
#10140
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
from functools import singledispatch, singledispatchmethod | ||
|
||
|
||
@singledispatch | ||
def convert_position(position): | ||
pass | ||
|
||
class Board: | ||
@singledispatch # [singledispatch-method] | ||
@classmethod | ||
def convert_position(cls, position): | ||
pass | ||
|
||
@singledispatch # [singledispatch-method] | ||
def move(self, position): | ||
pass | ||
|
||
@singledispatchmethod | ||
def place(self, position): | ||
pass |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
use ruff_diagnostics::{Diagnostic, FixAvailability, Violation}; | ||
use ruff_macros::{derive_message_formats, violation}; | ||
use ruff_python_ast::{self as ast}; | ||
use ruff_python_semantic::{analyze::function_type, Scope}; | ||
use ruff_text_size::Ranged; | ||
|
||
use crate::checkers::ast::Checker; | ||
|
||
/// ## What it does | ||
/// Checks for singledispatch decorators on class methods. | ||
/// | ||
/// ## Why is this bad? | ||
/// Single dispatch must happen on the type of first non self argument | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Example code is helpful here. Take a look at other rules to see the format. The pylint docs contains examples to use. You can also link the Python documentation of singledispatchmethod |
||
#[violation] | ||
pub struct SingleDispatchMethod; | ||
|
||
impl Violation for SingleDispatchMethod { | ||
const FIX_AVAILABILITY: FixAvailability = FixAvailability::None; | ||
|
||
#[derive_message_formats] | ||
fn message(&self) -> String { | ||
format!("singledispatch decorator should not be used with methods, use singledispatchmethod instead.") | ||
} | ||
} | ||
|
||
/// E1519 | ||
pub(crate) fn single_dispatch_method( | ||
checker: &Checker, | ||
scope: &Scope, | ||
diagnostics: &mut Vec<Diagnostic>, | ||
) { | ||
let Some(func) = scope.kind.as_function() else { | ||
return; | ||
}; | ||
|
||
let ast::StmtFunctionDef { | ||
name, | ||
decorator_list, | ||
.. | ||
} = func; | ||
|
||
let Some(parent) = &checker.semantic().first_non_type_parent_scope(scope) else { | ||
return; | ||
}; | ||
|
||
if !matches!( | ||
function_type::classify( | ||
name, | ||
decorator_list, | ||
parent, | ||
checker.semantic(), | ||
&checker.settings.pep8_naming.classmethod_decorators, | ||
&checker.settings.pep8_naming.staticmethod_decorators, | ||
), | ||
function_type::FunctionType::Method | function_type::FunctionType::ClassMethod | ||
) { | ||
return; | ||
} | ||
|
||
for decorator in decorator_list { | ||
if checker | ||
.semantic() | ||
.resolve_call_path(&decorator.expression) | ||
.is_some_and(|call_path| { | ||
matches!(call_path.as_slice(), ["functools", "singledispatch"]) | ||
}) | ||
{ | ||
diagnostics.push(Diagnostic::new(SingleDispatchMethod {}, decorator.range())); | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
source: crates/ruff_linter/src/rules/pylint/mod.rs | ||
--- | ||
E1519.py:9:5: PLE1519 singledispatch decorator should not be used with methods, use singledispatchmethod instead. | ||
| | ||
8 | class Board: | ||
9 | @singledispatch # [singledispatch-method] | ||
| ^^^^^^^^^^^^^^^ PLE1519 | ||
10 | @classmethod | ||
11 | def convert_position(cls, position): | ||
| | ||
|
||
E1519.py:14:5: PLE1519 singledispatch decorator should not be used with methods, use singledispatchmethod instead. | ||
| | ||
12 | pass | ||
13 | | ||
14 | @singledispatch # [singledispatch-method] | ||
| ^^^^^^^^^^^^^^^ PLE1519 | ||
15 | def move(self, position): | ||
16 | pass | ||
| |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it possible to catch @funcname.register as the pylint rule does?
Even if not, it would be good to include those examples in the tests in case we can do it in the future.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably a bit harder (but possible) to catch
@funcname.register
, but agree we should add tests for it with commentary.