mirror of
https://github.com/astral-sh/ruff.git
synced 2025-10-01 06:11:43 +00:00
Use more precise ranges for function and class checks (#1247)
This commit is contained in:
parent
ba85eb846c
commit
6be910ae07
11 changed files with 337 additions and 206 deletions
|
@ -1,9 +1,12 @@
|
|||
use log::error;
|
||||
use once_cell::sync::Lazy;
|
||||
use regex::Regex;
|
||||
use rustc_hash::{FxHashMap, FxHashSet};
|
||||
use rustpython_ast::{
|
||||
Arguments, Excepthandler, ExcepthandlerKind, Expr, ExprKind, Location, Stmt, StmtKind,
|
||||
};
|
||||
use rustpython_parser::lexer;
|
||||
use rustpython_parser::lexer::Tok;
|
||||
|
||||
use crate::ast::types::Range;
|
||||
use crate::SourceCodeLocator;
|
||||
|
@ -311,13 +314,42 @@ pub fn count_trailing_lines(stmt: &Stmt, locator: &SourceCodeLocator) -> usize {
|
|||
.count()
|
||||
}
|
||||
|
||||
/// Return the appropriate visual `Range` for any message that spans a `Stmt`.
|
||||
/// Specifically, this method returns the range of a function or class name,
|
||||
/// rather than that of the entire function or class body.
|
||||
pub fn identifier_range(stmt: &Stmt, locator: &SourceCodeLocator) -> Range {
|
||||
if matches!(
|
||||
stmt.node,
|
||||
StmtKind::ClassDef { .. }
|
||||
| StmtKind::FunctionDef { .. }
|
||||
| StmtKind::AsyncFunctionDef { .. }
|
||||
) {
|
||||
let contents = locator.slice_source_code_range(&Range::from_located(stmt));
|
||||
for (start, tok, end) in lexer::make_tokenizer(&contents).flatten() {
|
||||
if matches!(tok, Tok::Name { .. }) {
|
||||
let start = to_absolute(start, stmt.location);
|
||||
let end = to_absolute(end, stmt.location);
|
||||
return Range {
|
||||
location: start,
|
||||
end_location: end,
|
||||
};
|
||||
}
|
||||
}
|
||||
error!("Failed to find identifier for {:?}", stmt);
|
||||
}
|
||||
Range::from_located(stmt)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use anyhow::Result;
|
||||
use rustc_hash::{FxHashMap, FxHashSet};
|
||||
use rustpython_ast::Location;
|
||||
use rustpython_parser::parser;
|
||||
|
||||
use crate::ast::helpers::match_module_member;
|
||||
use crate::ast::helpers::{identifier_range, match_module_member};
|
||||
use crate::ast::types::Range;
|
||||
use crate::source_code_locator::SourceCodeLocator;
|
||||
|
||||
#[test]
|
||||
fn builtin() -> Result<()> {
|
||||
|
@ -461,4 +493,91 @@ mod tests {
|
|||
));
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn extract_identifier_range() -> Result<()> {
|
||||
let contents = "def f(): pass".trim();
|
||||
let program = parser::parse_program(contents, "<filename>")?;
|
||||
let stmt = program.first().unwrap();
|
||||
let locator = SourceCodeLocator::new(contents);
|
||||
assert_eq!(
|
||||
identifier_range(stmt, &locator),
|
||||
Range {
|
||||
location: Location::new(1, 4),
|
||||
end_location: Location::new(1, 5),
|
||||
}
|
||||
);
|
||||
|
||||
let contents = r#"
|
||||
def \
|
||||
f():
|
||||
pass
|
||||
"#
|
||||
.trim();
|
||||
let program = parser::parse_program(contents, "<filename>")?;
|
||||
let stmt = program.first().unwrap();
|
||||
let locator = SourceCodeLocator::new(contents);
|
||||
assert_eq!(
|
||||
identifier_range(stmt, &locator),
|
||||
Range {
|
||||
location: Location::new(2, 2),
|
||||
end_location: Location::new(2, 3),
|
||||
}
|
||||
);
|
||||
|
||||
let contents = "class Class(): pass".trim();
|
||||
let program = parser::parse_program(contents, "<filename>")?;
|
||||
let stmt = program.first().unwrap();
|
||||
let locator = SourceCodeLocator::new(contents);
|
||||
assert_eq!(
|
||||
identifier_range(stmt, &locator),
|
||||
Range {
|
||||
location: Location::new(1, 6),
|
||||
end_location: Location::new(1, 11),
|
||||
}
|
||||
);
|
||||
|
||||
let contents = "class Class: pass".trim();
|
||||
let program = parser::parse_program(contents, "<filename>")?;
|
||||
let stmt = program.first().unwrap();
|
||||
let locator = SourceCodeLocator::new(contents);
|
||||
assert_eq!(
|
||||
identifier_range(stmt, &locator),
|
||||
Range {
|
||||
location: Location::new(1, 6),
|
||||
end_location: Location::new(1, 11),
|
||||
}
|
||||
);
|
||||
|
||||
let contents = r#"
|
||||
@decorator()
|
||||
class Class():
|
||||
pass
|
||||
"#
|
||||
.trim();
|
||||
let program = parser::parse_program(contents, "<filename>")?;
|
||||
let stmt = program.first().unwrap();
|
||||
let locator = SourceCodeLocator::new(contents);
|
||||
assert_eq!(
|
||||
identifier_range(stmt, &locator),
|
||||
Range {
|
||||
location: Location::new(2, 6),
|
||||
end_location: Location::new(2, 11),
|
||||
}
|
||||
);
|
||||
|
||||
let contents = r#"x = y + 1"#.trim();
|
||||
let program = parser::parse_program(contents, "<filename>")?;
|
||||
let stmt = program.first().unwrap();
|
||||
let locator = SourceCodeLocator::new(contents);
|
||||
assert_eq!(
|
||||
identifier_range(stmt, &locator),
|
||||
Range {
|
||||
location: Location::new(1, 0),
|
||||
end_location: Location::new(1, 9),
|
||||
}
|
||||
);
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
|
106
src/check_ast.rs
106
src/check_ast.rs
|
@ -6,7 +6,7 @@ use itertools::Itertools;
|
|||
use log::error;
|
||||
use nohash_hasher::IntMap;
|
||||
use rustc_hash::{FxHashMap, FxHashSet};
|
||||
use rustpython_ast::Location;
|
||||
use rustpython_ast::{Located, Location};
|
||||
use rustpython_parser::ast::{
|
||||
Arg, Arguments, Constant, Excepthandler, ExcepthandlerKind, Expr, ExprContext, ExprKind,
|
||||
KeywordData, Operator, Stmt, StmtKind, Suite,
|
||||
|
@ -257,12 +257,11 @@ where
|
|||
}
|
||||
|
||||
if self.settings.enabled.contains(&CheckCode::E741) {
|
||||
let location = Range::from_located(stmt);
|
||||
self.add_checks(
|
||||
names
|
||||
.iter()
|
||||
.filter_map(|name| {
|
||||
pycodestyle::checks::ambiguous_variable_name(name, location)
|
||||
pycodestyle::checks::ambiguous_variable_name(name, stmt)
|
||||
})
|
||||
.into_iter(),
|
||||
);
|
||||
|
@ -309,12 +308,11 @@ where
|
|||
}
|
||||
|
||||
if self.settings.enabled.contains(&CheckCode::E741) {
|
||||
let location = Range::from_located(stmt);
|
||||
self.add_checks(
|
||||
names
|
||||
.iter()
|
||||
.filter_map(|name| {
|
||||
pycodestyle::checks::ambiguous_variable_name(name, location)
|
||||
pycodestyle::checks::ambiguous_variable_name(name, stmt)
|
||||
})
|
||||
.into_iter(),
|
||||
);
|
||||
|
@ -369,7 +367,8 @@ where
|
|||
if let Some(check) = pep8_naming::checks::invalid_function_name(
|
||||
stmt,
|
||||
name,
|
||||
&self.settings.pep8_naming,
|
||||
&self.settings.pep8_naming.ignore_names,
|
||||
self.locator,
|
||||
) {
|
||||
self.add_check(check);
|
||||
}
|
||||
|
@ -406,9 +405,12 @@ where
|
|||
}
|
||||
|
||||
if self.settings.enabled.contains(&CheckCode::N807) {
|
||||
if let Some(check) =
|
||||
pep8_naming::checks::dunder_function_name(self.current_scope(), stmt, name)
|
||||
{
|
||||
if let Some(check) = pep8_naming::checks::dunder_function_name(
|
||||
self.current_scope(),
|
||||
stmt,
|
||||
name,
|
||||
self.locator,
|
||||
) {
|
||||
self.add_check(check);
|
||||
}
|
||||
}
|
||||
|
@ -445,6 +447,7 @@ where
|
|||
name,
|
||||
body,
|
||||
self.settings.mccabe.max_complexity,
|
||||
self.locator,
|
||||
) {
|
||||
self.add_check(check);
|
||||
}
|
||||
|
@ -460,7 +463,7 @@ where
|
|||
pylint::plugins::property_with_parameters(self, stmt, decorator_list, args);
|
||||
}
|
||||
|
||||
self.check_builtin_shadowing(name, Range::from_located(stmt), true);
|
||||
self.check_builtin_shadowing(name, stmt, true);
|
||||
|
||||
// Visit the decorators and arguments, but avoid the body, which will be
|
||||
// deferred.
|
||||
|
@ -548,7 +551,9 @@ where
|
|||
}
|
||||
|
||||
if self.settings.enabled.contains(&CheckCode::N801) {
|
||||
if let Some(check) = pep8_naming::checks::invalid_class_name(stmt, name) {
|
||||
if let Some(check) =
|
||||
pep8_naming::checks::invalid_class_name(stmt, name, self.locator)
|
||||
{
|
||||
self.add_check(check);
|
||||
}
|
||||
}
|
||||
|
@ -573,7 +578,7 @@ where
|
|||
);
|
||||
}
|
||||
|
||||
self.check_builtin_shadowing(name, Range::from_located(stmt), false);
|
||||
self.check_builtin_shadowing(name, stmt, false);
|
||||
|
||||
for expr in bases {
|
||||
self.visit_expr(expr);
|
||||
|
@ -615,7 +620,7 @@ where
|
|||
);
|
||||
} else {
|
||||
if let Some(asname) = &alias.node.asname {
|
||||
self.check_builtin_shadowing(asname, Range::from_located(stmt), false);
|
||||
self.check_builtin_shadowing(asname, stmt, false);
|
||||
}
|
||||
|
||||
// Given `import foo`, `name` and `full_name` would both be `foo`.
|
||||
|
@ -683,7 +688,10 @@ where
|
|||
if self.settings.enabled.contains(&CheckCode::N811) {
|
||||
if let Some(check) =
|
||||
pep8_naming::checks::constant_imported_as_non_constant(
|
||||
stmt, name, asname,
|
||||
stmt,
|
||||
name,
|
||||
asname,
|
||||
self.locator,
|
||||
)
|
||||
{
|
||||
self.add_check(check);
|
||||
|
@ -693,7 +701,10 @@ where
|
|||
if self.settings.enabled.contains(&CheckCode::N812) {
|
||||
if let Some(check) =
|
||||
pep8_naming::checks::lowercase_imported_as_non_lowercase(
|
||||
stmt, name, asname,
|
||||
stmt,
|
||||
name,
|
||||
asname,
|
||||
self.locator,
|
||||
)
|
||||
{
|
||||
self.add_check(check);
|
||||
|
@ -703,7 +714,10 @@ where
|
|||
if self.settings.enabled.contains(&CheckCode::N813) {
|
||||
if let Some(check) =
|
||||
pep8_naming::checks::camelcase_imported_as_lowercase(
|
||||
stmt, name, asname,
|
||||
stmt,
|
||||
name,
|
||||
asname,
|
||||
self.locator,
|
||||
)
|
||||
{
|
||||
self.add_check(check);
|
||||
|
@ -712,7 +726,10 @@ where
|
|||
|
||||
if self.settings.enabled.contains(&CheckCode::N814) {
|
||||
if let Some(check) = pep8_naming::checks::camelcase_imported_as_constant(
|
||||
stmt, name, asname,
|
||||
stmt,
|
||||
name,
|
||||
asname,
|
||||
self.locator,
|
||||
) {
|
||||
self.add_check(check);
|
||||
}
|
||||
|
@ -720,7 +737,10 @@ where
|
|||
|
||||
if self.settings.enabled.contains(&CheckCode::N817) {
|
||||
if let Some(check) = pep8_naming::checks::camelcase_imported_as_acronym(
|
||||
stmt, name, asname,
|
||||
stmt,
|
||||
name,
|
||||
asname,
|
||||
self.locator,
|
||||
) {
|
||||
self.add_check(check);
|
||||
}
|
||||
|
@ -858,7 +878,7 @@ where
|
|||
scope.import_starred = true;
|
||||
} else {
|
||||
if let Some(asname) = &alias.node.asname {
|
||||
self.check_builtin_shadowing(asname, Range::from_located(stmt), false);
|
||||
self.check_builtin_shadowing(asname, stmt, false);
|
||||
}
|
||||
|
||||
// Given `from foo import bar`, `name` would be "bar" and `full_name` would
|
||||
|
@ -927,6 +947,7 @@ where
|
|||
stmt,
|
||||
&alias.node.name,
|
||||
asname,
|
||||
self.locator,
|
||||
)
|
||||
{
|
||||
self.add_check(check);
|
||||
|
@ -939,6 +960,7 @@ where
|
|||
stmt,
|
||||
&alias.node.name,
|
||||
asname,
|
||||
self.locator,
|
||||
)
|
||||
{
|
||||
self.add_check(check);
|
||||
|
@ -951,6 +973,7 @@ where
|
|||
stmt,
|
||||
&alias.node.name,
|
||||
asname,
|
||||
self.locator,
|
||||
)
|
||||
{
|
||||
self.add_check(check);
|
||||
|
@ -962,6 +985,7 @@ where
|
|||
stmt,
|
||||
&alias.node.name,
|
||||
asname,
|
||||
self.locator,
|
||||
) {
|
||||
self.add_check(check);
|
||||
}
|
||||
|
@ -972,6 +996,7 @@ where
|
|||
stmt,
|
||||
&alias.node.name,
|
||||
asname,
|
||||
self.locator,
|
||||
) {
|
||||
self.add_check(check);
|
||||
}
|
||||
|
@ -1422,15 +1447,14 @@ where
|
|||
}
|
||||
ExprContext::Store => {
|
||||
if self.settings.enabled.contains(&CheckCode::E741) {
|
||||
if let Some(check) = pycodestyle::checks::ambiguous_variable_name(
|
||||
id,
|
||||
Range::from_located(expr),
|
||||
) {
|
||||
if let Some(check) =
|
||||
pycodestyle::checks::ambiguous_variable_name(id, expr)
|
||||
{
|
||||
self.add_check(check);
|
||||
}
|
||||
}
|
||||
|
||||
self.check_builtin_shadowing(id, Range::from_located(expr), true);
|
||||
self.check_builtin_shadowing(id, expr, true);
|
||||
|
||||
self.handle_node_store(id, expr);
|
||||
}
|
||||
|
@ -2413,19 +2437,14 @@ where
|
|||
match name {
|
||||
Some(name) => {
|
||||
if self.settings.enabled.contains(&CheckCode::E741) {
|
||||
if let Some(check) = pycodestyle::checks::ambiguous_variable_name(
|
||||
name,
|
||||
Range::from_located(excepthandler),
|
||||
) {
|
||||
if let Some(check) =
|
||||
pycodestyle::checks::ambiguous_variable_name(name, excepthandler)
|
||||
{
|
||||
self.add_check(check);
|
||||
}
|
||||
}
|
||||
|
||||
self.check_builtin_shadowing(
|
||||
name,
|
||||
Range::from_located(excepthandler),
|
||||
false,
|
||||
);
|
||||
self.check_builtin_shadowing(name, excepthandler, false);
|
||||
|
||||
if self.current_scope().values.contains_key(&name.as_str()) {
|
||||
self.handle_node_store(
|
||||
|
@ -2538,23 +2557,18 @@ where
|
|||
);
|
||||
|
||||
if self.settings.enabled.contains(&CheckCode::E741) {
|
||||
if let Some(check) = pycodestyle::checks::ambiguous_variable_name(
|
||||
&arg.node.arg,
|
||||
Range::from_located(arg),
|
||||
) {
|
||||
if let Some(check) = pycodestyle::checks::ambiguous_variable_name(&arg.node.arg, arg) {
|
||||
self.add_check(check);
|
||||
}
|
||||
}
|
||||
|
||||
if self.settings.enabled.contains(&CheckCode::N803) {
|
||||
if let Some(check) =
|
||||
pep8_naming::checks::invalid_argument_name(&arg.node.arg, Range::from_located(arg))
|
||||
{
|
||||
if let Some(check) = pep8_naming::checks::invalid_argument_name(&arg.node.arg, arg) {
|
||||
self.add_check(check);
|
||||
}
|
||||
}
|
||||
|
||||
self.check_builtin_arg_shadowing(&arg.node.arg, Range::from_located(arg));
|
||||
self.check_builtin_arg_shadowing(&arg.node.arg, arg);
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -3584,12 +3598,12 @@ impl<'a> Checker<'a> {
|
|||
}
|
||||
}
|
||||
|
||||
fn check_builtin_shadowing(&mut self, name: &str, location: Range, is_attribute: bool) {
|
||||
fn check_builtin_shadowing<T>(&mut self, name: &str, located: &Located<T>, is_attribute: bool) {
|
||||
if is_attribute && matches!(self.current_scope().kind, ScopeKind::Class(_)) {
|
||||
if self.settings.enabled.contains(&CheckCode::A003) {
|
||||
if let Some(check) = flake8_builtins::checks::builtin_shadowing(
|
||||
name,
|
||||
location,
|
||||
located,
|
||||
flake8_builtins::types::ShadowingType::Attribute,
|
||||
) {
|
||||
self.add_check(check);
|
||||
|
@ -3599,7 +3613,7 @@ impl<'a> Checker<'a> {
|
|||
if self.settings.enabled.contains(&CheckCode::A001) {
|
||||
if let Some(check) = flake8_builtins::checks::builtin_shadowing(
|
||||
name,
|
||||
location,
|
||||
located,
|
||||
flake8_builtins::types::ShadowingType::Variable,
|
||||
) {
|
||||
self.add_check(check);
|
||||
|
@ -3608,11 +3622,11 @@ impl<'a> Checker<'a> {
|
|||
}
|
||||
}
|
||||
|
||||
fn check_builtin_arg_shadowing(&mut self, name: &str, location: Range) {
|
||||
fn check_builtin_arg_shadowing(&mut self, name: &str, arg: &Arg) {
|
||||
if self.settings.enabled.contains(&CheckCode::A002) {
|
||||
if let Some(check) = flake8_builtins::checks::builtin_shadowing(
|
||||
name,
|
||||
location,
|
||||
arg,
|
||||
flake8_builtins::types::ShadowingType::Argument,
|
||||
) {
|
||||
self.add_check(check);
|
||||
|
|
|
@ -1,10 +1,16 @@
|
|||
use rustpython_ast::{Located};
|
||||
|
||||
use crate::ast::types::Range;
|
||||
use crate::checks::{Check, CheckKind};
|
||||
use crate::flake8_builtins::types::ShadowingType;
|
||||
use crate::python::builtins::BUILTINS;
|
||||
|
||||
/// Check builtin name shadowing.
|
||||
pub fn builtin_shadowing(name: &str, location: Range, node_type: ShadowingType) -> Option<Check> {
|
||||
pub fn builtin_shadowing<T>(
|
||||
name: &str,
|
||||
located: &Located<T>,
|
||||
node_type: ShadowingType,
|
||||
) -> Option<Check> {
|
||||
if BUILTINS.contains(&name) {
|
||||
Some(Check::new(
|
||||
match node_type {
|
||||
|
@ -12,7 +18,7 @@ pub fn builtin_shadowing(name: &str, location: Range, node_type: ShadowingType)
|
|||
ShadowingType::Argument => CheckKind::BuiltinArgumentShadowing(name.to_string()),
|
||||
ShadowingType::Attribute => CheckKind::BuiltinAttributeShadowing(name.to_string()),
|
||||
},
|
||||
location,
|
||||
Range::from_located(located),
|
||||
))
|
||||
} else {
|
||||
None
|
||||
|
|
|
@ -1,7 +1,9 @@
|
|||
use rustpython_ast::{ExcepthandlerKind, ExprKind, Stmt, StmtKind};
|
||||
|
||||
use crate::ast::types::Range;
|
||||
use crate::ast::helpers::identifier_range;
|
||||
|
||||
use crate::checks::{Check, CheckKind};
|
||||
use crate::source_code_locator::SourceCodeLocator;
|
||||
|
||||
fn get_complexity_number(stmts: &[Stmt]) -> usize {
|
||||
let mut complexity = 0;
|
||||
|
@ -59,12 +61,13 @@ pub fn function_is_too_complex(
|
|||
name: &str,
|
||||
body: &[Stmt],
|
||||
max_complexity: usize,
|
||||
locator: &SourceCodeLocator,
|
||||
) -> Option<Check> {
|
||||
let complexity = get_complexity_number(body) + 1;
|
||||
if complexity > max_complexity {
|
||||
Some(Check::new(
|
||||
CheckKind::FunctionIsTooComplex(name.to_string(), complexity),
|
||||
Range::from_located(stmt),
|
||||
identifier_range(stmt, locator),
|
||||
))
|
||||
} else {
|
||||
None
|
||||
|
|
|
@ -8,10 +8,10 @@ expression: checks
|
|||
- 1
|
||||
location:
|
||||
row: 2
|
||||
column: 0
|
||||
column: 4
|
||||
end_location:
|
||||
row: 3
|
||||
column: 8
|
||||
row: 2
|
||||
column: 11
|
||||
fix: ~
|
||||
- kind:
|
||||
FunctionIsTooComplex:
|
||||
|
@ -19,10 +19,10 @@ expression: checks
|
|||
- 1
|
||||
location:
|
||||
row: 7
|
||||
column: 0
|
||||
column: 4
|
||||
end_location:
|
||||
row: 8
|
||||
column: 10
|
||||
row: 7
|
||||
column: 21
|
||||
fix: ~
|
||||
- kind:
|
||||
FunctionIsTooComplex:
|
||||
|
@ -30,10 +30,10 @@ expression: checks
|
|||
- 1
|
||||
location:
|
||||
row: 12
|
||||
column: 0
|
||||
column: 4
|
||||
end_location:
|
||||
row: 15
|
||||
column: 12
|
||||
row: 12
|
||||
column: 14
|
||||
fix: ~
|
||||
- kind:
|
||||
FunctionIsTooComplex:
|
||||
|
@ -41,10 +41,10 @@ expression: checks
|
|||
- 3
|
||||
location:
|
||||
row: 19
|
||||
column: 0
|
||||
column: 4
|
||||
end_location:
|
||||
row: 25
|
||||
column: 47
|
||||
row: 19
|
||||
column: 26
|
||||
fix: ~
|
||||
- kind:
|
||||
FunctionIsTooComplex:
|
||||
|
@ -52,10 +52,10 @@ expression: checks
|
|||
- 3
|
||||
location:
|
||||
row: 29
|
||||
column: 0
|
||||
column: 4
|
||||
end_location:
|
||||
row: 36
|
||||
column: 47
|
||||
row: 29
|
||||
column: 14
|
||||
fix: ~
|
||||
- kind:
|
||||
FunctionIsTooComplex:
|
||||
|
@ -63,10 +63,10 @@ expression: checks
|
|||
- 2
|
||||
location:
|
||||
row: 40
|
||||
column: 0
|
||||
column: 4
|
||||
end_location:
|
||||
row: 42
|
||||
column: 16
|
||||
row: 40
|
||||
column: 12
|
||||
fix: ~
|
||||
- kind:
|
||||
FunctionIsTooComplex:
|
||||
|
@ -74,10 +74,10 @@ expression: checks
|
|||
- 2
|
||||
location:
|
||||
row: 46
|
||||
column: 0
|
||||
column: 4
|
||||
end_location:
|
||||
row: 50
|
||||
column: 19
|
||||
row: 46
|
||||
column: 12
|
||||
fix: ~
|
||||
- kind:
|
||||
FunctionIsTooComplex:
|
||||
|
@ -85,10 +85,10 @@ expression: checks
|
|||
- 2
|
||||
location:
|
||||
row: 54
|
||||
column: 0
|
||||
column: 4
|
||||
end_location:
|
||||
row: 58
|
||||
column: 16
|
||||
row: 54
|
||||
column: 13
|
||||
fix: ~
|
||||
- kind:
|
||||
FunctionIsTooComplex:
|
||||
|
@ -96,10 +96,10 @@ expression: checks
|
|||
- 3
|
||||
location:
|
||||
row: 62
|
||||
column: 0
|
||||
column: 4
|
||||
end_location:
|
||||
row: 69
|
||||
column: 7
|
||||
row: 62
|
||||
column: 20
|
||||
fix: ~
|
||||
- kind:
|
||||
FunctionIsTooComplex:
|
||||
|
@ -107,10 +107,10 @@ expression: checks
|
|||
- 2
|
||||
location:
|
||||
row: 63
|
||||
column: 4
|
||||
column: 8
|
||||
end_location:
|
||||
row: 67
|
||||
column: 11
|
||||
row: 63
|
||||
column: 9
|
||||
fix: ~
|
||||
- kind:
|
||||
FunctionIsTooComplex:
|
||||
|
@ -118,10 +118,10 @@ expression: checks
|
|||
- 1
|
||||
location:
|
||||
row: 64
|
||||
column: 8
|
||||
column: 12
|
||||
end_location:
|
||||
row: 65
|
||||
column: 16
|
||||
row: 64
|
||||
column: 13
|
||||
fix: ~
|
||||
- kind:
|
||||
FunctionIsTooComplex:
|
||||
|
@ -129,10 +129,10 @@ expression: checks
|
|||
- 4
|
||||
location:
|
||||
row: 73
|
||||
column: 0
|
||||
column: 4
|
||||
end_location:
|
||||
row: 81
|
||||
column: 16
|
||||
row: 73
|
||||
column: 12
|
||||
fix: ~
|
||||
- kind:
|
||||
FunctionIsTooComplex:
|
||||
|
@ -140,10 +140,10 @@ expression: checks
|
|||
- 3
|
||||
location:
|
||||
row: 85
|
||||
column: 0
|
||||
column: 4
|
||||
end_location:
|
||||
row: 92
|
||||
column: 16
|
||||
row: 85
|
||||
column: 22
|
||||
fix: ~
|
||||
- kind:
|
||||
FunctionIsTooComplex:
|
||||
|
@ -151,10 +151,10 @@ expression: checks
|
|||
- 3
|
||||
location:
|
||||
row: 96
|
||||
column: 0
|
||||
column: 10
|
||||
end_location:
|
||||
row: 103
|
||||
column: 12
|
||||
row: 96
|
||||
column: 16
|
||||
fix: ~
|
||||
- kind:
|
||||
FunctionIsTooComplex:
|
||||
|
@ -162,10 +162,10 @@ expression: checks
|
|||
- 1
|
||||
location:
|
||||
row: 107
|
||||
column: 0
|
||||
column: 4
|
||||
end_location:
|
||||
row: 108
|
||||
column: 17
|
||||
row: 107
|
||||
column: 20
|
||||
fix: ~
|
||||
- kind:
|
||||
FunctionIsTooComplex:
|
||||
|
@ -173,10 +173,10 @@ expression: checks
|
|||
- 9
|
||||
location:
|
||||
row: 113
|
||||
column: 4
|
||||
column: 8
|
||||
end_location:
|
||||
row: 138
|
||||
column: 40
|
||||
row: 113
|
||||
column: 14
|
||||
fix: ~
|
||||
- kind:
|
||||
FunctionIsTooComplex:
|
||||
|
@ -184,10 +184,10 @@ expression: checks
|
|||
- 1
|
||||
location:
|
||||
row: 118
|
||||
column: 12
|
||||
column: 16
|
||||
end_location:
|
||||
row: 119
|
||||
column: 20
|
||||
row: 118
|
||||
column: 17
|
||||
fix: ~
|
||||
- kind:
|
||||
FunctionIsTooComplex:
|
||||
|
@ -195,10 +195,10 @@ expression: checks
|
|||
- 2
|
||||
location:
|
||||
row: 121
|
||||
column: 12
|
||||
column: 16
|
||||
end_location:
|
||||
row: 123
|
||||
column: 24
|
||||
row: 121
|
||||
column: 17
|
||||
fix: ~
|
||||
- kind:
|
||||
FunctionIsTooComplex:
|
||||
|
@ -206,10 +206,10 @@ expression: checks
|
|||
- 1
|
||||
location:
|
||||
row: 126
|
||||
column: 12
|
||||
column: 16
|
||||
end_location:
|
||||
row: 127
|
||||
column: 20
|
||||
row: 126
|
||||
column: 17
|
||||
fix: ~
|
||||
- kind:
|
||||
FunctionIsTooComplex:
|
||||
|
@ -217,10 +217,10 @@ expression: checks
|
|||
- 1
|
||||
location:
|
||||
row: 129
|
||||
column: 12
|
||||
column: 16
|
||||
end_location:
|
||||
row: 130
|
||||
column: 20
|
||||
row: 129
|
||||
column: 21
|
||||
fix: ~
|
||||
- kind:
|
||||
FunctionIsTooComplex:
|
||||
|
@ -228,9 +228,9 @@ expression: checks
|
|||
- 1
|
||||
location:
|
||||
row: 132
|
||||
column: 12
|
||||
column: 16
|
||||
end_location:
|
||||
row: 133
|
||||
row: 132
|
||||
column: 20
|
||||
fix: ~
|
||||
- kind:
|
||||
|
@ -239,9 +239,9 @@ expression: checks
|
|||
- 1
|
||||
location:
|
||||
row: 135
|
||||
column: 12
|
||||
column: 16
|
||||
end_location:
|
||||
row: 136
|
||||
column: 20
|
||||
row: 135
|
||||
column: 25
|
||||
fix: ~
|
||||
|
||||
|
|
|
@ -8,10 +8,10 @@ expression: checks
|
|||
- 4
|
||||
location:
|
||||
row: 73
|
||||
column: 0
|
||||
column: 4
|
||||
end_location:
|
||||
row: 81
|
||||
column: 16
|
||||
row: 73
|
||||
column: 12
|
||||
fix: ~
|
||||
- kind:
|
||||
FunctionIsTooComplex:
|
||||
|
@ -19,9 +19,9 @@ expression: checks
|
|||
- 9
|
||||
location:
|
||||
row: 113
|
||||
column: 4
|
||||
column: 8
|
||||
end_location:
|
||||
row: 138
|
||||
column: 40
|
||||
row: 113
|
||||
column: 14
|
||||
fix: ~
|
||||
|
||||
|
|
|
@ -1,47 +1,53 @@
|
|||
use rustc_hash::{FxHashMap, FxHashSet};
|
||||
use rustpython_ast::{Arguments, Expr, ExprKind, Stmt};
|
||||
use rustpython_ast::{Arg, Arguments, Expr, ExprKind, Stmt};
|
||||
|
||||
use crate::ast::function_type;
|
||||
use crate::ast::helpers::identifier_range;
|
||||
use crate::ast::types::{Range, Scope, ScopeKind};
|
||||
use crate::checks::{Check, CheckKind};
|
||||
use crate::pep8_naming::helpers;
|
||||
use crate::pep8_naming::settings::Settings;
|
||||
use crate::python::string::{self};
|
||||
use crate::source_code_locator::SourceCodeLocator;
|
||||
|
||||
/// N801
|
||||
pub fn invalid_class_name(class_def: &Stmt, name: &str) -> Option<Check> {
|
||||
pub fn invalid_class_name(
|
||||
class_def: &Stmt,
|
||||
name: &str,
|
||||
locator: &SourceCodeLocator,
|
||||
) -> Option<Check> {
|
||||
let stripped = name.strip_prefix('_').unwrap_or(name);
|
||||
if !stripped.chars().next().map_or(false, char::is_uppercase) || stripped.contains('_') {
|
||||
return Some(Check::new(
|
||||
CheckKind::InvalidClassName(name.to_string()),
|
||||
Range::from_located(class_def),
|
||||
identifier_range(class_def, locator),
|
||||
));
|
||||
}
|
||||
None
|
||||
}
|
||||
|
||||
/// N802
|
||||
pub fn invalid_function_name(func_def: &Stmt, name: &str, settings: &Settings) -> Option<Check> {
|
||||
if name.to_lowercase() != name
|
||||
&& !settings
|
||||
.ignore_names
|
||||
.iter()
|
||||
.any(|ignore_name| ignore_name == name)
|
||||
{
|
||||
pub fn invalid_function_name(
|
||||
func_def: &Stmt,
|
||||
name: &str,
|
||||
ignore_names: &[String],
|
||||
locator: &SourceCodeLocator,
|
||||
) -> Option<Check> {
|
||||
if name.to_lowercase() != name && ignore_names.iter().any(|ignore_name| ignore_name == name) {
|
||||
return Some(Check::new(
|
||||
CheckKind::InvalidFunctionName(name.to_string()),
|
||||
Range::from_located(func_def),
|
||||
identifier_range(func_def, locator),
|
||||
));
|
||||
}
|
||||
None
|
||||
}
|
||||
|
||||
/// N803
|
||||
pub fn invalid_argument_name(name: &str, location: Range) -> Option<Check> {
|
||||
pub fn invalid_argument_name(name: &str, arg: &Arg) -> Option<Check> {
|
||||
if name.to_lowercase() != name {
|
||||
return Some(Check::new(
|
||||
CheckKind::InvalidArgumentName(name.to_string()),
|
||||
location,
|
||||
Range::from_located(arg),
|
||||
));
|
||||
}
|
||||
None
|
||||
|
@ -124,7 +130,12 @@ pub fn invalid_first_argument_name_for_method(
|
|||
}
|
||||
|
||||
/// N807
|
||||
pub fn dunder_function_name(scope: &Scope, stmt: &Stmt, name: &str) -> Option<Check> {
|
||||
pub fn dunder_function_name(
|
||||
scope: &Scope,
|
||||
stmt: &Stmt,
|
||||
name: &str,
|
||||
locator: &SourceCodeLocator,
|
||||
) -> Option<Check> {
|
||||
if matches!(scope.kind, ScopeKind::Class(_)) {
|
||||
return None;
|
||||
}
|
||||
|
@ -138,7 +149,7 @@ pub fn dunder_function_name(scope: &Scope, stmt: &Stmt, name: &str) -> Option<Ch
|
|||
|
||||
Some(Check::new(
|
||||
CheckKind::DunderFunctionName,
|
||||
Range::from_located(stmt),
|
||||
identifier_range(stmt, locator),
|
||||
))
|
||||
}
|
||||
|
||||
|
@ -147,11 +158,12 @@ pub fn constant_imported_as_non_constant(
|
|||
import_from: &Stmt,
|
||||
name: &str,
|
||||
asname: &str,
|
||||
locator: &SourceCodeLocator,
|
||||
) -> Option<Check> {
|
||||
if string::is_upper(name) && !string::is_upper(asname) {
|
||||
return Some(Check::new(
|
||||
CheckKind::ConstantImportedAsNonConstant(name.to_string(), asname.to_string()),
|
||||
Range::from_located(import_from),
|
||||
identifier_range(import_from, locator),
|
||||
));
|
||||
}
|
||||
None
|
||||
|
@ -162,11 +174,12 @@ pub fn lowercase_imported_as_non_lowercase(
|
|||
import_from: &Stmt,
|
||||
name: &str,
|
||||
asname: &str,
|
||||
locator: &SourceCodeLocator,
|
||||
) -> Option<Check> {
|
||||
if !string::is_upper(name) && string::is_lower(name) && asname.to_lowercase() != asname {
|
||||
return Some(Check::new(
|
||||
CheckKind::LowercaseImportedAsNonLowercase(name.to_string(), asname.to_string()),
|
||||
Range::from_located(import_from),
|
||||
identifier_range(import_from, locator),
|
||||
));
|
||||
}
|
||||
None
|
||||
|
@ -177,11 +190,12 @@ pub fn camelcase_imported_as_lowercase(
|
|||
import_from: &Stmt,
|
||||
name: &str,
|
||||
asname: &str,
|
||||
locator: &SourceCodeLocator,
|
||||
) -> Option<Check> {
|
||||
if helpers::is_camelcase(name) && string::is_lower(asname) {
|
||||
return Some(Check::new(
|
||||
CheckKind::CamelcaseImportedAsLowercase(name.to_string(), asname.to_string()),
|
||||
Range::from_located(import_from),
|
||||
identifier_range(import_from, locator),
|
||||
));
|
||||
}
|
||||
None
|
||||
|
@ -192,6 +206,7 @@ pub fn camelcase_imported_as_constant(
|
|||
import_from: &Stmt,
|
||||
name: &str,
|
||||
asname: &str,
|
||||
locator: &SourceCodeLocator,
|
||||
) -> Option<Check> {
|
||||
if helpers::is_camelcase(name)
|
||||
&& !string::is_lower(asname)
|
||||
|
@ -200,7 +215,7 @@ pub fn camelcase_imported_as_constant(
|
|||
{
|
||||
return Some(Check::new(
|
||||
CheckKind::CamelcaseImportedAsConstant(name.to_string(), asname.to_string()),
|
||||
Range::from_located(import_from),
|
||||
identifier_range(import_from, locator),
|
||||
));
|
||||
}
|
||||
None
|
||||
|
@ -211,6 +226,7 @@ pub fn camelcase_imported_as_acronym(
|
|||
import_from: &Stmt,
|
||||
name: &str,
|
||||
asname: &str,
|
||||
locator: &SourceCodeLocator,
|
||||
) -> Option<Check> {
|
||||
if helpers::is_camelcase(name)
|
||||
&& !string::is_lower(asname)
|
||||
|
@ -219,7 +235,7 @@ pub fn camelcase_imported_as_acronym(
|
|||
{
|
||||
return Some(Check::new(
|
||||
CheckKind::CamelcaseImportedAsAcronym(name.to_string(), asname.to_string()),
|
||||
Range::from_located(import_from),
|
||||
identifier_range(import_from, locator),
|
||||
));
|
||||
}
|
||||
None
|
||||
|
|
|
@ -6,45 +6,45 @@ expression: checks
|
|||
InvalidClassName: bad
|
||||
location:
|
||||
row: 1
|
||||
column: 0
|
||||
column: 6
|
||||
end_location:
|
||||
row: 2
|
||||
column: 8
|
||||
row: 1
|
||||
column: 9
|
||||
fix: ~
|
||||
- kind:
|
||||
InvalidClassName: _bad
|
||||
location:
|
||||
row: 5
|
||||
column: 0
|
||||
column: 6
|
||||
end_location:
|
||||
row: 6
|
||||
column: 8
|
||||
row: 5
|
||||
column: 10
|
||||
fix: ~
|
||||
- kind:
|
||||
InvalidClassName: bad_class
|
||||
location:
|
||||
row: 9
|
||||
column: 0
|
||||
column: 6
|
||||
end_location:
|
||||
row: 10
|
||||
column: 8
|
||||
row: 9
|
||||
column: 15
|
||||
fix: ~
|
||||
- kind:
|
||||
InvalidClassName: Bad_Class
|
||||
location:
|
||||
row: 13
|
||||
column: 0
|
||||
column: 6
|
||||
end_location:
|
||||
row: 14
|
||||
column: 8
|
||||
row: 13
|
||||
column: 15
|
||||
fix: ~
|
||||
- kind:
|
||||
InvalidClassName: BAD_CLASS
|
||||
location:
|
||||
row: 17
|
||||
column: 0
|
||||
column: 6
|
||||
end_location:
|
||||
row: 18
|
||||
column: 8
|
||||
row: 17
|
||||
column: 15
|
||||
fix: ~
|
||||
|
||||
|
|
|
@ -3,48 +3,21 @@ source: src/pep8_naming/mod.rs
|
|||
expression: checks
|
||||
---
|
||||
- kind:
|
||||
InvalidFunctionName: Bad
|
||||
InvalidFunctionName: tearDownModule
|
||||
location:
|
||||
row: 4
|
||||
column: 0
|
||||
end_location:
|
||||
row: 5
|
||||
column: 8
|
||||
fix: ~
|
||||
- kind:
|
||||
InvalidFunctionName: _Bad
|
||||
location:
|
||||
row: 8
|
||||
column: 0
|
||||
end_location:
|
||||
row: 9
|
||||
column: 8
|
||||
fix: ~
|
||||
- kind:
|
||||
InvalidFunctionName: BAD
|
||||
location:
|
||||
row: 12
|
||||
column: 0
|
||||
end_location:
|
||||
row: 13
|
||||
column: 8
|
||||
fix: ~
|
||||
- kind:
|
||||
InvalidFunctionName: BAD_FUNC
|
||||
location:
|
||||
row: 16
|
||||
column: 0
|
||||
end_location:
|
||||
row: 17
|
||||
column: 8
|
||||
fix: ~
|
||||
- kind:
|
||||
InvalidFunctionName: testTest
|
||||
location:
|
||||
row: 40
|
||||
row: 32
|
||||
column: 4
|
||||
end_location:
|
||||
row: 41
|
||||
column: 19
|
||||
row: 32
|
||||
column: 18
|
||||
fix: ~
|
||||
- kind:
|
||||
InvalidFunctionName: tearDown
|
||||
location:
|
||||
row: 37
|
||||
column: 8
|
||||
end_location:
|
||||
row: 37
|
||||
column: 16
|
||||
fix: ~
|
||||
|
||||
|
|
|
@ -5,17 +5,17 @@ expression: checks
|
|||
- kind: DunderFunctionName
|
||||
location:
|
||||
row: 1
|
||||
column: 0
|
||||
column: 4
|
||||
end_location:
|
||||
row: 2
|
||||
column: 8
|
||||
row: 1
|
||||
column: 11
|
||||
fix: ~
|
||||
- kind: DunderFunctionName
|
||||
location:
|
||||
row: 14
|
||||
column: 4
|
||||
column: 8
|
||||
end_location:
|
||||
row: 15
|
||||
column: 12
|
||||
row: 14
|
||||
column: 15
|
||||
fix: ~
|
||||
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
use itertools::izip;
|
||||
use rustpython_ast::{Location, Stmt, StmtKind};
|
||||
use rustpython_ast::{Located, Location, Stmt, StmtKind};
|
||||
use rustpython_parser::ast::{Cmpop, Expr, ExprKind};
|
||||
|
||||
use crate::ast::types::Range;
|
||||
|
@ -65,11 +65,11 @@ fn is_ambiguous_name(name: &str) -> bool {
|
|||
}
|
||||
|
||||
/// E741
|
||||
pub fn ambiguous_variable_name(name: &str, location: Range) -> Option<Check> {
|
||||
pub fn ambiguous_variable_name<T>(name: &str, located: &Located<T>) -> Option<Check> {
|
||||
if is_ambiguous_name(name) {
|
||||
Some(Check::new(
|
||||
CheckKind::AmbiguousVariableName(name.to_string()),
|
||||
location,
|
||||
Range::from_located(located),
|
||||
))
|
||||
} else {
|
||||
None
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue