forked from astral-sh/ruff
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
## Summary References astral-sh#970. Implements [`dict-iter-missing-items`](https://pylint.readthedocs.io/en/latest/user_guide/messages/error/dict-iter-missing-items.html). Took the tests from "upstream" [here](https://github.com/DanielNoord/pylint/blob/main/tests/functional/d/dict_iter_missing_items.py). ~I wasn't able to implement code for one false positive, but it is pretty estoric: pylint-dev/pylint#3283. I would personally argue that adding this check as preview rule without supporting this specific use case is fine. I did add a "test" for it.~ This was implemented. ## Test Plan Followed the Contributing guide to create tests, hopefully I didn't miss any. Also ran CI on my own fork and seemed to be all okay 😄 ~Edit: the ecosystem check seems a bit all over the place? 😅~ All good. --------- Co-authored-by: Dhruv Manilawala <dhruvmanila@gmail.com> Co-authored-by: Charlie Marsh <charlie.r.marsh@gmail.com>
- Loading branch information
Showing
8 changed files
with
193 additions
and
0 deletions.
There are no files selected for viewing
32 changes: 32 additions & 0 deletions
32
crates/ruff_linter/resources/test/fixtures/pylint/dict_iter_missing_items.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
from typing import Any | ||
|
||
|
||
d = {1: 1, 2: 2} | ||
d_tuple = {(1, 2): 3, (4, 5): 6} | ||
d_tuple_annotated: Any = {(1, 2): 3, (4, 5): 6} | ||
d_tuple_incorrect_tuple = {(1,): 3, (4, 5): 6} | ||
l = [1, 2] | ||
s1 = {1, 2} | ||
s2 = {1, 2, 3} | ||
|
||
# Errors | ||
for k, v in d: | ||
pass | ||
|
||
for k, v in d_tuple_incorrect_tuple: | ||
pass | ||
|
||
|
||
# Non errors | ||
for k, v in d.items(): | ||
pass | ||
for k in d.keys(): | ||
pass | ||
for i, v in enumerate(l): | ||
pass | ||
for i, v in s1.intersection(s2): | ||
pass | ||
for a, b in d_tuple: | ||
pass | ||
for a, b in d_tuple_annotated: | ||
pass |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
110 changes: 110 additions & 0 deletions
110
crates/ruff_linter/src/rules/pylint/rules/dict_iter_missing_items.rs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,110 @@ | ||
use ruff_python_ast::{Expr, ExprTuple}; | ||
|
||
use ruff_diagnostics::{AlwaysFixableViolation, Diagnostic, Edit, Fix}; | ||
use ruff_macros::{derive_message_formats, violation}; | ||
use ruff_python_semantic::analyze::typing::is_dict; | ||
use ruff_python_semantic::{Binding, SemanticModel}; | ||
use ruff_text_size::Ranged; | ||
|
||
use crate::checkers::ast::Checker; | ||
|
||
/// ## What it does | ||
/// Checks for dictionary unpacking in a for loop without calling `.items()`. | ||
/// | ||
/// ## Why is this bad? | ||
/// When iterating over a dictionary in a for loop, if a dictionary is unpacked | ||
/// without calling `.items()`, it could lead to a runtime error if the keys are not | ||
/// a tuple of two elements. | ||
/// | ||
/// It is likely that you're looking for an iteration over (key, value) pairs which | ||
/// can only be achieved when calling `.items()`. | ||
/// | ||
/// ## Example | ||
/// ```python | ||
/// data = {"Paris": 2_165_423, "New York City": 8_804_190, "Tokyo": 13_988_129} | ||
/// | ||
/// for city, population in data: | ||
/// print(f"{city} has population {population}.") | ||
/// ``` | ||
/// | ||
/// Use instead: | ||
/// ```python | ||
/// data = {"Paris": 2_165_423, "New York City": 8_804_190, "Tokyo": 13_988_129} | ||
/// | ||
/// for city, population in data.items(): | ||
/// print(f"{city} has population {population}.") | ||
/// ``` | ||
#[violation] | ||
pub struct DictIterMissingItems; | ||
|
||
impl AlwaysFixableViolation for DictIterMissingItems { | ||
#[derive_message_formats] | ||
fn message(&self) -> String { | ||
format!("Unpacking a dictionary in iteration without calling `.items()`") | ||
} | ||
|
||
fn fix_title(&self) -> String { | ||
format!("Add a call to `.items()`") | ||
} | ||
} | ||
|
||
pub(crate) fn dict_iter_missing_items(checker: &mut Checker, target: &Expr, iter: &Expr) { | ||
let Expr::Tuple(ExprTuple { elts, .. }) = target else { | ||
return; | ||
}; | ||
|
||
if elts.len() != 2 { | ||
return; | ||
}; | ||
|
||
let Some(name) = iter.as_name_expr() else { | ||
return; | ||
}; | ||
|
||
let Some(binding) = checker | ||
.semantic() | ||
.only_binding(name) | ||
.map(|id| checker.semantic().binding(id)) | ||
else { | ||
return; | ||
}; | ||
if !is_dict(binding, checker.semantic()) { | ||
return; | ||
} | ||
|
||
// If we can reliably determine that a dictionary has keys that are tuples of two we don't warn | ||
if is_dict_key_tuple_with_two_elements(checker.semantic(), binding) { | ||
return; | ||
} | ||
|
||
let mut diagnostic = Diagnostic::new(DictIterMissingItems, iter.range()); | ||
diagnostic.set_fix(Fix::safe_edit(Edit::range_replacement( | ||
format!("{}.items()", name.id), | ||
iter.range(), | ||
))); | ||
checker.diagnostics.push(diagnostic); | ||
} | ||
|
||
/// Returns true if the binding is a dictionary where each key is a tuple with two elements. | ||
fn is_dict_key_tuple_with_two_elements(semantic: &SemanticModel, binding: &Binding) -> bool { | ||
let Some(statement) = binding.statement(semantic) else { | ||
return false; | ||
}; | ||
|
||
let Some(assign_stmt) = statement.as_assign_stmt() else { | ||
return false; | ||
}; | ||
|
||
let Some(dict_expr) = assign_stmt.value.as_dict_expr() else { | ||
return false; | ||
}; | ||
|
||
dict_expr.keys.iter().all(|elt| { | ||
elt.as_ref().is_some_and(|x| { | ||
if let Some(tuple) = x.as_tuple_expr() { | ||
return tuple.elts.len() == 2; | ||
} | ||
false | ||
}) | ||
}) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
43 changes: 43 additions & 0 deletions
43
...lint/snapshots/ruff_linter__rules__pylint__tests__PLE1141_dict_iter_missing_items.py.snap
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
--- | ||
source: crates/ruff_linter/src/rules/pylint/mod.rs | ||
--- | ||
dict_iter_missing_items.py:13:13: PLE1141 [*] Unpacking a dictionary in iteration without calling `.items()` | ||
| | ||
12 | # Errors | ||
13 | for k, v in d: | ||
| ^ PLE1141 | ||
14 | pass | ||
| | ||
= help: Add a call to `.items()` | ||
|
||
ℹ Safe fix | ||
10 10 | s2 = {1, 2, 3} | ||
11 11 | | ||
12 12 | # Errors | ||
13 |-for k, v in d: | ||
13 |+for k, v in d.items(): | ||
14 14 | pass | ||
15 15 | | ||
16 16 | for k, v in d_tuple_incorrect_tuple: | ||
|
||
dict_iter_missing_items.py:16:13: PLE1141 [*] Unpacking a dictionary in iteration without calling `.items()` | ||
| | ||
14 | pass | ||
15 | | ||
16 | for k, v in d_tuple_incorrect_tuple: | ||
| ^^^^^^^^^^^^^^^^^^^^^^^ PLE1141 | ||
17 | pass | ||
| | ||
= help: Add a call to `.items()` | ||
|
||
ℹ Safe fix | ||
13 13 | for k, v in d: | ||
14 14 | pass | ||
15 15 | | ||
16 |-for k, v in d_tuple_incorrect_tuple: | ||
16 |+for k, v in d_tuple_incorrect_tuple.items(): | ||
17 17 | pass | ||
18 18 | | ||
19 19 | | ||
|
||
|
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.