[`pylint`] Implement `consider-dict-items` (`C0206`) by max-muoto · Pull Request #11688 · astral-sh/ruff

max-muoto · 2024-06-02T04:53:40Z

Summary

This PR implements the consider dict items rule from Pylint. Enabling this rule flags:

ORCHESTRA = {
    "violin": "strings",
    "oboe": "woodwind",
    "tuba": "brass",
    "gong": "percussion",
}


for instrument in ORCHESTRA: 
    print(f"{instrument}: {ORCHESTRA[instrument]}")

for instrument in ORCHESTRA.keys(): 
    print(f"{instrument}: {ORCHESTRA[instrument]}")

for instrument in (inline_dict := {"foo": "bar"}): 
    print(f"{instrument}: {inline_dict[instrument]}")

For not using items() to extract the value out of the dict. We ignore the case of an assignment, as you can't modify the underlying representation with the value in the list of tuples returned.

Test Plan

cargo test.

github-actions · 2024-06-02T16:42:40Z

`ruff-ecosystem` results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

ℹ️ ecosystem check detected linter changes. (+35 -0 violations, +0 -0 fixes in 8 projects; 42 projects unchanged)

PlasmaPy/PlasmaPy (+4 -0 violations, +0 -0 fixes)

ruff check --no-cache --exit-zero --ignore RUF9 --output-format concise --preview

+ src/plasmapy/particles/_special_particles.py:260:5: PLC0206 Extracting value from dictionary without calling `.items()`
+ src/plasmapy/particles/decorators.py:677:9: PLC0206 Extracting value from dictionary without calling `.items()`
+ src/plasmapy/particles/ionization_state_collection.py:477:13: PLC0206 Extracting value from dictionary without calling `.items()`
+ src/plasmapy/plasma/grids.py:766:9: PLC0206 Extracting value from dictionary without calling `.items()`

apache/airflow (+6 -0 violations, +0 -0 fixes)

ruff check --no-cache --exit-zero --ignore RUF9 --output-format concise --preview --select ALL

+ airflow/models/taskinstance.py:3917:9: PLC0206 Extracting value from dictionary without calling `.items()`
+ airflow/www/views.py:2287:13: PLC0206 Extracting value from dictionary without calling `.items()`
+ docs/conf.py:471:5: PLC0206 Extracting value from dictionary without calling `.items()`
+ tests/providers/amazon/aws/executors/batch/test_batch_executor.py:677:9: PLC0206 Extracting value from dictionary without calling `.items()`
+ tests/providers/amazon/aws/executors/ecs/test_ecs_executor.py:1234:9: PLC0206 Extracting value from dictionary without calling `.items()`
+ tests/serialization/test_dag_serialization.py:550:9: PLC0206 Extracting value from dictionary without calling `.items()`

aws/aws-sam-cli (+1 -0 violations, +0 -0 fixes)

ruff check --no-cache --exit-zero --ignore RUF9 --output-format concise --preview

+ tests/integration/pipeline/test_bootstrap_command.py:229:9: PLC0206 Extracting value from dictionary without calling `.items()`

bokeh/bokeh (+2 -0 violations, +0 -0 fixes)

ruff check --no-cache --exit-zero --ignore RUF9 --output-format concise --preview --select ALL

+ src/bokeh/application/handlers/code.py:201:5: PLC0206 Extracting value from dictionary without calling `.items()`
+ src/bokeh/core/property/wrappers.py:470:9: PLC0206 Extracting value from dictionary without calling `.items()`

milvus-io/pymilvus (+1 -0 violations, +0 -0 fixes)

ruff check --no-cache --exit-zero --ignore RUF9 --output-format concise --preview

+ pymilvus/bulk_writer/buffer.py:91:9: PLC0206 Extracting value from dictionary without calling `.items()`

pandas-dev/pandas (+1 -0 violations, +0 -0 fixes)

ruff check --no-cache --exit-zero --ignore RUF9 --output-format concise --preview

+ pandas/io/stata.py:2131:5: PLC0206 Extracting value from dictionary without calling `.items()`

rotki/rotki (+3 -0 violations, +0 -0 fixes)

ruff check --no-cache --exit-zero --ignore RUF9 --output-format concise --preview

+ rotkehlchen/chain/evm/decoding/hop/balances.py:66:9: PLC0206 Extracting value from dictionary without calling `.items()`
+ rotkehlchen/data_import/importers/cryptocom.py:446:13: PLC0206 Extracting value from dictionary without calling `.items()`
+ rotkehlchen/tests/data_migrations/test_migrations.py:150:5: PLC0206 Extracting value from dictionary without calling `.items()`

zulip/zulip (+17 -0 violations, +0 -0 fixes)

ruff check --no-cache --exit-zero --ignore RUF9 --output-format concise --preview --select ALL

+ corporate/views/installation_activity.py:81:5: PLC0206 Extracting value from dictionary without calling `.items()`
+ tools/setup/emoji/emoji_setup_utils.py:90:5: PLC0206 Extracting value from dictionary without calling `.items()`
+ zerver/actions/realm_settings.py:237:5: PLC0206 Extracting value from dictionary without calling `.items()`
+ zerver/data_import/mattermost.py:135:5: PLC0206 Extracting value from dictionary without calling `.items()`
+ zerver/data_import/mattermost.py:165:9: PLC0206 Extracting value from dictionary without calling `.items()`
+ zerver/data_import/mattermost.py:849:5: PLC0206 Extracting value from dictionary without calling `.items()`
+ zerver/data_import/rocketchat.py:166:5: PLC0206 Extracting value from dictionary without calling `.items()`
+ zerver/data_import/rocketchat.py:214:5: PLC0206 Extracting value from dictionary without calling `.items()`
+ zerver/data_import/rocketchat.py:249:5: PLC0206 Extracting value from dictionary without calling `.items()`
+ zerver/data_import/rocketchat.py:65:5: PLC0206 Extracting value from dictionary without calling `.items()`
+ zerver/lib/cache.py:254:5: PLC0206 Extracting value from dictionary without calling `.items()`
+ zerver/lib/markdown/api_return_values_table_generator.py:114:9: PLC0206 Extracting value from dictionary without calling `.items()`
+ zerver/migrations/0382_create_role_based_system_groups.py:59:13: PLC0206 Extracting value from dictionary without calling `.items()`
+ zerver/migrations/0403_create_role_based_groups_for_internal_realms.py:68:9: PLC0206 Extracting value from dictionary without calling `.items()`
+ zerver/tests/test_events.py:451:13: PLC0206 Extracting value from dictionary without calling `.items()`
+ zerver/tests/test_users.py:723:9: PLC0206 Extracting value from dictionary without calling `.items()`
+ zerver/worker/missedmessage_emails.py:231:13: PLC0206 Extracting value from dictionary without calling `.items()`

Changes by rule (1 rules affected)

code	total	+ violation	- violation	+ fix	- fix
PLC0206	35	35	0	0	0

max-muoto · 2024-06-04T17:23:12Z

@charliermarsh Any chance you might be able to take a look?

charliermarsh · 2024-06-06T03:58:50Z

Interesting, I swear we have a rule for this... But maybe we don't? I see:

https://docs.astral.sh/ruff/rules/dict-iter-missing-items/ -- detects for city, population in data (missing .items()).
https://docs.astral.sh/ruff/rules/unnecessary-dict-index-lookup/ -- detects FRUITS[fruit_name] in a for fruit_name, fruit_count in FRUITS.items() loop.

max-muoto · 2024-06-06T04:00:32Z

Interesting, I swear we have a rule for this... But maybe we don't? I see:

https://docs.astral.sh/ruff/rules/dict-iter-missing-items/ -- detects for city, population in data (missing .items()).

https://docs.astral.sh/ruff/rules/unnecessary-dict-index-lookup/ -- detects FRUITS[fruit_name] in a for fruit_name, fruit_count in FRUITS.items() loop.

Yeah, a little different since this one doesn't rely on you using items before.

charliermarsh

Thanks!

charliermarsh · 2024-06-06T04:28:11Z

I reviewed the ecosystem checks and they look right to me.

max-muoto · 2024-06-06T04:29:15Z

Thanks!

Thanks for the clean up! Still getting used to writing more Rust code haha

charliermarsh · 2024-06-06T04:30:06Z

No prob! One thing I did in a few places was change x.is_none() followed by x.unwrap() to if let Some(x) = x, which couples "checking if the condition is met" with "getting access to the value".

dhruvmanila · 2024-06-06T04:52:52Z

...pylint/snapshots/ruff_linter__rules__pylint__tests__PLC0206_dict_index_missing_items.py.snap

