Python/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff synced 2026-01-20 21:10:48 -05:00
Code Issues Packages Projects Releases Wiki Activity

Automatically remove redundant open modes #640 (#843)

Browse Source
This commit is contained in:
Andri Bergsson
2022-11-21 21:06:41 +00:00
committed by GitHub
parent 731fba9006
commit ce116a80ad
9 changed files with 629 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/check_ast.rs
View File

@@ -1516,6 +1516,10 @@ where
pyupgrade::plugins::type_of_primitive(self, expr, func, args);
}
if self.settings.enabled.contains(&CheckCode::U015) {
pyupgrade::plugins::redundant_open_modes(self, expr);
}
// flake8-boolean-trap
if self.settings.enabled.contains(&CheckCode::FBT003) {
flake8_boolean_trap::plugins::check_boolean_positional_value_in_function_call(

7
src/checks.rs
View File

@@ -171,6 +171,7 @@ pub enum CheckCode {
U012,
U013,
U014,
U015,
// pydocstyle
D100,
D101,
@@ -504,6 +505,7 @@ pub enum CheckKind {
UnnecessaryEncodeUTF8,
ConvertTypedDictFunctionalToClass(String),
ConvertNamedTupleFunctionalToClass(String),
RedundantOpenModes,
// pydocstyle
BlankLineAfterLastSection(String),
BlankLineAfterSection(String),
@@ -779,6 +781,7 @@ impl CheckCode {
CheckCode::U012 => CheckKind::UnnecessaryEncodeUTF8,
CheckCode::U013 => CheckKind::ConvertTypedDictFunctionalToClass("...".to_string()),
CheckCode::U014 => CheckKind::ConvertNamedTupleFunctionalToClass("...".to_string()),
CheckCode::U015 => CheckKind::RedundantOpenModes,
// pydocstyle
CheckCode::D100 => CheckKind::PublicModule,
CheckCode::D101 => CheckKind::PublicClass,
@@ -1013,6 +1016,7 @@ impl CheckCode {
CheckCode::U012 => CheckCategory::Pyupgrade,
CheckCode::U013 => CheckCategory::Pyupgrade,
CheckCode::U014 => CheckCategory::Pyupgrade,
CheckCode::U015 => CheckCategory::Pyupgrade,
CheckCode::D100 => CheckCategory::Pydocstyle,
CheckCode::D101 => CheckCategory::Pydocstyle,
CheckCode::D102 => CheckCategory::Pydocstyle,
@@ -1238,6 +1242,7 @@ impl CheckKind {
CheckKind::UnnecessaryEncodeUTF8 => &CheckCode::U012,
CheckKind::ConvertTypedDictFunctionalToClass(_) => &CheckCode::U013,
CheckKind::ConvertNamedTupleFunctionalToClass(_) => &CheckCode::U014,
CheckKind::RedundantOpenModes => &CheckCode::U015,
// pydocstyle
CheckKind::BlankLineAfterLastSection(_) => &CheckCode::D413,
CheckKind::BlankLineAfterSection(_) => &CheckCode::D410,
@@ -1787,6 +1792,7 @@ impl CheckKind {
"Unnecessary parameters to `functools.lru_cache`".to_string()
}
CheckKind::UnnecessaryEncodeUTF8 => "Unnecessary call to `encode` as UTF-8".to_string(),
CheckKind::RedundantOpenModes => "Unnecessary open mode parameters".to_string(),
CheckKind::ConvertTypedDictFunctionalToClass(name) => {
format!("Convert `{name}` from `TypedDict` functional to class syntax")
}
@@ -2104,6 +2110,7 @@ impl CheckKind {
| CheckKind::UnnecessaryComprehension(..)
| CheckKind::UnnecessaryEncodeUTF8
| CheckKind::UnnecessaryFutureImport(..)
| CheckKind::RedundantOpenModes
| CheckKind::UnnecessaryGeneratorDict
| CheckKind::UnnecessaryGeneratorList
| CheckKind::UnnecessaryGeneratorSet

6
src/checks_gen.rs
View File

@@ -301,6 +301,7 @@ pub enum CheckCodePrefix {
U012,
U013,
U014,
U015,
W,
W2,
W29,
@@ -1125,6 +1126,7 @@ impl CheckCodePrefix {
CheckCode::U012,
CheckCode::U013,
CheckCode::U014,
CheckCode::U015,
],
CheckCodePrefix::U0 => vec![
CheckCode::U001,
@@ -1140,6 +1142,7 @@ impl CheckCodePrefix {
CheckCode::U012,
CheckCode::U013,
CheckCode::U014,
CheckCode::U015,
],
CheckCodePrefix::U00 => vec![
CheckCode::U001,
@@ -1165,12 +1168,14 @@ impl CheckCodePrefix {
CheckCode::U012,
CheckCode::U013,
CheckCode::U014,
CheckCode::U015,
],
CheckCodePrefix::U010 => vec![CheckCode::U010],
CheckCodePrefix::U011 => vec![CheckCode::U011],
CheckCodePrefix::U012 => vec![CheckCode::U012],
CheckCodePrefix::U013 => vec![CheckCode::U013],
CheckCodePrefix::U014 => vec![CheckCode::U014],
CheckCodePrefix::U015 => vec![CheckCode::U015],
CheckCodePrefix::W => vec![CheckCode::W292, CheckCode::W605],
CheckCodePrefix::W2 => vec![CheckCode::W292],
CheckCodePrefix::W29 => vec![CheckCode::W292],
@@ -1518,6 +1523,7 @@ impl CheckCodePrefix {
CheckCodePrefix::U012 => PrefixSpecificity::Explicit,
CheckCodePrefix::U013 => PrefixSpecificity::Explicit,
CheckCodePrefix::U014 => PrefixSpecificity::Explicit,
CheckCodePrefix::U015 => PrefixSpecificity::Explicit,
CheckCodePrefix::W => PrefixSpecificity::Category,
CheckCodePrefix::W2 => PrefixSpecificity::Hundreds,
CheckCodePrefix::W29 => PrefixSpecificity::Tens,

1
src/linter.rs
View File

@@ -518,6 +518,7 @@ mod tests {
#[test_case(CheckCode::U012, Path::new("U012.py"); "U012")]
#[test_case(CheckCode::U013, Path::new("U013.py"); "U013")]
#[test_case(CheckCode::U014, Path::new("U014.py"); "U014")]
#[test_case(CheckCode::U015, Path::new("U015.py"); "U015")]
#[test_case(CheckCode::W292, Path::new("W292_0.py"); "W292_0")]
#[test_case(CheckCode::W292, Path::new("W292_1.py"); "W292_1")]
#[test_case(CheckCode::W292, Path::new("W292_2.py"); "W292_2")]

2
src/pyupgrade/plugins/mod.rs
View File

@@ -1,6 +1,7 @@
pub use convert_named_tuple_functional_to_class::convert_named_tuple_functional_to_class;
pub use convert_typed_dict_functional_to_class::convert_typed_dict_functional_to_class;
pub use deprecated_unittest_alias::deprecated_unittest_alias;
pub use redundant_open_modes::redundant_open_modes;
pub use super_call_with_parameters::super_call_with_parameters;
pub use type_of_primitive::type_of_primitive;
pub use unnecessary_encode_utf8::unnecessary_encode_utf8;
@@ -14,6 +15,7 @@ pub use useless_object_inheritance::useless_object_inheritance;
mod convert_named_tuple_functional_to_class;
mod convert_typed_dict_functional_to_class;
mod deprecated_unittest_alias;
mod redundant_open_modes;
mod super_call_with_parameters;
mod type_of_primitive;
mod unnecessary_encode_utf8;

155
src/pyupgrade/plugins/redundant_open_modes.rs Normal file
View File

@@ -0,0 +1,155 @@
use std::str::FromStr;
use anyhow::{anyhow, Result};
use log::error;
use rustpython_ast::{Constant, Expr, ExprKind, Located, Location};
use rustpython_parser::lexer;
use rustpython_parser::token::Tok;
use crate::ast::helpers::{self, match_name_or_attr};
use crate::ast::types::Range;
use crate::autofix::Fix;
use crate::check_ast::Checker;
use crate::checks::{Check, CheckCode, CheckKind};
use crate::source_code_locator::SourceCodeLocator;
const OPEN_FUNC_NAME: &str = "open";
enum OpenMode {
U,
Ur,
Ub,
RUb,
R,
Rt,
Wt,
}
impl FromStr for OpenMode {
type Err = anyhow::Error;
fn from_str(string: &str) -> Result<Self, Self::Err> {
match string {
"U" => Ok(OpenMode::U),
"Ur" => Ok(OpenMode::Ur),
"Ub" => Ok(OpenMode::Ub),
"rUb" => Ok(OpenMode::RUb),
"r" => Ok(OpenMode::R),
"rt" => Ok(OpenMode::Rt),
"wt" => Ok(OpenMode::Wt),
_ => Err(anyhow!("Unknown open mode: {}", string)),
}
}
}
impl OpenMode {
fn replacement_value(&self) -> Option<String> {
match *self {
OpenMode::U => None,
OpenMode::Ur => None,
OpenMode::Ub => Some(String::from("\"rb\"")),
OpenMode::RUb => Some(String::from("\"rb\"")),
OpenMode::R => None,
OpenMode::Rt => None,
OpenMode::Wt => Some(String::from("\"w\"")),
}
}
}
fn match_open(expr: &Expr) -> Option<&Expr> {
if let ExprKind::Call { func, args, .. } = &expr.node {
// TODO(andberger): Verify that "open" is still bound to the built-in function.
if match_name_or_attr(func, OPEN_FUNC_NAME) {
// Return the "open mode" parameter.
return args.get(1);
}
}
None
}
fn create_check(
expr: &Expr,
mode_param: &Expr,
replacement_value: Option<String>,
locator: &SourceCodeLocator,
patch: bool,
) -> Check {
let mut check = Check::new(CheckKind::RedundantOpenModes, Range::from_located(expr));
if patch {
if let Some(content) = replacement_value {
check.amend(Fix::replacement(
content,
mode_param.location,
mode_param.end_location.unwrap(),
))
} else {
match create_remove_param_fix(locator, expr, mode_param) {
Ok(fix) => check.amend(fix),
Err(e) => error!("Failed to remove parameter: {}", e),
}
}
}
check
}
fn create_remove_param_fix(
locator: &SourceCodeLocator,
expr: &Expr,
mode_param: &Expr,
) -> Result<Fix> {
let content = locator.slice_source_code_range(&Range {
location: expr.location,
end_location: expr.end_location.unwrap(),
});
// Find the last comma before mode_param
// and delete that comma as well as mode_param.
let mut fix_start: Option<Location> = None;
let mut fix_end: Option<Location> = None;
for (start, tok, end) in lexer::make_tokenizer(&content).flatten() {
let start = helpers::to_absolute(start, expr.location);
let end = helpers::to_absolute(end, expr.location);
if start == mode_param.location {
fix_end = Some(end);
break;
}
if matches!(tok, Tok::Comma) {
fix_start = Some(start);
}
}
match (fix_start, fix_end) {
(Some(start), Some(end)) => Ok(Fix::deletion(start, end)),
_ => Err(anyhow::anyhow!(
"Failed to locate start and end parentheses."
)),
}
}
/// U015
pub fn redundant_open_modes(checker: &mut Checker, expr: &Expr) {
// TODO(andberger): Add "mode" keyword argument handling to handle invocations
// on the following formats:
// - `open("foo", mode="U")`
// - `open(name="foo", mode="U")`
// - `open(mode="U", name="foo")`
if let Some(mode_param) = match_open(expr) {
if let Located {
node:
ExprKind::Constant {
value: Constant::Str(mode_param_value),
..
},
..
} = mode_param
{
if let Ok(mode) = OpenMode::from_str(mode_param_value.as_str()) {
checker.add_check(create_check(
expr,
mode_param,
mode.replacement_value(),
checker.locator,
checker.patch(&CheckCode::U015),
));
}
}
}
}

413
src/snapshots/ruff__linter__tests__U015_U015.py.snap Normal file
View File

@@ -0,0 +1,413 @@
---
source: src/linter.rs
expression: checks
---
- kind: RedundantOpenModes
location:
row: 1
column: 0
end_location:
row: 1
column: 16
fix:
patch:
content: ""
location:
row: 1
column: 10
end_location:
row: 1
column: 15
applied: false
- kind: RedundantOpenModes
location:
row: 2
column: 0
end_location:
row: 2
column: 17
fix:
patch:
content: ""
location:
row: 2
column: 10
end_location:
row: 2
column: 16
applied: false
- kind: RedundantOpenModes
location:
row: 3
column: 0
end_location:
row: 3
column: 17
fix:
patch:
content: "\"rb\""
location:
row: 3
column: 12
end_location:
row: 3
column: 16
applied: false
- kind: RedundantOpenModes
location:
row: 4
column: 0
end_location:
row: 4
column: 18
fix:
patch:
content: "\"rb\""
location:
row: 4
column: 12
end_location:
row: 4
column: 17
applied: false
- kind: RedundantOpenModes
location:
row: 5
column: 0
end_location:
row: 5
column: 16
fix:
patch:
content: ""
location:
row: 5
column: 10
end_location:
row: 5
column: 15
applied: false
- kind: RedundantOpenModes
location:
row: 6
column: 0
end_location:
row: 6
column: 17
fix:
patch:
content: ""
location:
row: 6
column: 10
end_location:
row: 6
column: 16
applied: false
- kind: RedundantOpenModes
location:
row: 7
column: 0
end_location:
row: 7
column: 32
fix:
patch:
content: ""
location:
row: 7
column: 8
end_location:
row: 7
column: 13
applied: false
- kind: RedundantOpenModes
location:
row: 8
column: 0
end_location:
row: 8
column: 15
fix:
patch:
content: "\"w\""
location:
row: 8
column: 10
end_location:
row: 8
column: 14
applied: false
- kind: RedundantOpenModes
location:
row: 10
column: 5
end_location:
row: 10
column: 21
fix:
patch:
content: ""
location:
row: 10
column: 15
end_location:
row: 10
column: 20
applied: false
- kind: RedundantOpenModes
location:
row: 12
column: 5
end_location:
row: 12
column: 22
fix:
patch:
content: ""
location:
row: 12
column: 15
end_location:
row: 12
column: 21
applied: false
- kind: RedundantOpenModes
location:
row: 14
column: 5
end_location:
row: 14
column: 22
fix:
patch:
content: "\"rb\""
location:
row: 14
column: 17
end_location:
row: 14
column: 21
applied: false
- kind: RedundantOpenModes
location:
row: 16
column: 5
end_location:
row: 16
column: 23
fix:
patch:
content: "\"rb\""
location:
row: 16
column: 17
end_location:
row: 16
column: 22
applied: false
- kind: RedundantOpenModes
location:
row: 18
column: 5
end_location:
row: 18
column: 21
fix:
patch:
content: ""
location:
row: 18
column: 15
end_location:
row: 18
column: 20
applied: false
- kind: RedundantOpenModes
location:
row: 20
column: 5
end_location:
row: 20
column: 22
fix:
patch:
content: ""
location:
row: 20
column: 15
end_location:
row: 20
column: 21
applied: false
- kind: RedundantOpenModes
location:
row: 22
column: 5
end_location:
row: 22
column: 39
fix:
patch:
content: ""
location:
row: 22
column: 15
end_location:
row: 22
column: 20
applied: false
- kind: RedundantOpenModes
location:
row: 24
column: 5
end_location:
row: 24
column: 22
fix:
patch:
content: "\"w\""
location:
row: 24
column: 17
end_location:
row: 24
column: 21
applied: false
- kind: RedundantOpenModes
location:
row: 27
column: 0
end_location:
row: 27
column: 27
fix:
patch:
content: ""
location:
row: 27
column: 21
end_location:
row: 27
column: 26
applied: false
- kind: RedundantOpenModes
location:
row: 28
column: 0
end_location:
row: 28
column: 28
fix:
patch:
content: "\"rb\""
location:
row: 28
column: 23
end_location:
row: 28
column: 27
applied: false
- kind: RedundantOpenModes
location:
row: 30
column: 5
end_location:
row: 30
column: 32
fix:
patch:
content: ""
location:
row: 30
column: 26
end_location:
row: 30
column: 31
applied: false
- kind: RedundantOpenModes
location:
row: 32
column: 5
end_location:
row: 32
column: 33
fix:
patch:
content: "\"rb\""
location:
row: 32
column: 28
end_location:
row: 32
column: 32
applied: false
- kind: RedundantOpenModes
location:
row: 35
column: 5
end_location:
row: 35
column: 21
fix:
patch:
content: ""
location:
row: 35
column: 15
end_location:
row: 35
column: 20
applied: false
- kind: RedundantOpenModes
location:
row: 35
column: 29
end_location:
row: 35
column: 45
fix:
patch:
content: ""
location:
row: 35
column: 39
end_location:
row: 35
column: 44
applied: false
- kind: RedundantOpenModes
location:
row: 37
column: 5
end_location:
row: 37
column: 22
fix:
patch:
content: "\"rb\""
location:
row: 37
column: 17
end_location:
row: 37
column: 21
applied: false
- kind: RedundantOpenModes
location:
row: 37
column: 30
end_location:
row: 37
column: 47
fix:
patch:
content: "\"rb\""
location:
row: 37
column: 42
end_location:
row: 37
column: 46
applied: false