Skip to content

Comments

Add rule PLR6101#10146

Closed
tibor-reiss wants to merge 1 commit intoastral-sh:mainfrom
tibor-reiss:add-R6101
Closed

Add rule PLR6101#10146
tibor-reiss wants to merge 1 commit intoastral-sh:mainfrom
tibor-reiss:add-R6101

Conversation

@tibor-reiss
Copy link
Contributor

@tibor-reiss tibor-reiss commented Feb 27, 2024

Add rule consider-using-namedtuple-or-dataclass (PLR6101)

See #970 for rules

Test plan: cargo test

@MichaReiser MichaReiser mentioned this pull request Feb 27, 2024
Merged
@github-actions
Copy link
Contributor

github-actions bot commented Feb 27, 2024 •
edited
Loading

ruff-ecosystem results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

ℹ️ ecosystem check detected linter changes. (+210 -802 violations, +0 -0 fixes in 13 projects; 30 projects unchanged)

apache/airflow (+124 -585 violations, +0 -0 fixes) 

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

+ airflow/__init__.py:59:52: PLR6101 Consider using dataclass or namedtuple instead of dict
- airflow/cli/commands/webserver_command.py:48:7: PLR0902 Too many instance attributes (11/7)
+ airflow/config_templates/__init__.py:22:24: PLR6101 Consider using dataclass or namedtuple instead of dict
+ airflow/contrib/task_runner/__init__.py:30:24: PLR6101 Consider using dataclass or namedtuple instead of dict
+ airflow/contrib/utils/log/__init__.py:26:24: PLR6101 Consider using dataclass or namedtuple instead of dict
- airflow/dag_processing/manager.py:330:7: PLR0902 Too many instance attributes (27/7)
- airflow/dag_processing/manager.py:99:7: PLR0902 Too many instance attributes (12/7)
- airflow/dag_processing/processor.py:69:7: PLR0902 Too many instance attributes (11/7)
- airflow/jobs/backfill_job_runner.py:65:7: PLR0902 Too many instance attributes (17/7)
- airflow/jobs/job.py:58:7: PLR0902 Too many instance attributes (12/7)
- airflow/jobs/local_task_job_runner.py:77:7: PLR0902 Too many instance attributes (13/7)
- airflow/jobs/scheduler_job_runner.py:129:7: PLR0902 Too many instance attributes (13/7)
+ airflow/macros/__init__.py:35:24: PLR6101 Consider using dataclass or namedtuple instead of dict
- airflow/models/baseoperator.py:477:7: PLR0902 Too many instance attributes (53/7)
- airflow/models/connection.py:97:7: PLR0902 Too many instance attributes (8/7)
- airflow/models/dag.py:302:7: PLR0902 Too many instance attributes (42/7)
- airflow/models/dagbag.py:79:7: PLR0902 Too many instance attributes (12/7)
- airflow/models/dagrun.py:110:7: PLR0902 Too many instance attributes (13/7)
- airflow/models/taskinstance.py:1211:7: PLR0902 Too many instance attributes (20/7)
- airflow/models/taskinstance.py:3518:7: PLR0902 Too many instance attributes (14/7)
- airflow/models/taskreschedule.py:44:7: PLR0902 Too many instance attributes (9/7)
- airflow/operators/email.py:29:7: PLR0902 Too many instance attributes (10/7)
- airflow/operators/trigger_dagrun.py:72:7: PLR0902 Too many instance attributes (8/7)
... 568 additional changes omitted for rule PLR0902
+ airflow/providers/amazon/aws/auth_manager/aws_auth_manager.py:99:55: PLR6101 Consider using dataclass or namedtuple instead of dict
+ airflow/providers/google/cloud/hooks/cloud_sql.py:685:57: PLR6101 Consider using dataclass or namedtuple instead of dict
+ airflow/providers/google/marketing_platform/example_dags/example_display_video.py:75:14: PLR6101 Consider using dataclass or namedtuple instead of dict
+ airflow/settings.py:274:23: PLR6101 Consider using dataclass or namedtuple instead of dict
+ airflow/utils/operator_helpers.py:31:35: PLR6101 Consider using dataclass or namedtuple instead of dict
+ dev/chart/build_changelog_annotations.py:44:16: PLR6101 Consider using dataclass or namedtuple instead of dict
+ docs/conf.py:134:24: PLR6101 Consider using dataclass or namedtuple instead of dict
+ helm_tests/airflow_aux/test_container_lifecycle.py:23:34: PLR6101 Consider using dataclass or namedtuple instead of dict
+ helm_tests/other/test_redis.py:30:17: PLR6101 Consider using dataclass or namedtuple instead of dict
+ tests/hooks/test_package_index.py:37:20: PLR6101 Consider using dataclass or namedtuple instead of dict
+ tests/providers/amazon/aws/hooks/test_athena.py:47:32: PLR6101 Consider using dataclass or namedtuple instead of dict
+ tests/providers/amazon/aws/hooks/test_athena.py:48:34: PLR6101 Consider using dataclass or namedtuple instead of dict
... 674 additional changes omitted for project

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

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