+dict_index_missing_items.py:9:1: PLC0206 Extracting value from dictionary without calling `.items()`
+   |
+ 8 |   # Errors
+ 9 | / for instrument in ORCHESTRA:
+10 | |     print(f"{instrument}: {ORCHESTRA[instrument]}")
+   | |___________________________________________________^ PLC0206
+11 |   
+12 |   for instrument in ORCHESTRA:


It would be quite useful to have a infrastructure to provide additional details here similar to Biome. That would avoid highlighting the entire for statement and instead we could highlight individual pieces of code with details.

max-muoto added 10 commits June 1, 2024 23:53

implement-consider-dict-items

f41494d

Test

8d92035

Fixes

3f8d370

Fix test

b13f16d

Tweaks

7783075

Fixes

4cbde72

Fixes

0d8354d

Finalize

8e55fb3

Finalize

183bc52

Implement checks

520c8eb

max-muoto changed the title ~~implement-consider-dict-items~~ [pylint] Implement Consider Dict Items (C0206) Jun 2, 2024

max-muoto added 6 commits June 2, 2024 11:12

Clarify example

7efde9d

Fixes

92eb527

Linting fix

e3671c6

Add snapshot

a06bc09

Fix docs

f3e9940

Fix

0faead5

max-muoto marked this pull request as ready for review June 2, 2024 16:34

charliermarsh added rule Implementing or modifying a lint rule preview Related to preview mode features labels Jun 6, 2024

charliermarsh self-assigned this Jun 6, 2024

charliermarsh added 3 commits June 6, 2024 00:07

Format

809dccc

Merge branch 'main' into implement-consider-dict-items

d16f65b

Simplify visitor

9d7d527

charliermarsh changed the title ~~[pylint] Implement Consider Dict Items (C0206)~~ [pylint] Implement dict-iter-missing-items (C0206) Jun 6, 2024

charliermarsh approved these changes Jun 6, 2024

View reviewed changes

charliermarsh enabled auto-merge (squash) June 6, 2024 04:25

charliermarsh disabled auto-merge June 6, 2024 04:26

charliermarsh merged commit 5a5a588 into astral-sh:main Jun 6, 2024

dhruvmanila reviewed Jun 6, 2024

View reviewed changes

max-muoto changed the title ~~[pylint] Implement dict-iter-missing-items (C0206)~~ [pylint] Implement consider-dict-items (C0206) Jun 9, 2024

BrewTestBot mentioned this pull request Jun 14, 2024

ruff 0.4.9 Homebrew/homebrew-core#174580

Merged

augustelalande mentioned this pull request Jun 14, 2024

Implement Pylint #970

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[`pylint`] Implement `consider-dict-items` (`C0206`)#11688

[`pylint`] Implement `consider-dict-items` (`C0206`)#11688
charliermarsh merged 19 commits intoastral-sh:mainfrom
max-muoto:implement-consider-dict-items

max-muoto commented Jun 2, 2024 •

edited

Loading

Uh oh!

github-actions bot commented Jun 2, 2024 •

edited

Loading

Uh oh!

max-muoto commented Jun 4, 2024

Uh oh!

charliermarsh commented Jun 6, 2024

Uh oh!

max-muoto commented Jun 6, 2024

Uh oh!

charliermarsh left a comment

Uh oh!

charliermarsh commented Jun 6, 2024

Uh oh!

max-muoto commented Jun 6, 2024

Uh oh!

charliermarsh commented Jun 6, 2024

Uh oh!

dhruvmanila Jun 6, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

max-muoto commented Jun 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test Plan

Uh oh!

github-actions bot commented Jun 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ruff-ecosystem results

Linter (stable)

Linter (preview)

Uh oh!

max-muoto commented Jun 4, 2024

Uh oh!

charliermarsh commented Jun 6, 2024

Uh oh!

max-muoto commented Jun 6, 2024

Uh oh!

charliermarsh left a comment

Choose a reason for hiding this comment

Uh oh!

charliermarsh commented Jun 6, 2024

Uh oh!

max-muoto commented Jun 6, 2024

Uh oh!

charliermarsh commented Jun 6, 2024

Uh oh!

dhruvmanila Jun 6, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

max-muoto commented Jun 2, 2024 •

edited

Loading

github-actions bot commented Jun 2, 2024 •

edited

Loading

`ruff-ecosystem` results