[perflint] implement quick-fix for manual-list-comprehension (PERF401)
#13919
+537
−14
Conversation
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
|
Nice, thank you. |
|
Again, I'm not sure where to add tests for fixes. |
|
You can extend the existing tests. The testing framework runs your lint rule against the file and snapshots all created diagnostics with their fixes. |
|
| code | total | + violation | - violation | + fix | - fix |
|---|---|---|---|---|---|
| PERF401 | 98 | 49 | 49 | 0 | 0 |
Linter (preview)
ℹ️ ecosystem check detected linter changes. (+49 -49 violations, +0 -0 fixes in 3 projects; 51 projects unchanged)
apache/airflow (+31 -31 violations, +0 -0 fixes)
ruff check --no-cache --exit-zero --ignore RUF9 --output-format concise --preview --select ALL
- dev/breeze/src/airflow_breeze/commands/ci_commands.py:374:25: PERF401 Use a list comprehension to create a transformed list + dev/breeze/src/airflow_breeze/commands/ci_commands.py:374:25: PERF401 Use a list extend to create a transformed list - dev/breeze/src/airflow_breeze/commands/release_management_commands.py:3058:9: PERF401 Use a list comprehension to create a transformed list + dev/breeze/src/airflow_breeze/commands/release_management_commands.py:3058:9: PERF401 Use a list extend to create a transformed list - dev/breeze/src/airflow_breeze/commands/sbom_commands.py:973:13: PERF401 Use a list comprehension to create a transformed list + dev/breeze/src/airflow_breeze/commands/sbom_commands.py:973:13: PERF401 Use a list extend to create a transformed list - dev/breeze/src/airflow_breeze/params/shell_params.py:385:13: PERF401 Use a list comprehension to create a transformed list + dev/breeze/src/airflow_breeze/params/shell_params.py:385:13: PERF401 Use a list extend to create a transformed list - dev/breeze/src/airflow_breeze/utils/exclude_from_matrix.py:32:9: PERF401 Use a list comprehension to create a transformed list + dev/breeze/src/airflow_breeze/utils/exclude_from_matrix.py:32:9: PERF401 Use a list extend to create a transformed list - dev/breeze/src/airflow_breeze/utils/packages.py:326:9: PERF401 Use a list comprehension to create a transformed list + dev/breeze/src/airflow_breeze/utils/packages.py:326:9: PERF401 Use a list extend to create a transformed list - dev/breeze/src/airflow_breeze/utils/reproducible.py:126:17: PERF401 Use a list comprehension to create a transformed list + dev/breeze/src/airflow_breeze/utils/reproducible.py:126:17: PERF401 Use a list extend to create a transformed list - dev/breeze/src/airflow_breeze/utils/selective_checks.py:1077:17: PERF401 Use a list comprehension to create a transformed list + dev/breeze/src/airflow_breeze/utils/selective_checks.py:1077:17: PERF401 Use a list extend to create a transformed list - docs/exts/docs_build/fetch_inventories.py:103:9: PERF401 Use a list comprehension to create a transformed list + docs/exts/docs_build/fetch_inventories.py:103:9: PERF401 Use a list extend to create a transformed list - docs/exts/docs_build/fetch_inventories.py:111:9: PERF401 Use a list comprehension to create a transformed list + docs/exts/docs_build/fetch_inventories.py:111:9: PERF401 Use a list extend to create a transformed list - docs/exts/docs_build/fetch_inventories.py:119:9: PERF401 Use a list comprehension to create a transformed list + docs/exts/docs_build/fetch_inventories.py:119:9: PERF401 Use a list extend to create a transformed list - providers/src/airflow/providers/amazon/aws/hooks/s3.py:486:21: PERF401 Use a list comprehension to create a transformed list + providers/src/airflow/providers/amazon/aws/hooks/s3.py:486:21: PERF401 Use a list extend to create a transformed list - providers/src/airflow/providers/amazon/aws/hooks/s3.py:669:21: PERF401 Use a list comprehension to create a transformed list + providers/src/airflow/providers/amazon/aws/hooks/s3.py:669:21: PERF401 Use a list extend to create a transformed list - providers/src/airflow/providers/amazon/aws/log/s3_task_handler.py:122:17: PERF401 Use a list comprehension to create a transformed list + providers/src/airflow/providers/amazon/aws/log/s3_task_handler.py:122:17: PERF401 Use a list extend to create a transformed list - providers/src/airflow/providers/amazon/aws/operators/sagemaker.py:1210:17: PERF401 Use a list comprehension to create a transformed list + providers/src/airflow/providers/amazon/aws/operators/sagemaker.py:1210:17: PERF401 Use a list extend to create a transformed list - providers/src/airflow/providers/amazon/aws/operators/sagemaker.py:379:17: PERF401 Use a list comprehension to create a transformed list ... 31 additional changes omitted for project
apache/superset (+11 -11 violations, +0 -0 fixes)
ruff check --no-cache --exit-zero --ignore RUF9 --output-format concise --preview --select ALL
- scripts/benchmark_migration.py:128:21: PERF401 Use a list comprehension to create a transformed list + scripts/benchmark_migration.py:128:21: PERF401 Use a list extend to create a transformed list - superset/db_engine_specs/base.py:107:9: PERF401 Use a list comprehension to create a transformed list + superset/db_engine_specs/base.py:107:9: PERF401 Use a list extend to create a transformed list - superset/tasks/cache.py:192:17: PERF401 Use a list comprehension to create a transformed list + superset/tasks/cache.py:192:17: PERF401 Use a list extend to create a transformed list - superset/utils/core.py:1184:17: PERF401 Use a list comprehension to create a transformed list + superset/utils/core.py:1184:17: PERF401 Use a list extend to create a transformed list - tests/integration_tests/charts/api_tests.py:351:13: PERF401 Use a list comprehension to create a transformed list + tests/integration_tests/charts/api_tests.py:351:13: PERF401 Use a list extend to create a transformed list - tests/integration_tests/charts/api_tests.py:465:13: PERF401 Use a list comprehension to create a transformed list ... 11 additional changes omitted for project
bokeh/bokeh (+7 -7 violations, +0 -0 fixes)
ruff check --no-cache --exit-zero --ignore RUF9 --output-format concise --preview --select ALL
- src/bokeh/layouts.py:475:25: PERF401 Use a list comprehension to create a transformed list + src/bokeh/layouts.py:475:25: PERF401 Use a list extend to create a transformed list - src/bokeh/plotting/_figure.py:479:17: PERF401 Use a list comprehension to create a transformed list + src/bokeh/plotting/_figure.py:479:17: PERF401 Use a list extend to create a transformed list - src/bokeh/plotting/_figure.py:485:17: PERF401 Use a list comprehension to create a transformed list + src/bokeh/plotting/_figure.py:485:17: PERF401 Use a list extend to create a transformed list - src/bokeh/server/contexts.py:310:17: PERF401 Use a list comprehension to create a transformed list + src/bokeh/server/contexts.py:310:17: PERF401 Use a list extend to create a transformed list - src/bokeh/settings.py:780:21: PERF401 Use a list comprehension to create a transformed list + src/bokeh/settings.py:780:21: PERF401 Use a list extend to create a transformed list ... 4 additional changes omitted for project
Changes by rule (1 rules affected)
| code | total | + violation | - violation | + fix | - fix |
|---|---|---|---|---|---|
| PERF401 | 98 | 49 | 49 | 0 | 0 |
|
One thing that I wasn't sure how to handle is cases where there is control flow between the binding and the loop. def f(early_return):
result = []
if early_return:
return
for i in range(10):
result.append(i+1)Currently, this fix offers to rewrite the code: def f(early_return):
result = [i+1 for i in range(10)]
if early_return:
returnHow do you think this case ought to be handled? |
w0nder1ng
changed the title
PERF401] implement quick-fix for manual-list-comprehension (PERF401)perflint] implement quick-fix for manual-list-comprehension (PERF401)
MichaReiser
requested changes
Oct 30, 2024
| #[derive_message_formats] | ||
| fn message(&self) -> String { | ||
| let ManualListComprehension { is_async } = self; | ||
| let ManualListComprehension { is_async, .. } = self; |
There was a problem hiding this comment.
Let's adjust the message to make use of the new comprehension_type as well to avoid inconsistency between the message and the fix title.
crates/ruff_linter/src/rules/perflint/rules/manual_list_comprehension.rs
Outdated
Show resolved
Hide resolved
crates/ruff_linter/src/rules/perflint/rules/manual_list_comprehension.rs
Outdated
Show resolved
Hide resolved
crates/ruff_linter/src/rules/perflint/rules/manual_list_comprehension.rs
Outdated
Show resolved
Hide resolved
...er/src/rules/perflint/snapshots/ruff_linter__rules__perflint__tests__PERF401_PERF401.py.snap
Outdated
Show resolved
Hide resolved
|
I've modified the code to preserve comments and not leave a newline when removing the for loop. The tests seem to be failing because the fix is now gated behind a preview--is there a way to allow the test to set the preview flag, or should I temporarily change the fix availability to "sometimes"? |
@w0nder1ng You'll need to add a new test case where the preview flag is enabled. Refer to the following as an example: ruff/crates/ruff_linter/src/rules/ruff/mod.rs Lines 386 to 402 in 8d7dda9 |
|
How should I deal with the existing test case? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
I implemented a fix to rewrite for-loops where PERF401 applies into
list.extends. Since the target is guaranteed to be a list, and the lint (seemingly) guarantees that the iterator doesn't reference itself, this should be valid for all for-loops where the lint is applicable. It would be nice to implement this to rewrite the entire for-loop/variable assignment into a single list comprehensions, but I thought of several cases where this would affect how the code works, so this would need more consideration to write.Test Plan
I tried this on local files and it seemed to work, but I couldn't find where tests for
ruff check --fixlints go. I'd be happy to add tests if someone points me in the right direction.