+ samcli/cli/core/options.py:16:33: PLR6101 Consider using dataclass or namedtuple instead of dict
- samcli/commands/delete/delete_context.py:30:7: PLR0902 Too many instance attributes (14/7)
+ samcli/commands/deploy/core/options.py:62:33: PLR6101 Consider using dataclass or namedtuple instead of dict
- samcli/commands/deploy/deploy_context.py:43:7: PLR0902 Too many instance attributes (28/7)
- samcli/commands/deploy/guided_context.py:42:7: PLR0902 Too many instance attributes (32/7)
+ samcli/commands/init/core/options.py:35:33: PLR6101 Consider using dataclass or namedtuple instead of dict
- samcli/commands/list/endpoints/endpoints_context.py:16:7: PLR0902 Too many instance attributes (10/7)
- samcli/commands/local/cli_common/invoke_context.py:62:7: PLR0902 Too many instance attributes (35/7)
+ samcli/commands/local/invoke/core/options.py:65:33: PLR6101 Consider using dataclass or namedtuple instead of dict
- samcli/commands/local/lib/local_api_service.py:15:7: PLR0902 Too many instance attributes (9/7)
... 79 additional changes omitted for rule PLR0902
... 89 additional changes omitted for project

bokeh/bokeh (+11 -14 violations, +0 -0 fixes) 

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

+ docs/bokeh/source/conf.py:134:23: PLR6101 Consider using dataclass or namedtuple instead of dict
+ examples/basic/axes/bounds.py:49:10: PLR6101 Consider using dataclass or namedtuple instead of dict
+ examples/plotting/multi_scale.py:13:10: PLR6101 Consider using dataclass or namedtuple instead of dict
+ examples/plotting/theme_glyphs.py:17:14: PLR6101 Consider using dataclass or namedtuple instead of dict
+ examples/server/app/dash/main.py:122:40: PLR6101 Consider using dataclass or namedtuple instead of dict
+ examples/server/app/weather/main.py:70:10: PLR6101 Consider using dataclass or namedtuple instead of dict
... 6 additional changes omitted for rule PLR6101
- release/config.py:27:7: PLR0902 Too many instance attributes (8/7)
- src/bokeh/application/handlers/code_runner.py:53:7: PLR0902 Too many instance attributes (11/7)
- src/bokeh/client/connection.py:76:7: PLR0902 Too many instance attributes (11/7)
- src/bokeh/document/callbacks.py:86:7: PLR0902 Too many instance attributes (10/7)
... 15 additional changes omitted for project

freedomofpress/securedrop (+1 -10 violations, +0 -0 fixes) 

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

- journalist_gui/journalist_gui/SecureDropUpdater.py:169:7: PLR0902 Too many instance attributes (8/7)
- journalist_gui/journalist_gui/updaterUI.py:10:7: PLR0902 Too many instance attributes (16/7)
+ securedrop/debian/ossec-common/var/ossec/checksdconfig.py:7:31: PLR6101 Consider using dataclass or namedtuple instead of dict
- securedrop/journalist_app/sessions.py:18:7: PLR0902 Too many instance attributes (11/7)
- securedrop/journalist_app/sessions.py:83:7: PLR0902 Too many instance attributes (11/7)
- securedrop/pretty_bad_protocol/_meta.py:110:7: PLR0902 Too many instance attributes (14/7)
- securedrop/pretty_bad_protocol/_parsers.py:1172:7: PLR0902 Too many instance attributes (8/7)
... 5 additional changes omitted for rule PLR0902
... 4 additional changes omitted for project

fronzbot/blinkpy (+0 -5 violations, +0 -0 fixes) 

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

- blinkpy/auth.py:22:7: PLR0902 Too many instance attributes (12/7)
- blinkpy/blinkpy.py:41:7: PLR0902 Too many instance attributes (17/7)
- blinkpy/camera.py:19:7: PLR0902 Too many instance attributes (23/7)
- blinkpy/sync_module.py:23:7: PLR0902 Too many instance attributes (21/7)
- tests/mock_responses.py:5:7: PLR0902 Too many instance attributes (8/7)

ibis-project/ibis (+2 -3 violations, +0 -0 fixes) 

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

+ ci/check_disallowed_imports.py:37:22: PLR6101 Consider using dataclass or namedtuple instead of dict
- ibis/backends/bigquery/udf/core.py:105:7: PLR0902 Too many instance attributes (8/7)
- ibis/backends/flink/ddl.py:77:7: PLR0902 Too many instance attributes (10/7)
- ibis/backends/impala/ddl.py:73:7: PLR0902 Too many instance attributes (8/7)
+ ibis/backends/snowflake/__init__.py:49:23: PLR6101 Consider using dataclass or namedtuple instead of dict

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

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

