`[pylint]` Implement `len-test` (`PLC1802`) by Lokejoke · Pull Request #14309 · astral-sh/ruff

Lokejoke · 2024-11-13T08:37:57Z

Summary

This PR implements use-implicit-booleaness-not-len / C1802

For sequences, (strings, lists, tuples), use the fact that empty sequences are false.

Test Plan

Checked against pylint tests:

I would argue some of the tests (commented out) are not very intuitive and thus not helpful

Notes

Naming: Rule name and its error message (adopted from pylint) do not follow conventions used in Ruff (len-as-condition might be solution)

References

PEP 8 on empty sequences and implicit booleaness

github-actions · 2024-11-13T10:29:14Z

`ruff-ecosystem` results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

ℹ️ ecosystem check detected linter changes. (+21 -0 violations, +0 -0 fixes in 6 projects; 49 projects unchanged)

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

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

+ dev/breeze/src/airflow_breeze/commands/release_management_commands.py:1639:8: PLC1802 [*] `len(success_entries)` used as condition without comparison
+ dev/breeze/src/airflow_breeze/commands/release_management_commands.py:1646:8: PLC1802 [*] `len(skipped_entries)` used as condition without comparison
+ dev/breeze/src/airflow_breeze/commands/release_management_commands.py:1751:12: PLC1802 [*] `len(success_entries)` used as condition without comparison
+ dev/breeze/src/airflow_breeze/commands/release_management_commands.py:1758:12: PLC1802 [*] `len(skipped_entries)` used as condition without comparison
+ providers/src/airflow/providers/amazon/aws/hooks/glue.py:264:16: PLC1802 [*] `len(fetched_logs)` used as condition without comparison
+ providers/src/airflow/providers/sftp/sensors/sftp.py:129:16: PLC1802 [*] `len(files_found)` used as condition without comparison
+ providers/src/airflow/providers/snowflake/operators/snowflake.py:560:20: PLC1802 [*] `len(queries_in_progress)` used as condition without comparison

apache/superset (+5 -0 violations, +0 -0 fixes)

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

+ superset/databases/filters.py:98:16: PLC1802 [*] `len(allowed_schemas)` used as condition without comparison
+ superset/migrations/versions/2018-07-22_11-59_bebcf3fed1fe_convert_dashboard_v1_positions.py:444:61: PLC1802 [*] `len(SEQUENCE)` used as condition without comparison
+ superset/migrations/versions/2018-07-22_11-59_bebcf3fed1fe_convert_dashboard_v1_positions.py:546:11: PLC1802 [*] `len(ordered_raw_positions)` used as condition without comparison
+ superset/migrations/versions/2018-07-22_11-59_bebcf3fed1fe_convert_dashboard_v1_positions.py:559:16: PLC1802 [*] `len(available_columns_index)` used as condition without comparison
+ superset/migrations/versions/2018-11-12_13-31_4ce8df208545_migrate_time_range_for_default_filters.py:68:24: PLC1802 [*] `len(keys)` used as condition without comparison

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

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

+ src/bokeh/core/validation/check.py:216:27: PLC1802 [*] `len(warnings)` used as condition without comparison

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

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

+ zerver/views/invite.py:127:8: PLC1802 [*] `len(streams)` used as condition without comparison
+ zerver/views/invite.py:243:8: PLC1802 [*] `len(streams)` used as condition without comparison

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

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

+ testing/_py/test_local.py:218:16: PLC1802 [*] `len(lst)` used as condition without comparison

astropy/astropy (+5 -0 violations, +0 -0 fixes)

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

+ astropy/io/ascii/misc.py:83:12: PLC1802 [*] `len(first)` used as condition without comparison
+ astropy/units/core.py:1341:16: PLC1802 [*] `len(subresults)` used as condition without comparison
+ astropy/units/core.py:2501:12: PLC1802 [*] `len(names)` used as condition without comparison
+ astropy/wcs/wcs.py:2950:16: PLC1802 [*] `len(missing_keys)` used as condition without comparison
+ astropy/wcs/wcs.py:3765:20: PLC1802 [*] `len(content)` used as condition without comparison

Changes by rule (1 rules affected)

code	total	+ violation	- violation	+ fix	- fix
PLC1802	21	21	0	0	0

dylwil3

Thanks so much for this contribution! Some minor nits/requests for a few more tests. I also didn't get a chance to review the implementation carefully, but I'll hold off for now in case the new tests inspire any changes.

crates/ruff_linter/resources/test/fixtures/pylint/len_as_condition.py

crates/ruff_linter/src/rules/pylint/rules/len_as_condition.rs

dylwil3

This looks really great, thank you! I think even with the possible misses around control flow, this makes sense to implement. You would have to be pretty pathological to create a custom class C that implements __len__ and __bool__ where bool(x) != bool(len(x)) for x: C... so I think it's okay.

crates/ruff_linter/src/rules/pylint/rules/len_as_condition.rs

dylwil3

Almost there! Looking good!

crates/ruff_linter/src/rules/pylint/rules/len_as_condition.rs

