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

Implement missing fixes for `PT006` (#1622)

This commit is contained in:
Edgar R. M 2023-01-03 21:52:51 -06:00 committed by GitHub
parent aacfc9ee0b
commit 16964409a8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 257 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
resources/test/fixtures/flake8_pytest_style/PT006.py vendored
View File

@ -39,3 +39,13 @@ def test_list(param1, param2):
@pytest.mark.parametrize(["param1"], [1, 2, 3])
def test_list_one_elem(param1, param2):
...
@pytest.mark.parametrize([some_expr, another_expr], [1, 2, 3])
def test_list_expressions(param1, param2):
...
@pytest.mark.parametrize([some_expr, "param2"], [1, 2, 3])
def test_list_mixed_expr_literal(param1, param2):
...

159
src/flake8_pytest_style/plugins/parametrize.rs
View File

@ -16,6 +16,59 @@ fn get_parametrize_decorator<'a>(checker: &Checker, decorators: &'a [Expr]) -> O
.find(|decorator| is_pytest_parametrize(decorator, checker))
}
fn elts_to_csv(elts: &[Expr], checker: &Checker) -> Option<String> {
let all_literals = elts.iter().all(|e| {
matches!(
e.node,
ExprKind::Constant {
value: Constant::Str(_),
..
}
)
});
if !all_literals {
return None;
}
let mut generator = SourceCodeGenerator::new(
checker.style.indentation(),
checker.style.quote(),
checker.style.line_ending(),
);
generator.unparse_expr(
&create_expr(ExprKind::Constant {
value: Constant::Str(elts.iter().fold(String::new(), |mut acc, elt| {
if let ExprKind::Constant {
value: Constant::Str(ref s),
..
} = elt.node
{
if !acc.is_empty() {
acc.push(',');
}
acc.push_str(s);
}
acc
})),
kind: None,
}),
0,
);
match generator.generate() {
Ok(s) => Some(s),
Err(e) => {
error!(
"Failed to generate CSV string from sequence of names: {}",
e
);
None
}
}
}
/// PT006
fn check_names(checker: &mut Checker, expr: &Expr) {
let names_type = checker.settings.flake8_pytest_style.parametrize_names_type;
@ -134,11 +187,60 @@ fn check_names(checker: &mut Checker, expr: &Expr) {
if let Some(first) = elts.first() {
handle_single_name(checker, expr, first);
}
} else if names_type != types::ParametrizeNameType::Tuple {
checker.add_check(Check::new(
} else {
match names_type {
types::ParametrizeNameType::Tuple => {}
types::ParametrizeNameType::List => {
let mut check = Check::new(
CheckKind::ParametrizeNamesWrongType(names_type),
Range::from_located(expr),
);
if checker.patch(check.kind.code()) {
let mut generator = SourceCodeGenerator::new(
checker.style.indentation(),
checker.style.quote(),
checker.style.line_ending(),
);
generator.unparse_expr(
&create_expr(ExprKind::List {
elts: elts.clone(),
ctx: ExprContext::Load,
}),
0,
);
match generator.generate() {
Ok(content) => {
check.amend(Fix::replacement(
content,
expr.location,
expr.end_location.unwrap(),
));
}
Err(e) => error!(
"Failed to fix wrong name(s) type in \
`@pytest.mark.parametrize`: {e}"
),
};
}
checker.add_check(check);
}
types::ParametrizeNameType::CSV => {
let mut check = Check::new(
CheckKind::ParametrizeNamesWrongType(names_type),
Range::from_located(expr),
);
if checker.patch(check.kind.code()) {
if let Some(content) = elts_to_csv(elts, checker) {
check.amend(Fix::replacement(
content,
expr.location,
expr.end_location.unwrap(),
));
}
}
checker.add_check(check);
}
}
};
}
ExprKind::List { elts, .. } => {
@ -146,11 +248,60 @@ fn check_names(checker: &mut Checker, expr: &Expr) {
if let Some(first) = elts.first() {
handle_single_name(checker, expr, first);
}
} else if names_type != types::ParametrizeNameType::List {
checker.add_check(Check::new(
} else {
match names_type {
types::ParametrizeNameType::List => {}
types::ParametrizeNameType::Tuple => {
let mut check = Check::new(
CheckKind::ParametrizeNamesWrongType(names_type),
Range::from_located(expr),
);
if checker.patch(check.kind.code()) {
let mut generator = SourceCodeGenerator::new(
checker.style.indentation(),
checker.style.quote(),
checker.style.line_ending(),
);
generator.unparse_expr(
&create_expr(ExprKind::Tuple {
elts: elts.clone(),
ctx: ExprContext::Load,
}),
1, // so tuple is generated with parentheses
);
match generator.generate() {
Ok(content) => {
check.amend(Fix::replacement(
content,
expr.location,
expr.end_location.unwrap(),
));
}
Err(e) => error!(
"Failed to fix wrong name(s) type in \
`@pytest.mark.parametrize`: {e}"
),
};
}
checker.add_check(check);
}
types::ParametrizeNameType::CSV => {
let mut check = Check::new(
CheckKind::ParametrizeNamesWrongType(names_type),
Range::from_located(expr),
);
if checker.patch(check.kind.code()) {
if let Some(content) = elts_to_csv(elts, checker) {
check.amend(Fix::replacement(
content,
expr.location,
expr.end_location.unwrap(),
));
}
}
checker.add_check(check);
}
}
};
}
_ => {}

38
src/flake8_pytest_style/snapshots/ruff__flake8_pytest_style__tests__PT006_csv.snap
View File

@ -10,7 +10,14 @@ expression: checks
end_location:
row: 24
column: 45
fix: ~
fix:
content: "\"param1,param2\""
location:
row: 24
column: 25
end_location:
row: 24
column: 45
parent: ~
- kind:
ParametrizeNamesWrongType: csv
@ -37,7 +44,14 @@ expression: checks
end_location:
row: 34
column: 45
fix: ~
fix:
content: "\"param1,param2\""
location:
row: 34
column: 25
end_location:
row: 34
column: 45
parent: ~
- kind:
ParametrizeNamesWrongType: csv
@ -56,4 +70,24 @@ expression: checks
row: 39
column: 35
parent: ~
- kind:
ParametrizeNamesWrongType: csv
location:
row: 44
column: 25
end_location:
row: 44
column: 50
fix: ~
parent: ~
- kind:
ParametrizeNamesWrongType: csv
location:
row: 49
column: 25
end_location:
row: 49
column: 46
fix: ~
parent: ~

43
src/flake8_pytest_style/snapshots/ruff__flake8_pytest_style__tests__PT006_default.snap
View File

@ -78,7 +78,14 @@ expression: checks
end_location:
row: 34
column: 45
fix: ~
fix:
content: "(\"param1\", \"param2\")"
location:
row: 34
column: 25
end_location:
row: 34
column: 45
parent: ~
- kind:
ParametrizeNamesWrongType: csv
@ -97,4 +104,38 @@ expression: checks
row: 39
column: 35
parent: ~
- kind:
ParametrizeNamesWrongType: tuple
location:
row: 44
column: 25
end_location:
row: 44
column: 50
fix:
content: "(some_expr, another_expr)"
location:
row: 44
column: 25
end_location:
row: 44
column: 50
parent: ~
- kind:
ParametrizeNamesWrongType: tuple
location:
row: 49
column: 25
end_location:
row: 49
column: 46
fix:
content: "(some_expr, \"param2\")"
location:
row: 49
column: 25
end_location:
row: 49
column: 46
parent: ~

9
src/flake8_pytest_style/snapshots/ruff__flake8_pytest_style__tests__PT006_list.snap
View File

@ -61,7 +61,14 @@ expression: checks
end_location:
row: 24
column: 45
fix: ~
fix:
content: "[\"param1\", \"param2\"]"
location:
row: 24
column: 25
end_location:
row: 24
column: 45
parent: ~
- kind:
ParametrizeNamesWrongType: csv