language-servers/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-08-03 18:28:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

[pylint]: bad-str-strip-call (With Autofix) (#2570)

Browse source
This commit is contained in:
Colin Delahunty 2023-02-06 15:34:37 -05:00 • committed by GitHub
parent f8b8b05b80
commit 6272293180
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 555 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

73
crates/ruff/resources/test/fixtures/pylint/bad_str_strip_call.py vendored Normal file
View file

@ -0,0 +1,73 @@
# PLE1310
"Hello World".strip("Hello")
# PLE1310
"Hello World".strip("Hello")
# PLE1310
"Hello World".strip(u"Hello")
# PLE1310
"Hello World".strip(r"Hello")
# PLE1310
"Hello World".strip("Hel\tlo")
# PLE1310
"Hello World".strip(r"He\tllo")
# PLE1310
"Hello World".strip("Hel\\lo")
# PLE1310
"Hello World".strip(r"He\\llo")
# PLE1310
"Hello World".strip("🤣🤣🤣🤣🙃👀😀")
# PLE1310
"Hello World".strip(
"""
there are a lot of characters to strip
"""
)
# PLE1310
"Hello World".strip("can we get a long " \
"string of characters to strip " \
"please?")
# PLE1310
"Hello World".strip(
"can we get a long "
"string of characters to strip "
"please?"
)
# PLE1310
"Hello World".strip(
"can \t we get a long"
"string \t of characters to strip"
"please?"
)
# PLE1310
"Hello World".strip(
"abc def"
"ghi"
)
# PLE1310
u''.strip('http://')
# PLE1310
u''.lstrip('http://')
# PLE1310
b''.rstrip('http://')
# OK
''.strip('Hi')
# OK
''.strip()

3
crates/ruff/src/checkers/ast.rs
View file

@ -2637,6 +2637,9 @@ where
if self.settings.rules.enabled(&Rule::ConsiderUsingSysExit) {
pylint::rules::consider_using_sys_exit(self, func);
}
if self.settings.rules.enabled(&Rule::BadStrStripCall) {
pylint::rules::bad_str_strip_call(self, func, args);
}
// flake8-pytest-style
if self.settings.rules.enabled(&Rule::PatchWithLambda) {

1
crates/ruff/src/registry.rs
View file

@ -107,6 +107,7 @@ ruff_macros::define_rule_mapping!(
// pylint
PLE0604 => rules::pylint::rules::InvalidAllObject,
PLE0605 => rules::pylint::rules::InvalidAllFormat,
PLE1310 => rules::pylint::rules::BadStrStripCall,
PLC0414 => rules::pylint::rules::UselessImportAlias,
PLC3002 => rules::pylint::rules::UnnecessaryDirectLambdaCall,
PLE0117 => rules::pylint::rules::NonlocalWithoutBinding,

1
crates/ruff/src/rules/pylint/mod.rs
View file

@ -40,6 +40,7 @@ mod tests {
#[test_case(Rule::TooManyArguments, Path::new("too_many_arguments.py"); "PLR0913")]
#[test_case(Rule::TooManyBranches, Path::new("too_many_branches.py"); "PLR0912")]
#[test_case(Rule::TooManyStatements, Path::new("too_many_statements.py"); "PLR0915")]
#[test_case(Rule::BadStrStripCall, Path::new("bad_str_strip_call.py"); "PLE01310")]
fn rules(rule_code: Rule, path: &Path) -> Result<()> {
let snapshot = format!("{}_{}", rule_code.code(), path.to_string_lossy());
let diagnostics = test_path(

194
crates/ruff/src/rules/pylint/rules/bad_str_strip_call.rs Normal file
View file

@ -0,0 +1,194 @@
use std::fmt;
use rustc_hash::FxHashSet;
use rustpython_ast::{Constant, Expr, ExprKind};
use rustpython_parser::lexer;
use rustpython_parser::lexer::Tok;
use serde::{Deserialize, Serialize};
use ruff_macros::derive_message_formats;
use crate::ast::types::Range;
use crate::checkers::ast::Checker;
use crate::define_violation;
use crate::fix::Fix;
use crate::registry::Diagnostic;
use crate::rules::pydocstyle::helpers::{leading_quote, trailing_quote};
use crate::violation::AlwaysAutofixableViolation;
#[derive(Debug, PartialEq, Eq, Serialize, Deserialize)]
pub enum StripKind {
Strip,
LStrip,
RStrip,
}
impl StripKind {
pub fn from_str(s: &str) -> Option<Self> {
match s {
"strip" => Some(Self::Strip),
"lstrip" => Some(Self::LStrip),
"rstrip" => Some(Self::RStrip),
_ => None,
}
}
}
impl fmt::Display for StripKind {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let representation = match self {
Self::Strip => "strip",
Self::LStrip => "lstrip",
Self::RStrip => "rstrip",
};
write!(f, "{representation}")
}
}
define_violation!(
pub struct BadStrStripCall {
kind: StripKind,
}
);
impl AlwaysAutofixableViolation for BadStrStripCall {
#[derive_message_formats]
fn message(&self) -> String {
let Self { kind } = self;
format!("String `{kind}` call contains duplicate characters")
}
fn autofix_title(&self) -> String {
"Remove duplicate characters".to_string()
}
}
/// Remove duplicate characters from an escaped string.
fn deduplicate_escaped(s: &str) -> String {
let mut result = String::new();
let mut escaped = false;
let mut seen = FxHashSet::default();
for ch in s.chars() {
if escaped {
escaped = false;
let pair = format!("\\{}", ch);
if !seen.insert(pair) {
continue;
}
} else if ch == '\\' {
escaped = true;
} else if !seen.insert(ch.to_string()) {
continue;
}
result.push(ch);
}
result
}
/// Remove duplicate characters from a raw string.
fn deduplicate_raw(s: &str) -> String {
let mut result = String::new();
let mut seen = FxHashSet::default();
for ch in s.chars() {
if !seen.insert(ch) {
continue;
}
result.push(ch);
}
result
}
/// Return `true` if a string contains duplicate characters, taking into account escapes.
fn has_duplicates(s: &str) -> bool {
let mut escaped = false;
let mut seen = FxHashSet::default();
for ch in s.chars() {
if escaped {
escaped = false;
let pair = format!("\\{}", ch);
if !seen.insert(pair) {
return true;
}
} else if ch == '\\' {
escaped = true;
} else if !seen.insert(ch.to_string()) {
return true;
}
}
false
}
/// PLE1310
pub fn bad_str_strip_call(checker: &mut Checker, func: &Expr, args: &[Expr]) {
if let ExprKind::Attribute { value, attr, .. } = &func.node {
if matches!(
value.node,
ExprKind::Constant {
value: Constant::Str(_) | Constant::Bytes(_),
..
}
) {
if let Some(kind) = StripKind::from_str(attr.as_str()) {
if let Some(arg) = args.get(0) {
if let ExprKind::Constant {
value: Constant::Str(value),
..
} = &arg.node
{
let is_multiline = arg.location.row() != arg.end_location.unwrap().row();
let module_text = checker
.locator
.slice_source_code_range(&Range::from_located(arg));
if !is_multiline
&& lexer::make_tokenizer_located(module_text, arg.location)
.flatten()
.filter(|(_, tok, _)| matches!(tok, Tok::String { .. }))
.nth(1)
.is_none()
{
// If we have a single string (no implicit concatenation), fix it.
let Some(leading_quote) = leading_quote(module_text) else {
return;
};
let Some(trailing_quote) = trailing_quote(module_text) else {
return;
};
let content = &module_text
[leading_quote.len()..module_text.len() - trailing_quote.len()];
let deduplicated =
if leading_quote.contains('r') || leading_quote.contains('R') {
deduplicate_raw(content)
} else {
deduplicate_escaped(content)
};
if content != deduplicated {
let mut diagnostic = Diagnostic::new(
BadStrStripCall { kind },
Range::from_located(arg),
);
if checker.patch(diagnostic.kind.rule()) {
diagnostic.amend(Fix::replacement(
format!("{leading_quote}{deduplicated}{trailing_quote}"),
arg.location,
arg.end_location.unwrap(),
));
};
checker.diagnostics.push(diagnostic);
}
} else {
// Otherwise, let's just look for duplicates.
if has_duplicates(value) {
checker.diagnostics.push(Diagnostic::new(
BadStrStripCall { kind },
Range::from_located(arg),
));
}
}
}
}
}
}
}
}

2
crates/ruff/src/rules/pylint/rules/mod.rs
View file

@ -1,4 +1,5 @@
pub use await_outside_async::{await_outside_async, AwaitOutsideAsync};
pub use bad_str_strip_call::{bad_str_strip_call, BadStrStripCall};
pub use comparison_of_constant::{comparison_of_constant, ComparisonOfConstant};
pub use consider_using_sys_exit::{consider_using_sys_exit, ConsiderUsingSysExit};
pub use global_variable_not_assigned::GlobalVariableNotAssigned;
@ -23,6 +24,7 @@ pub use useless_else_on_loop::{useless_else_on_loop, UselessElseOnLoop};
pub use useless_import_alias::{useless_import_alias, UselessImportAlias};
mod await_outside_async;
mod bad_str_strip_call;
mod comparison_of_constant;
mod consider_using_sys_exit;
mod global_variable_not_assigned;

277
crates/ruff/src/rules/pylint/snapshots/ruff__rules__pylint__tests__PLE1310_bad_str_strip_call.py.snap Normal file
View file

@ -0,0 +1,277 @@
---
source: crates/ruff/src/rules/pylint/mod.rs
expression: diagnostics
---
- kind:
BadStrStripCall:
kind: Strip
location:
row: 2
column: 20
end_location:
row: 2
column: 27
fix:
content:
- "\"Helo\""
location:
row: 2
column: 20
end_location:
row: 2
column: 27
parent: ~
- kind:
BadStrStripCall:
kind: Strip
location:
row: 5
column: 20
end_location:
row: 5
column: 27
fix:
content:
- "\"Helo\""
location:
row: 5
column: 20
end_location:
row: 5
column: 27
parent: ~
- kind:
BadStrStripCall:
kind: Strip
location:
row: 8
column: 20
end_location:
row: 8
column: 28
fix:
content:
- "u\"Helo\""
location:
row: 8
column: 20
end_location:
row: 8
column: 28
parent: ~
- kind:
BadStrStripCall:
kind: Strip
location:
row: 11
column: 20
end_location:
row: 11
column: 28
fix:
content:
- "r\"Helo\""
location:
row: 11
column: 20
end_location:
row: 11
column: 28
parent: ~
- kind:
BadStrStripCall:
kind: Strip
location:
row: 14
column: 20
end_location:
row: 14
column: 29
fix:
content:
- "\"Hel\\to\""
location:
row: 14
column: 20
end_location:
row: 14
column: 29
parent: ~
- kind:
BadStrStripCall:
kind: Strip
location:
row: 17
column: 20
end_location:
row: 17
column: 30
fix:
content:
- "r\"He\\tlo\""
location:
row: 17
column: 20
end_location:
row: 17
column: 30
parent: ~
- kind:
BadStrStripCall:
kind: Strip
location:
row: 20
column: 20
end_location:
row: 20
column: 29
fix:
content:
- "\"Hel\\\\o\""
location:
row: 20
column: 20
end_location:
row: 20
column: 29
parent: ~
- kind:
BadStrStripCall:
kind: Strip
location:
row: 23
column: 20
end_location:
row: 23
column: 30
fix:
content:
- "r\"He\\lo\""
location:
row: 23
column: 20
end_location:
row: 23
column: 30
parent: ~
- kind:
BadStrStripCall:
kind: Strip
location:
row: 26
column: 20
end_location:
row: 26
column: 29
fix:
content:
- "\"🤣🙃👀😀\""
location:
row: 26
column: 20
end_location:
row: 26
column: 29
parent: ~
- kind:
BadStrStripCall:
kind: Strip
location:
row: 30
column: 4
end_location:
row: 32
column: 3
fix: ~
parent: ~
- kind:
BadStrStripCall:
kind: Strip
location:
row: 36
column: 20
end_location:
row: 38
column: 29
fix: ~
parent: ~
- kind:
BadStrStripCall:
kind: Strip
location:
row: 42
column: 4
end_location:
row: 44
column: 13
fix: ~
parent: ~
- kind:
BadStrStripCall:
kind: Strip
location:
row: 49
column: 4
end_location:
row: 51
column: 13
fix: ~
parent: ~
- kind:
BadStrStripCall:
kind: Strip
location:
row: 61
column: 10
end_location:
row: 61
column: 19
fix:
content:
- "'htp:/'"
location:
row: 61
column: 10
end_location:
row: 61
column: 19
parent: ~
- kind:
BadStrStripCall:
kind: LStrip
location:
row: 64
column: 11
end_location:
row: 64
column: 20
fix:
content:
- "'htp:/'"
location:
row: 64
column: 11
end_location:
row: 64
column: 20
parent: ~
- kind:
BadStrStripCall:
kind: RStrip
location:
row: 67
column: 11
end_location:
row: 67
column: 20
fix:
content:
- "'htp:/'"
location:
row: 67
column: 11
end_location:
row: 67
column: 20
parent: ~