MichaReiser · 2024-11-26T08:34:06Z

Naming: Maybe len-test to align with https://docs.astral.sh/ruff/rules/not-in-test/#not-in-test-e713

…unctions

dylwil3

LGTM, thank you for the great contribution and your patience through all the reviews!

Add pylint-use-implicit-booleaness-not-len

5292207

Lokejoke marked this pull request as draft November 13, 2024 08:47

xbrtnik1 added 3 commits November 13, 2024 10:37

Renamed rule to 'len-as-condition'

f99c8a7

Corrected rule doc

cf8d7da

Removed old snap

0177e08

Reformated docs

aa85ef6

Lokejoke marked this pull request as ready for review November 13, 2024 10:55

Lokejoke changed the title ~~[pylint] use-implicit-booleaness-not-len (C1802)~~ [pylint] Implement use-implicit-booleaness-not-len (C1802) Nov 14, 2024

Lokejoke changed the title ~~[pylint] Implement use-implicit-booleaness-not-len (C1802)~~ [pylint] Implement use-implicit-booleaness-not-len (C1802) Nov 14, 2024

Lokejoke changed the title ~~[pylint] Implement use-implicit-booleaness-not-len (C1802)~~ [pylint] Implement use-implicit-booleaness-not-len (C1802) Nov 14, 2024

Lokejoke changed the title ~~[pylint] Implement use-implicit-booleaness-not-len (C1802)~~ [pylint] Implement use-implicit-booleaness-not-len (PLC1802) Nov 14, 2024

dylwil3 requested changes Nov 14, 2024

View reviewed changes

dylwil3 added rule Implementing or modifying a lint rule preview Related to preview mode features labels Nov 14, 2024

Modified tests and error messages

3fb6de7

Lokejoke requested a review from dylwil3 November 15, 2024 16:50

Lokejoke mentioned this pull request Nov 17, 2024

[pylint] Implementing len-as-condition (PLC1802) Lokejoke/ruff#9

Open

dylwil3 self-assigned this Nov 17, 2024

dylwil3 requested changes Nov 21, 2024

View reviewed changes

Enhanced sequence query

4b32647

Lokejoke changed the title ~~[pylint] Implement use-implicit-booleaness-not-len (PLC1802)~~ [pylint] Implement len-as-condition (PLC1802) Nov 25, 2024

Lokejoke added 2 commits November 25, 2024 19:18

kwargs included

e686098

Removed unused imports

b2bbb7b

dylwil3 requested changes Nov 25, 2024

View reviewed changes

crates/ruff_linter/src/rules/pylint/rules/len_as_condition.rs Outdated Show resolved Hide resolved

crates/ruff_linter/src/rules/pylint/rules/len_as_condition.rs Show resolved Hide resolved

crates/ruff_linter/src/rules/pylint/rules/len_as_condition.rs Outdated Show resolved Hide resolved

Renamed rule, updated comments, updated built-in sequence returning f…

18e9b15

…unctions

Lokejoke changed the title ~~[pylint] Implement len-as-condition (PLC1802)~~ [pylint] Implement len-test (PLC1802`) Nov 26, 2024

Lokejoke requested a review from dylwil3 November 26, 2024 10:14

Lokejoke changed the title ~~[pylint] Implement len-test (PLC1802`)~~ [pylint] Implement len-test (PLC1802) Nov 26, 2024

dylwil3 approved these changes Nov 26, 2024

View reviewed changes

dylwil3 merged commit 82c01aa into astral-sh:main Nov 26, 2024

BrewTestBot mentioned this pull request Nov 29, 2024

ruff 0.8.1 Homebrew/homebrew-core#199449

Merged

MichaReiser mentioned this pull request Dec 2, 2024

Revert: [pyflakes] Avoid false positives in @no_type_check contexts (F821, F722) (#14615) #14726

Merged

Lokejoke mentioned this pull request Dec 8, 2024

Aggregating All Rules Implemented for the Thesis (Do not merge!) Lokejoke/ruff#22

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`[pylint]` Implement `len-test` (`PLC1802`)#14309

`[pylint]` Implement `len-test` (`PLC1802`)#14309
dylwil3 merged 10 commits intoastral-sh:mainfrom
Lokejoke:use-implicit-booleaness

Lokejoke commented Nov 13, 2024 •

edited

Loading

Uh oh!

github-actions bot commented Nov 13, 2024 •

edited

Loading

Uh oh!

dylwil3 left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dylwil3 left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dylwil3 left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MichaReiser commented Nov 26, 2024

Uh oh!

dylwil3 left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

Lokejoke commented Nov 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test Plan

Notes

References

Uh oh!

github-actions bot commented Nov 13, 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!

dylwil3 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dylwil3 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dylwil3 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MichaReiser commented Nov 26, 2024

Uh oh!

dylwil3 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Lokejoke commented Nov 13, 2024 •

edited

Loading

github-actions bot commented Nov 13, 2024 •

edited

Loading

`ruff-ecosystem` results