Python
/
ruff
mirror of https://github.com/astral-sh/ruff
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Ignore self and cls when counting arguments (#12367) 

## Summary

Closes https://github.com/astral-sh/ruff/issues/12320.
This commit is contained in:
Charlie Marsh 2024-07-17 10:49:38 -04:00 committed by GitHub
parent 79b535587b
commit 80f0116641
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 125 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
crates/ruff_linter/resources/test/fixtures/pylint/too_many_arguments.py vendored
View File

@ -45,3 +45,32 @@ def f(x, y, z, a, b, c, *, u, v, w): # OK
@overload
def f(x, y, z, a, b, c, *, u, v, w): # OK
pass
class C:
def f(self, y, z, a, b, c, *, u, v, w): # Too many arguments (8/5)
pass
def f(self, y, z, a, b, c): # OK
pass
@classmethod
def f(cls, y, z, a, b, c, *, u, v, w): # Too many arguments (8/5)
pass
@classmethod
def f(cls, y, z, a, b, c): # OK
pass
@staticmethod
def f(y, z, a, b, c, *, u, v, w): # Too many arguments (8/5)
pass
@staticmethod
def f(y, z, a, b, c, d): # OK
pass
@staticmethod
def f(y, z, a, b, c): # OK
pass

61
crates/ruff_linter/src/rules/pylint/rules/too_many_arguments.rs
View File

@ -2,7 +2,7 @@ use ruff_diagnostics::{Diagnostic, Violation};
use ruff_macros::{derive_message_formats, violation};
use ruff_python_ast as ast;
use ruff_python_ast::identifier::Identifier;
use ruff_python_semantic::analyze::visibility;
use ruff_python_semantic::analyze::{function_type, visibility};
use crate::checkers::ast::Checker;
@ -59,6 +59,8 @@ impl Violation for TooManyArguments {
/// PLR0913
pub(crate) fn too_many_arguments(checker: &mut Checker, function_def: &ast::StmtFunctionDef) {
let semantic = checker.semantic();
let num_arguments = function_def
.parameters
.iter_non_variadic_params()
@ -70,21 +72,46 @@ pub(crate) fn too_many_arguments(checker: &mut Checker, function_def: &ast::Stmt
})
.count();
if num_arguments > checker.settings.pylint.max_args {
// Allow excessive arguments in `@override` or `@overload` methods, since they're required
// to adhere to the parent signature.
if visibility::is_override(&function_def.decorator_list, checker.semantic())
|| visibility::is_overload(&function_def.decorator_list, checker.semantic())
{
return;
}
checker.diagnostics.push(Diagnostic::new(
TooManyArguments {
c_args: num_arguments,
max_args: checker.settings.pylint.max_args,
},
function_def.identifier(),
));
if num_arguments <= checker.settings.pylint.max_args {
return;
}
// Allow excessive arguments in `@override` or `@overload` methods, since they're required
// to adhere to the parent signature.
if visibility::is_override(&function_def.decorator_list, checker.semantic())
|| visibility::is_overload(&function_def.decorator_list, checker.semantic())
{
return;
}
// Check if the function is a method or class method.
let num_arguments = if matches!(
function_type::classify(
&function_def.name,
&function_def.decorator_list,
semantic.current_scope(),
semantic,
&checker.settings.pep8_naming.classmethod_decorators,
&checker.settings.pep8_naming.staticmethod_decorators,
),
function_type::FunctionType::Method | function_type::FunctionType::ClassMethod
) {
// If so, we need to subtract one from the number of positional arguments, since the first
// argument is always `self` or `cls`.
num_arguments.saturating_sub(1)
} else {
num_arguments
};
if num_arguments <= checker.settings.pylint.max_args {
return;
}
checker.diagnostics.push(Diagnostic::new(
TooManyArguments {
c_args: num_arguments,
max_args: checker.settings.pylint.max_args,
},
function_def.identifier(),
));
}

38
crates/ruff_linter/src/rules/pylint/rules/too_many_positional.rs
View File

@ -73,6 +73,18 @@ pub(crate) fn too_many_positional(checker: &mut Checker, function_def: &ast::Stm
})
.count();
if num_positional_args <= checker.settings.pylint.max_positional_args {
return;
}
// Allow excessive arguments in `@override` or `@overload` methods, since they're required
// to adhere to the parent signature.
if visibility::is_override(&function_def.decorator_list, semantic)
|| visibility::is_overload(&function_def.decorator_list, semantic)
{
return;
}
// Check if the function is a method or class method.
let num_positional_args = if matches!(
function_type::classify(
@ -92,21 +104,15 @@ pub(crate) fn too_many_positional(checker: &mut Checker, function_def: &ast::Stm
num_positional_args
};
if num_positional_args > checker.settings.pylint.max_positional_args {
// Allow excessive arguments in `@override` or `@overload` methods, since they're required
// to adhere to the parent signature.
if visibility::is_override(&function_def.decorator_list, semantic)
|| visibility::is_overload(&function_def.decorator_list, semantic)
{
return;
}
checker.diagnostics.push(Diagnostic::new(
TooManyPositional {
c_pos: num_positional_args,
max_pos: checker.settings.pylint.max_positional_args,
},
function_def.identifier(),
));
if num_positional_args <= checker.settings.pylint.max_positional_args {
return;
}
checker.diagnostics.push(Diagnostic::new(
TooManyPositional {
c_pos: num_positional_args,
max_pos: checker.settings.pylint.max_positional_args,
},
function_def.identifier(),
));
}

30
crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLR0913_too_many_arguments.py.snap
View File

@ -36,4 +36,34 @@ too_many_arguments.py:33:5: PLR0913 Too many arguments in function definition (9
34 | pass
|
too_many_arguments.py:51:9: PLR0913 Too many arguments in function definition (8 > 5)
|
50 | class C:
51 | def f(self, y, z, a, b, c, *, u, v, w): # Too many arguments (8/5)
| ^ PLR0913
52 | pass
|
too_many_arguments.py:58:9: PLR0913 Too many arguments in function definition (8 > 5)
|
57 | @classmethod
58 | def f(cls, y, z, a, b, c, *, u, v, w): # Too many arguments (8/5)
| ^ PLR0913
59 | pass
|
too_many_arguments.py:66:9: PLR0913 Too many arguments in function definition (8 > 5)
|
65 | @staticmethod
66 | def f(y, z, a, b, c, *, u, v, w): # Too many arguments (8/5)
| ^ PLR0913
67 | pass
|
too_many_arguments.py:70:9: PLR0913 Too many arguments in function definition (6 > 5)
|
69 | @staticmethod
70 | def f(y, z, a, b, c, d): # OK
| ^ PLR0913
71 | pass
|