- pymilvus/bulk_writer/bulk_writer.py:36:7: PLR0902 Too many instance attributes (8/7)
- pymilvus/bulk_writer/remote_bulk_writer.py:38:11: PLR0902 Too many instance attributes (9/7)
- pymilvus/client/abstract.py:14:7: PLR0902 Too many instance attributes (12/7)
- pymilvus/client/abstract.py:186:7: PLR0902 Too many instance attributes (8/7)
- pymilvus/client/abstract.py:99:7: PLR0902 Too many instance attributes (14/7)
- pymilvus/client/asynch.py:56:7: PLR0902 Too many instance attributes (11/7)
- pymilvus/client/grpc_handler.py:68:7: PLR0902 Too many instance attributes (17/7)
- pymilvus/orm/iterator.py:275:7: PLR0902 Too many instance attributes (12/7)
- pymilvus/orm/iterator.py:58:7: PLR0902 Too many instance attributes (11/7)
- pymilvus/orm/schema.py:250:7: PLR0902 Too many instance attributes (10/7)

pandas-dev/pandas (+6 -50 violations, +0 -0 fixes) 

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

- asv_bench/benchmarks/categoricals.py:18:7: PLR0902 Too many instance attributes (12/7)
- asv_bench/benchmarks/io/hdf.py:14:7: PLR0902 Too many instance attributes (12/7)
- asv_bench/benchmarks/join_merge.py:367:7: PLR0902 Too many instance attributes (8/7)
- asv_bench/benchmarks/join_merge.py:427:7: PLR0902 Too many instance attributes (12/7)
- asv_bench/benchmarks/reindex.py:13:7: PLR0902 Too many instance attributes (8/7)
+ doc/source/conf.py:468:12: PLR6101 Consider using dataclass or namedtuple instead of dict
+ pandas/compat/pickle_compat.py:31:24: PLR6101 Consider using dataclass or namedtuple instead of dict
- pandas/core/apply.py:115:7: PLR0902 Too many instance attributes (9/7)
... 45 additional changes omitted for rule PLR0902
+ pandas/core/interchange/column.py:43:21: PLR6101 Consider using dataclass or namedtuple instead of dict
+ pandas/core/ops/docstrings.py:304:54: PLR6101 Consider using dataclass or namedtuple instead of dict
... 46 additional changes omitted for project

... Truncated remaining completed project reports due to GitHub comment length restrictions

Changes by rule (2 rules affected)

code total + violation - violation + fix - fix
PLR0902 802 0 802 0 0
PLR6101 210 210 0 0 0

Formatter (stable)

ℹ️ ecosystem check encountered format errors. (no format changes; 1 project error)

openai/openai-cookbook (error) 

warning: Detected debug build without --no-cache.
error: Failed to read examples/How_to_handle_rate_limits.ipynb: Expected a Jupyter Notebook, which must be internally stored as JSON, but this file isn't valid JSON: trailing comma at line 47 column 4

Formatter (preview)

ℹ️ ecosystem check encountered format errors. (no format changes; 1 project error)

openai/openai-cookbook (error) 

ruff format --preview

warning: Detected debug build without --no-cache.
error: Failed to read examples/How_to_handle_rate_limits.ipynb: Expected a Jupyter Notebook, which must be internally stored as JSON, but this file isn't valid JSON: trailing comma at line 47 column 4

@tibor-reiss tibor-reiss force-pushed the add-R6101 branch 2 times, most recently from d4b075f to 9b8d52b Compare February 27, 2024 19:45
@MichaReiser MichaReiser added the rule Implementing or modifying a lint rule label Mar 28, 2024
@MichaReiser
Copy link
Member

MichaReiser commented Mar 28, 2024

Thank you @tibor-reiss for the interest in Ruff and opening this PR

We're currently revising our rule acceptance criteria as part of the work we do around #1774 and I'm sorry to inform you that we can't accept this rule for now (we can reconsider once #1744). The reasons is that this is a pylint extension rule. We don't want to accept any pylint extension rules because users using the pylint selector would implicitly opt into the rule which is different from when they use pylint directly. We also don't want to have a group for each pylint extension rule which is closest to Pylint's behavior.

I'm sorry to only inform you of this now after you implemented the rule. I updated #970 and marked the rule as not suitable for Ruff. I plan to go over all rules mentioned in the issue to mark all pylitn extension rules as not ready to implement to avoid this situation in the future.

Thak you again for working on the Rule and sorry that I can't give you a more positive feedback

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

rule Implementing or modifying a lint rule

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@tibor-reiss @MichaReiser